Interface Customization

From FreeCAD Documentation
Revision as of 15:09, 30 April 2020 by Roy 043 (talk | contribs) (Revising. Work in progress.)
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