Interface Customization: Difference between revisions

From FreeCAD Documentation
No edit summary
(Marked this version for translation)
(44 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/>
<languages/>

{{Page in progress}}

<translate>
<translate>
<!--T:15-->
<!--T:15-->
{{Docnav
{{Docnav
|[[Import Export Preference|Import Export Preference]]
|[[Import_Export_Preferences|Import Export Preferences]]
|[[Property editor|Property editor]]
|[[Property_editor|Property editor]]
}}
}}


Line 28: Line 25:


<!--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 commands available in the Customize dialog box depend on the workbenches that have been loaded in the current FreeCAD session. So you should first load all workbenches whose commands you want to have access to.
# There are several ways to invoke the [[Image:Std_DlgCustomize.svg|16px]] [[Std_DlgCustomize|Std DlgCustomize]] command:
# 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.
#* 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.
#* 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]].
# 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.
# The {{Button|Help}} button does not work at this time.
# Press the {{Button|Close}} button to close the dialog box.


==Options== <!--T:40-->


<!--T:41-->
<!--Extra empty line above to improve layout-->

==Options==

In the Customize dialog box the following tabs are available:
In the Customize dialog box the following tabs are available:


===Commands=== <!--T:42-->

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


</translate>
</translate>
[[Image:Std_DlgCustomize_tab_Commands.png]]
[[Image:Std_DlgCustomize_tab_Commands.png]]
<translate>
<translate>
<!--T:43-->
{{Caption|The Commands tab}}
{{Caption|The Commands tab}}


<!--T:44-->
On this tab you can browse the available commands.
On this tab you can browse the available commands.


====Browse commands====
====Browse commands==== <!--T:45-->


<!--T:46-->
# Select a command category in the '''Category''' panel on the left. Some categories match menu entries.
# Select a command category in the '''Category''' panel on the left. Some categories match menu entries.
# The tools available in the selected category are shown in the panel on the right.
# The tools available in the selected category are shown in the panel on the right.
Line 62: Line 57:
# Select a command: its status bar text is displayed below the two panels.
# Select a command: its status bar text is displayed below the two panels.


<!--T:47-->
[[#top|top]]


===Keyboard=== <!--T:48-->
<!--Extra empty line above to improve layout-->

===Keyboard===


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


<!--T:50-->
On this tab custom keyboard shortcuts can be defined. Shortcuts for macro commands should be defined on the [[#Macros|Macros]] tab.
On this tab custom keyboard shortcuts can be defined. Shortcuts for macro commands can be defined on the [[#Macros|Macros]] tab.


====Add a custom shortcut====
====Add a custom shortcut==== <!--T:51-->


<!--T:52-->
# Select a command category from the '''Category''' dropdown list.
# Select a command category from the '''Category''' dropdown list.
# Select a command from the '''Commands''' panel.
# Select a command from the '''Commands''' panel.
# The '''Current shortcut''' box displays the current short cut, if available.
# The '''Current shortcut''' box displays the current short cut, if available.
# 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.
# 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.
# If the shortcut is already in use a dialog box will ask to confirm you want to override it, and the command the shortcut is assigned to will appear in the '''Currently assigned to''' panel.
# If the shortcut is already in use, a dialog box will ask you if 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|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.
# 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====
====Remove a custom shortcut==== <!--T:53-->


<!--T:54-->
# Select a command category from the '''Category''' dropdown list.
# Select a command category from the '''Category''' dropdown list.
# Select a command from the '''Commands''' panel.
# Select a command from the '''Commands''' panel.
# Press the {{Button|Reset}} button.
# Press the {{Button|Reset}} button.


====Remove all custom shortcuts====
====Remove all custom shortcuts==== <!--T:55-->


<!--T:56-->
# Press the {{Button|Reset All}} button.
# Press the {{Button|Reset All}} button.


====Notes====
====Notes (Keyboard)==== <!--T:57-->


<!--T:58-->
* 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.
* 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 appear on a ''visible'' toolbar.
<!--Description of problem below: https://forum.freecadweb.org/viewtopic.php?f=23&t=45826-->
* 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.
* 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.


<!--T:59-->
[[#top|top]]


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


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


<!--T:62-->
On this tab the [[Std_Workbench|Workbench selector]] list can be changed. The '''Enabled workbenches''' list shows the workbenches as they will appear in the Workbench selector.
On this tab the [[Std_Workbench|Workbench selector]] list can be changed. The '''Enabled workbenches''' list shows the workbenches as they will appear in the Workbench selector.


====Disable a workbench====
====Disable a workbench==== <!--T:63-->


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


====Re-enable a workbench====
====Re-enable a workbench==== <!--T:65-->


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


====Re-enable all workbenches====
====Re-enable all workbenches==== <!--T:67-->


<!--T:68-->
# Press the {{Button|[[Image:Button_add_all.svg|16px]]}} button.
# Press the {{Button|[[Image:Button_add_all.svg|16px]]}} button.


====Change workbench position====
====Change a workbench position==== <!--T:69-->


<!--T:70-->
# Select the workbench in the '''Enabled workbenches''' list.
# Select a workbench in the '''Enabled workbenches''' list.
# Press the {{Button|[[Image:Button_up.svg|16px]]}} button or the {{Button|[[Image:Button_down.svg|16px]]}} button.
# 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.
# Optionally repeat this until the workbench is in the correct position.


====Sort workbenches alphabetically====
====Sort workbenches alphabetically==== <!--T:71-->


<!--T:72-->
# Press the {{Button|[[Image:Button_sort.svg|16px]]}} button.
# Press the {{Button|[[Image:Button_sort.svg|16px]]}} button.


<!--T:73-->
[[#top|top]]


===Toolbars=== <!--T:74-->
<!--Extra empty line above to improve layout-->
===Toolbars===


</translate>
</translate>
[[Image:Std_DlgCustomize_tab_Toolbars.png]]
[[Image:Std_DlgCustomize_tab_Toolbars.png]]
<translate>
<translate>
<!--T:75-->
{{Caption|The Toolbars tab}}
{{Caption|The Toolbars tab}}


<!--T:76-->
On this tab custom toolbars can be created and modified.
On this tab custom toolbars can be created and modified.


====Select the workbench==== <!--T:77-->
As already mentioned: it is recommended to activate the correct workbench before starting the [[Std_DlgCustomize|Std DlgCustomize]] command.


<!--T:78-->
<!--Description of problem: https://forum.freecadweb.org/viewtopic.php?f=3&t=45851-->
In the dropdown list on the right by default the current workbench is selected. To avoid certain problems only change it if you want to work on a toolbar that should be available in all workbenches, in which case the 'Global' option should be selected.
# In the dropdown list on the right select the workbench whose custom toolbars you want to modify. The {{Value|Global}} option is there for custom toolbars that should be available in all workbenches.


====Create a toolbar====
====Create a toolbar==== <!--T:79-->


<!--T:80-->
# Press the {{Button|New...}} button.
# Press the {{Button|New...}} button.
# Enter a name in the dialog box that opens.
# Enter a name in the dialog box that opens.
# Press the {{Button|OK}} button.
# Press the {{Button|OK}} button.
# The new toolbar will appear in the panel on the right.
# The new toolbar will appear in the panel on the right.
# You cannot add two custom toolbars with the same name to a workbench, but be aware that FreeCAD does not check for name conflicts between the 'Global' toolbars and the custom toolbars belonging to workbenches.


====Rename a toolbar====
====Rename a toolbar==== <!--T:81-->


<!--T:82-->
# Select the toolbar in the panel on the right.
# Select a toolbar in the panel on the right.
# Press the {{Button|Rename...}} button.
# Press the {{Button|Rename...}} button.
# Enter a new name in the dialog box that opens.
# Enter a new name in the dialog box that opens.
# Press the {{Button|OK}} button.
# Press the {{Button|OK}} button.


====Delete a toolbar====
====Delete a toolbar==== <!--T:83-->


<!--T:84-->
# Select the toolbar in the panel on the right.
# Select a toolbar in the panel on the right.
# Press the {{Button|Delete}} button.
# Press the {{Button|Delete}} button.


====Disable a toolbar====
====Disable a toolbar==== <!--T:85-->


<!--T:86-->
# Uncheck the checkbox in front of the toolbar name in the panel on the right.
# Uncheck the checkbox in front of the toolbar name in the panel on the right.
# A disabled toolbar will be invisible in the FreeCAD interface.
# A disabled toolbar will be invisible in the FreeCAD interface.


====Add a command====
====Add a command==== <!--T:87-->


<!--T:88-->
# Select the correct toolbar in the panel on the right. If no toolbar is selected, the command will be added to the first toolbar in the list.
# Select the correct toolbar in the panel on the right. If no toolbar is selected, the command will be added to the first toolbar in the list.
# Select a category from the dropdown list on the left. Macro commands that have been set up on the [[#Macros|Macros]] tab appear in the 'Macros' category.
# Select a category from the dropdown list on the left. Macro commands that have been set up on the [[#Macros|Macros]] tab appear in the 'Macros' category.
Line 185: Line 202:
# Press {{Button|[[Image:Button_right.svg|16px]]}} button.
# Press {{Button|[[Image:Button_right.svg|16px]]}} button.


====Remove a command====
====Remove a command==== <!--T:89-->


<!--T:90-->
# If required, expand the toolbar in the panel on the right.
# If required, expand the toolbar in the panel on the right.
# Select the command.
# Select a command.
# Press {{Button|[[Image:Button_left.svg|16px]]}} button.
# Press {{Button|[[Image:Button_left.svg|16px]]}} button.


====Change command position====
====Change a command position==== <!--T:91-->


<!--T:92-->
# If required, expand the toolbar in the panel on the right.
# If required, expand the toolbar in the panel on the right.
# Select the command.
# Select a command.
# Press the {{Button|[[Image:Button_up.svg|16px]]}} button or the {{Button|[[Image:Button_down.svg|16px]]}} button.
# Press the {{Button|[[Image:Button_up.svg|16px]]}} button or the {{Button|[[Image:Button_down.svg|16px]]}} button.
# Optionally repeat this until the command is in the correct position.
# Optionally repeat this until the command is in the correct position.


====Notes====
====Notes (Toolbars)==== <!--T:93-->


<!--T:94-->
* Toolbars belonging to the current workbench are updated immediately, but after disabling/re-enabling a toolbar a workbench change is required (switch to a different workbench and then switch back).
* Toolbars belonging to the current workbench are updated immediately, but after disabling/re-enabling a toolbar a workbench change is required (switch to a different workbench and then switch back).
* To update 'Global' toolbars a workbench change (if commands have been added or removed) or a restart (if the order of a toolbar has changed or a toolbar was renamed) is required.
* To update global toolbars a workbench change (if commands have been added or removed) or a restart (if the order of a toolbar has changed or a toolbar was renamed) is required.
<!--Description of problem below: https://forum.freecadweb.org/viewtopic.php?f=23&t=45757-->
* Bug for Draft commands.... "DraftTools". ToDo!
* In V0.19 there is an issue with some Draft commands. After adding them to a custom toolbar and exiting the FreeCAD application the {{FileName|user.cfg}} file must be manually edited for these commands. Search for the name of the custom toolbar and in that section change the content of the {{incode|FCText}} items that start with {{incode|gui_}} to {{incode|DraftTools}}.


<!--T:95-->
[[#top|top]]


===Macros=== <!--T:96-->
<!--Extra empty line above to improve layout-->
===Macros===


</translate>
</translate>
[[Image:Std_DlgCustomize_tab_Macros.png]]
[[Image:Std_DlgCustomize_tab_Macros.png]]
<translate>
<translate>
<!--T:97-->
{{Caption|The Macros tab}}
{{Caption|The Macros tab}}


<!--T:98-->
On this tab user macro commands can be set up. Once set up, they can be added to custom toolbars. FreeCAD uses a dedicated folder for user macros and only macros in that folder can be set up. Use the [[Std DlgMacroExecute|Std_DlgMacroExecute]] command to find this folder on your system.
On this tab user macro commands can be set up. Once set up, they can be added to custom toolbars. FreeCAD uses a dedicated folder for user macros and only macros in that folder can be set up. Use the [[Image:Std_DlgMacroExecute.svg|16px]] [[Std_DlgMacroExecute|Std DlgMacroExecute]] command to find this folder on your system.


<!--T:99-->
If you download a macro with the [[Std_AddonMgr|Std AddonMgr]] command then make sure that you also download its icon image file. Most macros have an image link on the information page that appears in the Addon Manager. You can for example put this image file in the users macros folder.
If you download a macro with the [[Image:Std_AddonMgr.svg|16px]] [[Std_AddonMgr|Addon Manager]] then make sure that you also download its icon image file. Most macros have an image link on the information page that appears in the Addon Manager. You can for example put this image file in the user macros folder.


<!--T:115-->
====Add a macro command====
If you want to use a macro downloaded from a different source you will have to install it manually. See [[How_to_install_macros|How to install macros]] for more information.


====Add a macro command==== <!--T:100-->

<!--T:101-->
# In the '''Macro''' dropdown list select a macro.
# In the '''Macro''' dropdown list select a macro.
# Enter a '''Menu text'''. This will be the name used to identify the macro command and will also appear in the toolbar if there is no icon.
# Enter a '''Menu text'''. This will be the name used to identify the macro command and will also appear in the toolbar if there is no icon.
# Optionally enter a '''Tool tip'''. This text will appear near the location of the mouse when you hover the toolbar icon.
# Optionally enter a '''Tool tip'''. This text will appear near the location of the mouse when you hover the toolbar icon.
# Optionally enter a '''Status text'''. This text will appear in the [[Status_bar|status bar]] when you hover the toolbar icon.
# Optionally enter a '''Status text'''. This text will appear in the [[Status_bar|status bar]] when you hover the toolbar icon.
# Optionally enter the wiki page for the macro, if available, in the '''What's this''' input box. Just enter the page name, not the full URL.
# Optionally enter the wiki page for the macro, if available, in the '''What's this''' input box. Enter the page name, not the full URL.
# Optionally enter a shortcut in the '''Accelerator''' input box. See [[#Keyboard|Keyboard]] for more information.
# Optionally enter a shortcut in the '''Accelerator''' input box. See [[#Keyboard|Keyboard]] for more information.
# To add an icon:
# To add an icon:
## Press the '''Pixmap''' {{Button|...}} button.
## Press the '''Pixmap''' {{Button|...}} button.
## The Choose Icon dialog box opens.
## The Choose Icon dialog box opens.
## If required Press the {{Button|Icon folders...}} button to add an icon folder.
## If required press the {{Button|Icon folders...}} button to add an icon folder.
## Select an icon from the panel. The Choose Icon dialog box closes automatically.
## Select an icon from the panel. The Choose Icon dialog box closes automatically.
# Press the {{Button|Add}} button.
# Press the {{Button|Add}} button.
# The macro command appears in the panel on the left.
# The macro command appears in the panel on the left.
# The macro command can now selected on the [[#Toolbars|Toolbars]] tab.
# The macro command can now be selected on the [[#Toolbars|Toolbars]] tab.


====Remove a macro command====
====Remove a macro command==== <!--T:102-->


<!--T:103-->
# Select the macro command in the panel on the left.
# Select the macro command in the panel on the left.
# Press the {{Button|Remove}} button.
# Press the {{Button|Remove}} button.


====Change a macro command====
====Change a macro command==== <!--T:104-->


<!--T:105-->
# Double-click the macro command in the panel on the left.
# Double-click the macro command in the panel on the left.
# Make the required changes. Note that you cannot remove the icon, you can only replace it.
# Make the required changes. Note that you cannot remove the icon, you can only replace it.
# Press the {{Button|Replace}} button.
# Press the {{Button|Replace}} button.


<!--T:106-->
[[#top|top]]


===Spaceball Motion=== <!--T:107-->
<!--Extra empty line above to improve layout-->
===Spaceball Motion===


<!--T:108-->
See: [[3Dconnexion_input_devices|3Dconnexion input devices]].
This is tab is blank if no Spaceball is detected. See: [[3Dconnexion_input_devices|3Dconnexion input devices]].


<!--T:109-->
[[#top|top]]


===Spaceball Buttons=== <!--T:110-->
<!--Extra empty line above to improve layout-->
===Spaceball Buttons===


<!--T:111-->
See: [[3Dconnexion_input_devices|3Dconnexion input devices]].
This is tab is blank if no Spaceball is detected. See: [[3Dconnexion_input_devices|3Dconnexion input devices]].


<!--T:112-->
[[#top|top]]


==Themes== <!--T:116-->
<!--Extra empty line above to improve layout-->

== Addons == <!--T:25-->
<!--T:117-->
FreeCAD supports complete theming of the interface, via .qss stylesheets. The [https://doc.qt.io/qt-5/stylesheet-syntax.html qss format] is very similar to the [https://en.wikipedia.org/wiki/CSS css format] used in web pages, it basically adds more methods to reference the different widgets and elements of the Qt interface. You can change the current default theme (which simply takes the style defined by your desktop system) to one of the built-in themes bundled with FreeCAD, or create your own, for example starting from one of the [https://github.com/FreeCAD/FreeCAD/tree/master/src/Gui/Stylesheets built-in styles] and editing it. Your new style must be placed in a folder named $USERAPPDATA/Gui/Stylesheets to be known to FreeCAD ($USERAPPDATA is obtained by typing App.getUserAppDataDir() in the FreeCAD console).

<!--T:118-->
[[#top|top]]

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


<!--T:26-->
<!--T:26-->
There are other ways to customize the FreeCAD interface using its robust modular Addon repository through the [[Image:AddonManager.svg|24px]] [[Addon Manager]]. There are several Addons that allow for improved UI/UX. Below are some options created by users in the FreeCAD community.
Addons offer yet another way to customize the use interface. Below are some addons created by users in the FreeCAD community. They can be downloaded through the [[Image:Std_AddonMgr.svg|16px]] [[Std_AddonMgr|Addon Manager]] (note: they are listed on the Workbenches tab).

===CubeMenu=== <!--T:38-->

<!--T:39-->
* Github repository: https://github.com/triplus/CubeMenu


=== Glass === <!--T:27-->
===Glass=== <!--T:27-->


<!--T:28-->
<!--T:28-->
https://www.youtube.com/watch?v=ny31diN1ZhM
* Github repository: https://github.com/triplus/Glass.


===IconThemes=== <!--T:36-->
* Github repository: ([https://github.com/triplus/Glass link])
* Forum discussion: ([https://forum.freecadweb.org/viewtopic.php?t=32397 thread])
=== PieMenu === <!--T:29-->


<!--T:37-->
* Github repository:
* Github repository: https://github.com/triplus/IconThemes

=== Launcher === <!--T:30-->
===Launcher=== <!--T:30-->


<!--T:31-->
<!--T:31-->
* Github repository: https://github.com/triplus/Launcher
* Github repository: https://github.com/triplus/Launcher


=== ShortCut === <!--T:32-->
===PieMenu=== <!--T:29-->


<!--T:33-->
<!--T:113-->
* Github repository: https://github.com/triplus/ShortCuts
* Github repository: https://github.com/triplus/PieMenu


=== RemBench === <!--T:34-->
===RemBench=== <!--T:34-->


<!--T:35-->
<!--T:35-->
* Github repository: https://github.com/triplus/RemBench
* Github repository: https://github.com/triplus/RemBench


=== IconThemes === <!--T:36-->
===ShortCut=== <!--T:32-->


<!--T:37-->
<!--T:33-->
* Github repository: https://github.com/triplus/IconThemes
* Github repository: https://github.com/triplus/ShortCuts


=== CubeMenu === <!--T:38-->
<!--T:114-->
[[#top|top]]

<!--T:39-->
* Github repository: https://github.com/triplus/CubeMenu


<!--T:7-->
<!--T:7-->
{{Docnav
{{Docnav
|[[Import Export Preference|Import Export Preference]]
|[[Import_Export_Preferences|Import Export Preferences]]
|[[Property editor|Property editor]]
|[[Property_editor|Property editor]]
}}
}}



Revision as of 10:46, 20 October 2020

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 commands available in the Customize dialog box depend on the workbenches that have been loaded in the current FreeCAD session. So you should first load all workbenches whose commands you want to have access to.
  2. There are several ways to invoke the Std DlgCustomize command:
    • Select the Tools → Customize... option from the menu.
    • Right-click a toolbar area and choose Customize... from the context menu.
  3. The Customize dialog box opens. For more information see Options.
  4. The Help button does not work at this time.
  5. Press the Close button to close the dialog box.

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 panel on the right.
  3. Hover a command: its tooltip appears.
  4. Select a command: its status bar text is displayed below the two panels.

top

Keyboard

The Keyboard tab

On this tab custom keyboard shortcuts can be defined. Shortcuts for macro commands can 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 if 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.

Notes (Keyboard)

  • 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 appear 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.

top

Workbenches

File:Std DlgCustomize tab Workbenches.png

The Workbenches tab

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

Disable a workbench

  1. Select a 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 a 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 a workbench position

  1. Select a 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.

top

Toolbars

The Toolbars tab

On this tab custom toolbars can be created and modified.

Select the workbench

  1. In the dropdown list on the right select the workbench whose custom toolbars you want to modify. The Global option is there for custom toolbars that should be available in all workbenches.

Create a toolbar

  1. Press the New... button.
  2. Enter a name in the dialog box that opens.
  3. Press the OK button.
  4. The new toolbar will appear in the panel on the right.

Rename a toolbar

  1. Select a toolbar in the panel on the right.
  2. Press the Rename... button.
  3. Enter a new name in the dialog box that opens.
  4. Press the OK button.

Delete a toolbar

  1. Select a toolbar in the panel on the right.
  2. Press the Delete button.

Disable a toolbar

  1. Uncheck the checkbox in front of the toolbar name in the panel on the right.
  2. A disabled toolbar will be invisible in the FreeCAD interface.

Add a command

  1. Select the correct toolbar in the panel on the right. If no toolbar is selected, the command will be added to the first toolbar in the list.
  2. Select a category from the dropdown list on the left. Macro commands that have been set up on the Macros tab appear in the 'Macros' category.
  3. Select a command from the panel on the left.
  4. Or select '<Separator>' to add a separator (a line between two toolbar buttons).
  5. Press button.

Remove a command

  1. If required, expand the toolbar in the panel on the right.
  2. Select a command.
  3. Press button.

Change a command position

  1. If required, expand the toolbar in the panel on the right.
  2. Select a command.
  3. Press the button or the button.
  4. Optionally repeat this until the command is in the correct position.

Notes (Toolbars)

  • Toolbars belonging to the current workbench are updated immediately, but after disabling/re-enabling a toolbar a workbench change is required (switch to a different workbench and then switch back).
  • To update global toolbars a workbench change (if commands have been added or removed) or a restart (if the order of a toolbar has changed or a toolbar was renamed) is required.
  • In V0.19 there is an issue with some Draft commands. After adding them to a custom toolbar and exiting the FreeCAD application the user.cfg file must be manually edited for these commands. Search for the name of the custom toolbar and in that section change the content of the FCText items that start with gui_ to DraftTools.

top

Macros

The Macros tab

On this tab user macro commands can be set up. Once set up, they can be added to custom toolbars. FreeCAD uses a dedicated folder for user macros and only macros in that folder can be set up. Use the Std DlgMacroExecute command to find this folder on your system.

If you download a macro with the Addon Manager then make sure that you also download its icon image file. Most macros have an image link on the information page that appears in the Addon Manager. You can for example put this image file in the user macros folder.

If you want to use a macro downloaded from a different source you will have to install it manually. See How to install macros for more information.

Add a macro command

  1. In the Macro dropdown list select a macro.
  2. Enter a Menu text. This will be the name used to identify the macro command and will also appear in the toolbar if there is no icon.
  3. Optionally enter a Tool tip. This text will appear near the location of the mouse when you hover the toolbar icon.
  4. Optionally enter a Status text. This text will appear in the status bar when you hover the toolbar icon.
  5. Optionally enter the wiki page for the macro, if available, in the What's this input box. Enter the page name, not the full URL.
  6. Optionally enter a shortcut in the Accelerator input box. See Keyboard for more information.
  7. To add an icon:
    1. Press the Pixmap ... button.
    2. The Choose Icon dialog box opens.
    3. If required press the Icon folders... button to add an icon folder.
    4. Select an icon from the panel. The Choose Icon dialog box closes automatically.
  8. Press the Add button.
  9. The macro command appears in the panel on the left.
  10. The macro command can now be selected on the Toolbars tab.

Remove a macro command

  1. Select the macro command in the panel on the left.
  2. Press the Remove button.

Change a macro command

  1. Double-click the macro command in the panel on the left.
  2. Make the required changes. Note that you cannot remove the icon, you can only replace it.
  3. Press the Replace button.

top

Spaceball Motion

This is tab is blank if no Spaceball is detected. See: 3Dconnexion input devices.

top

Spaceball Buttons

This is tab is blank if no Spaceball is detected. See: 3Dconnexion input devices.

top

Themes

FreeCAD supports complete theming of the interface, via .qss stylesheets. The qss format is very similar to the css format used in web pages, it basically adds more methods to reference the different widgets and elements of the Qt interface. You can change the current default theme (which simply takes the style defined by your desktop system) to one of the built-in themes bundled with FreeCAD, or create your own, for example starting from one of the built-in styles and editing it. Your new style must be placed in a folder named $USERAPPDATA/Gui/Stylesheets to be known to FreeCAD ($USERAPPDATA is obtained by typing App.getUserAppDataDir() in the FreeCAD console).

top

Addons

Addons offer yet another way to customize the use interface. Below are some addons created by users in the FreeCAD community. They can be downloaded through the Addon Manager (note: they are listed on the Workbenches tab).

CubeMenu

Glass

IconThemes

Launcher

PieMenu

RemBench

ShortCut

top