04 ‐ Ribbon preferences

The preference dialog consists of the following tabs:

• General
• Navigation
• Miscellaneous The settings are not stored in the "RibbonStructure_default.json" file but in FreeCAD itself like all FreeCAD's own settings.
  You can find these settings under Tools -> Parameters

Dialog buttons
With the close and cancel button you can close the dialog with or without saving your settings.

Reset button
With the reset button, all values will be set to their default values.

General settings

There are two main group of settings:

1. Backup settings
2. Ribbon settings

Backup settings
Standard the backup function is enabled. When enabled, every time you update the ribbon design, a backup version of "RibbonStructure_default.json" will be saved in the backup location. Standard this is the folder "Backup" in the location of the addon. You can change the location to another location.

Ribbon settings
Here you can set the following settings:

1. You can set the tab style with the following options:
   1. Set tab bar to show tabs with icon with text, icon only or text only.
   2. Set the toolbar position for the quick access toolbar and right toolbar to either above the tab bar or inline with the tab bar
   3. Hide the window title bar
2. The size for the small, medium and large buttons.
3. Enable text for the buttons per size
4. Set the font size for:
   1. Menus
   2. Buttons
   3. Tabs
   4. Panel titles
5. Set a maximum number of columns per panel. The commands that are beyond these columns, will be added to a pulldown menu:
   
6. Select a stylesheet for the ribbon. Standard is "default.qss" selected, but you can create your own stylesheet.

Navigation settings

Here you can set the following settings:

• Scroll speed for the mouse wheel
• Scroll speed for the scroll buttons
  The shortcut keys can be set with FreeCAD's customize menu.

Colors and Icons

You can set your own colors for:

• The borders of the buttons when you hover over them
• The background of the buttons when you hover over them
• The background color for the application button

You can also choose your own icons for:

• The scroll buttons of the tab bar
• The scroll buttons of the ribbon
• The overflow menu for extra command
• The icons for the pin button

Miscellaneous

On this tab, you will find settings that are not categorized. You can set:

• The preferred view panel:
  • Individual views panel
  • View panel (based on the classic FreeCAD views toolbar
  • Views panel (FreeCAD Ribbon specific design, created as a new panel)
• The use of a standard "Tools" panel. (FreeCAD Ribbon specific design, created as a new panel)
• You can enable overlay functions. Standard the Ribbon Overlay function is used.
  • You can enable the original overlay function of FreeCAD.
    However, the original overlay function has compatibility issues. Enable this on your own risk.
    This is also the reason that the pinbutton is removed when these functions are enabled.
    In case there is an issue, you can restore the default overlay function by adding a file named "OVERLAY_DISABLED" (No extension) in the folder of the
    add-on.

Ribbon commands

The application menu, ribbon layout menu, ribbon preferences and the pin button are added as commands to FreeCAD. Via the customize menu of FreeCAD you can apply shortcut keys to them. The default commands and their shortcut keys are:

• Ribbon_Menu -> Shows the application menu (default: Alt+A)
• Ribbon_Layout -> Opens the Ribbon layout dialog (default: Alt+L)
• Ribbon_Preferences -> Opens the Ribbon preferences dialog (default: Alt+P)
• Ribbon_Pin -> Toggles autohide Ribbon (default Alt+T)

Notes:

1. After unchecking "Use standard Tools panel", you have to remove the panel from the "New panels" tab in the layout menu.
2. The Tools and Views panel can be changed afterwards. Only when the panels are removed, they will be recreated on the next startup.