Interface Customization: Difference between revisions

From FreeCAD Documentation
(Moved TOCright to top. Moved in 'Progress'.)
(Revising. Work in progress.)
Line 17: Line 17:


<!--T:1-->
<!--T:1-->
Since FreeCAD interface is based on the modern [http://en.wikipedia.org/wiki/Qt_(toolkit) Qt] toolkit, it has a state-of-the-art organization. Widgets, menus, toolbars and other tools can be modified, moved, shared between workbenches, keyboard shortcuts can be set, modified, and macros can be recorded and played.
The FreeCAD interface is based on the modern [http://en.wikipedia.org/wiki/Qt_(toolkit) Qt] toolkit and has a state-of-the-art organization. Some aspects of the interface can be customized. You can, for example, add custom toolbars, with tools from several workbenches or tools defined in macros, and you can create you own keyboard shortcuts. But the menus and default toolbars that come with FreeCAD and its workbenches cannot be changed.


</translate>
[[Image:Std_DlgCustomize_tab_Toolbars.png]]
<translate>
<!--T:2-->
<!--T:2-->
{{Caption|The Customize dialog box}}
[[Image:Screenshot-customize.jpg]]


{{Caption|The Interface Customization dialog}}
==Usage== <!--T:23-->
==Usage== <!--T:23-->


<!--T:24-->
<!--T:24-->
# The tools available in the Customize dialog box depend on the workbenches that have been loaded in the current FreeCAD session. So you should load all workbenches whose tools you want to have access to.
The customization window is accessed from the {{MenuCommand|{{StdMenu|[[Std Tools Menu|Tools]]}} → Customize}} menu.
# If you want to add a custom toolbar: switch back to the workbench you want to add the toolbar to.
# There are several ways to invoke the command:
#* Select the {{MenuCommand|Tools → [[Image:Std_DlgCustomize.svg|16px]] Customize...}} option from the menu.
#* Right-click a toolbar area and choose {{MenuCommand|[[Image:Std_DlgCustomize.svg|16px]] Customize...}} from the context menu.
# The Customize dialog box opens. For more information see [[#Options|Options]].
# Press the {{Button|Close}} button to close the dialog box.
# The {{Button|Help}} button does not work at this time.


==Customization tabs== <!--T:3-->
The '''Commands''' tab lets you browse all available FreeCAD commands, organized by their category.


<!--Extra empty line above to improve layout-->
<!--T:4-->
==Options==
In '''Keyboard''', you can see the keyboard shortcuts associated with every FreeCAD command, and if you want, modify or assign new shortcut to any command. This is where to come if you use a particular workbench often, and would like to speed up its use by using the keyboard.


In the Customize dialog box the following tabs are available:
<!--T:5-->
The '''Toolbars''' and '''Toolbox bars''' tabs let you modify existing toolbars, or create your own custom toolbars.


<!--T:16-->
Under the tab '''Worksbenches''' ('''Workbenches''') the workbenches existing in FreeCAD are listed, on the left the currently passive, on the right the currently active workspaces. The status can be changed with the horizontal arrows.


<!--Extra empty line above to improve layout-->
<!--T:17-->
===Commands===
[[Image:UserdefSymbstrip.jpg]]


</translate>
<!--T:18-->
[[Image:Std_DlgCustomize_tab_Commands.png]]
Under the tab '''Toolbars''' ('''Toolbars''') on the left are the same command categories as under the map '''Commands'''. After clicking on a category the corresponding commands appear, which can be copied to the right side. Before you do this, select an active workspace to which you want to add an individual toolbar. First select a name for this toolbar with '''New''' ('''New...''') before copying commands over to it. When this workspace is called later, this bar must be activated: '''View → Toolbars'''.
<translate>
{{Caption|The Commands tab}}


On this tab you can browse the available commands.
<!--T:19-->
Remark: If "Global" (instead of a workspace) is selected on the right, the added toolbar can be activated in each workspace.


====Browse commands====


# Select a command category in the '''Category''' panel on the left. Some categories match menu entries.
<!--T:6-->
# The tools available in the selected category are shown in the right panel.
The '''Macros''' tab lets you manage your saved [[Macros|Macros]].
# Hover over a command: its tooltip appears.
# Select a command: its status bar text is displayed below the two panels.


<!--T:9-->
Create your Toolbars for your macro [[Customize_Toolbars|Customize Toolbars]]


<!--Extra empty line above to improve layout-->
<!--T:10-->
===Keyboard===
Since FreeCAD 0.16 a new tool is available that lets you manage your workbenches.


</translate>
<!--T:11-->
[[Image:CustomizeWorkbenches.png]]
[[Image:Std_DlgCustomize_tab_Keyboard.png]]
<translate>
{{Caption|The Keyboard tab}}


On this tab custom keyboard shortcuts can be defined. Shortcuts for custom macros should be defined on the [[#Macros|Macros]] tab.
==Example== <!--T:12-->
For an example workflow lets suppose we want to have the "Measure Linear" tool also show up in a custom toolbar in the [[Draft Workbench|Draft Workbench]].
* in FreeCAD choose {{MenuCommand|Tools → Customize}} from the top menu
* select the "Toolbars" tab
* on the left side choose "Part" in the pull down menu
* on the left side in the lower window scroll down to the "Measure Linear" entry and select it
* on the right side choose "Draft" in the pull down menu
* click on {{button|New...}} to create a new toolbar and choose a name for it
* now select your destination toolbar in the right lower window (only needed if you have more than one toolbar)
* by clicking on the blue "Arrow right" (top icon in the middle row) you will add your selected entry to the selected toolbar


====Add a custom shortcut====
===Remarks=== <!--T:13-->
When selecting "Global" in the pull down menu on the right side you will create a toolbar which will be visible in all workbenches.


# Select a command category from the '''Category''' dropdown list.
<!--T:14-->
# Select a command from the '''Commands''' panel.
For adding an installed macro to a toolbar you must
# The '''Current shortcut''' box displays the current short cut, if available.
* select "Macros" in the pull down menu on the left side
# Enter a new shortcut in the '''Press new shortcut''' input box. Shortcuts can be up to 4 inputs long. Each input is either a single character, a combination of one or more special keys or a combination of one or more special keys and a character. Use {{KEY|Backspace}} to correct mistakes.
* have assigned menu text, icon (Pixmap) and so on using the {{MenuCommand|Tools → Customize → Macros}} menu
# If the shortcut is already in use a dialog box will ask you to confirm you want to override it, and the command the shortcut is assigned to will appear in the '''Currently assigned to''' panel.
# Press the {{Button|Assign}} button to assign the new shortcut.
# Press the {{Button|Clear}} button to remove the entered shortcut. This will also remove the content of the '''Current shortcut''' box. Note that default shortcuts are not permanently removed. They will be restored upon restarting FreeCAD.

====Remove a custom shortcut====

# Select a command category from the '''Category''' dropdown list.
# Select a command from the '''Commands''' panel.
# Press the {{Button|Reset}} button.

====Remove all custom shortcuts====

# Press the {{Button|Reset All}} button.

====Limitations====

* Shortcuts only work if their commands appear in the standard menu or in the menu of a workbench that has been loaded in the current FreeCAD session, or if their commands are on a ''visible'' toolbar.
* In V0.19 there is an issue with some Draft commands. Their default shortcuts do not work and/or custom shortcuts cannot be assigned to them.


<!--Extra empty line above to improve layout-->
===Workbenches===

</translate>
[[Image:Std_DlgCustomize_tab_Workbenches.png]]
<translate>
{{Caption|The Workbenches tab}}

On this tab the list used by the [[Std_Workbench|Workbench selector]] can be changed. The '''Enabled workbenches''' list shows the workbenches as they will appear in the Workbench selector.

====Disable a workbench====

# Select the workbench in the '''Enabled workbenches''' list.
# Press the {{Button|[[Image:Button_left.svg|16px]]}} button.
# The workbench will be moved to the '''Disabled workbenches''' list

====Re-enable a workbench====

# Select the workbench in the '''Disabled workbenches''' list.
# Press the {{Button|[[Image:Button_right.svg|16px]]}} button.
# The workbench will be moved to the '''Enabled workbenches''' list

====Re-enable all workbenches====

# Press the {{Button|[[Image:Button_add_all.svg|16px]]}} button.

====Change workbench position====

# Select the workbench in the '''Enabled workbenches''' list.
# Press the {{Button|[[Image:Button_up.svg|16px]]}} button or the {{Button|[[Image:Button_down.svg|16px]]}} button.
# Optionally repeat this until the workbench is in the correct position.

====Sort workbenches alphabetically====

# Press the {{Button|[[Image:Button_sort.svg|16px]]}} button.


Todo.
Todo.


== Addons == <!--T:25-->
== Addons == <!--T:25-->

Revision as of 15:09, 30 April 2020

Other languages:
This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.

Introduction

The FreeCAD interface is based on the modern Qt toolkit and has a state-of-the-art organization. Some aspects of the interface can be customized. You can, for example, add custom toolbars, with tools from several workbenches or tools defined in macros, and you can create you own keyboard shortcuts. But the menus and default toolbars that come with FreeCAD and its workbenches cannot be changed.

The Customize dialog box

Usage

  1. The tools available in the Customize dialog box depend on the workbenches that have been loaded in the current FreeCAD session. So you should load all workbenches whose tools you want to have access to.
  2. If you want to add a custom toolbar: switch back to the workbench you want to add the toolbar to.
  3. There are several ways to invoke the command:
    • Select the Tools → Customize... option from the menu.
    • Right-click a toolbar area and choose Customize... from the context menu.
  4. The Customize dialog box opens. For more information see Options.
  5. Press the Close button to close the dialog box.
  6. The Help button does not work at this time.


Options

In the Customize dialog box the following tabs are available:


Commands

File:Std DlgCustomize tab Commands.png

The Commands tab

On this tab you can browse the available commands.

Browse commands

  1. Select a command category in the Category panel on the left. Some categories match menu entries.
  2. The tools available in the selected category are shown in the right panel.
  3. Hover over a command: its tooltip appears.
  4. Select a command: its status bar text is displayed below the two panels.


Keyboard

The Keyboard tab

On this tab custom keyboard shortcuts can be defined. Shortcuts for custom macros should be defined on the Macros tab.

Add a custom shortcut

  1. Select a command category from the Category dropdown list.
  2. Select a command from the Commands panel.
  3. The Current shortcut box displays the current short cut, if available.
  4. Enter a new shortcut in the Press new shortcut input box. Shortcuts can be up to 4 inputs long. Each input is either a single character, a combination of one or more special keys or a combination of one or more special keys and a character. Use Backspace to correct mistakes.
  5. If the shortcut is already in use a dialog box will ask you to confirm you want to override it, and the command the shortcut is assigned to will appear in the Currently assigned to panel.
  6. Press the Assign button to assign the new shortcut.
  7. Press the Clear button to remove the entered shortcut. This will also remove the content of the Current shortcut box. Note that default shortcuts are not permanently removed. They will be restored upon restarting FreeCAD.

Remove a custom shortcut

  1. Select a command category from the Category dropdown list.
  2. Select a command from the Commands panel.
  3. Press the Reset button.

Remove all custom shortcuts

  1. Press the Reset All button.

Limitations

  • Shortcuts only work if their commands appear in the standard menu or in the menu of a workbench that has been loaded in the current FreeCAD session, or if their commands are on a visible toolbar.
  • In V0.19 there is an issue with some Draft commands. Their default shortcuts do not work and/or custom shortcuts cannot be assigned to them.


Workbenches

File:Std DlgCustomize tab Workbenches.png

The Workbenches tab

On this tab the list used by the Workbench selector can be changed. The Enabled workbenches list shows the workbenches as they will appear in the Workbench selector.

Disable a workbench

  1. Select the workbench in the Enabled workbenches list.
  2. Press the button.
  3. The workbench will be moved to the Disabled workbenches list

Re-enable a workbench

  1. Select the workbench in the Disabled workbenches list.
  2. Press the button.
  3. The workbench will be moved to the Enabled workbenches list

Re-enable all workbenches

  1. Press the button.

Change workbench position

  1. Select the workbench in the Enabled workbenches list.
  2. Press the button or the button.
  3. Optionally repeat this until the workbench is in the correct position.

Sort workbenches alphabetically

  1. Press the button.


Todo. Todo.

Addons

There are other ways to customize the FreeCAD interface using its robust modular Addon repository through the Addon Manager. There are several Addons that allow for improved UI/UX. Below are some options created by users in the FreeCAD community.

Glass

https://www.youtube.com/watch?v=ny31diN1ZhM

  • Github repository: (link)
  • Forum discussion: (thread)

PieMenu

  • Github repository:

Launcher

ShortCut

RemBench

IconThemes

CubeMenu

Std Base
Interface
User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=Interface_Customization&oldid=672602"