Std DlgParameter: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
Line 58: Line 58:
===Left panel===
===Left panel===


The left panel shows a tree with the parameter groups and sub-groups. The following options are available in the panel's context menu:
The left panel shows a tree with the parameter groups and sub-groups.

''The following options are available in the panel's context menu:''


====Expand/Collapse====
====Expand/Collapse====
Line 92: Line 94:
The right panel shows the parameters in the group selected in the left panel. If a group only contains sub-groups the left panel will be empty.
The right panel shows the parameters in the group selected in the left panel. If a group only contains sub-groups the left panel will be empty.


If there are parameters in the group the following options are available in the panel's context menu:
''If there are parameters in the group the following options are available in the panel's context menu:''


====Change value====
====Change value====
Line 99: Line 101:


====Rename key====
====Rename key====

If there are no parameters in the group the following options are available, if there are parameters they are listed in the {{MenuCommand|New}} submenu:


====New string item====
====New string item====

Revision as of 21:53, 17 April 2020

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


Std DlgParameter

Menu location
Tools → Edit parameters...
Workbenches
All
Default shortcut
None
Introduced in version
-
See also
None

Description

The Std DlgParameter command opens the Parameter Editor. In the Parameter Editor all parameters that control the behavior of FreeCAD and its workbenches can be inspected and optionally removed, added or changed.

The most common parameters are more conveniently accessible via the Preferences Editor.

The Parameter Editor dialog box

Usage

  1. Select the View → Edit parameters... option from the menu.
  2. Browse to the correct sub-group.
  3. Optionally add a sub-group by choosing Add sub-group from the context menu in the left panel.
  4. Optionally add a parameter:
    • Select New from the context menu in the right panel.
    • Select the correct item type from the next menu. The following types are available: 'string', 'float', 'integer', 'unsigned' and 'Boolean'.
    • Enter a name in the dialog box that pops up.
    • Press the OK button.
    • Enter a value in the next dialog box.
    • Press the OK button.
  5. Optionally modify a parameter value:
    • Right-click the parameter in the right panel and choose Change value. Or double-click the parameter's value field.
    • Enter a new value in the dialog box that pops up.
    • Press the OK button.
  6. There is no need to use the Save to disk button. All changes are immediately saved.
  7. Press the Close button to close the Parameter Editor.

Options

Left panel

The left panel shows a tree with the parameter groups and sub-groups.

The following options are available in the panel's context menu:

Expand/Collapse

  1. If a selected group has one or more sub-groups it can be expanded or collapsed by choosing this option from the context menu. Of course you can also expand and collapse the tree in the usual manner.

Add sub-group

  1. Select a group.
  2. Select the Add sub-group option from the context menu.
  3. Enter the name for the new sub-group in the dialog box that pops up.
  4. Press the OK button.

Remove group

  1. Select a group.
  2. Select the Remove group option from the context menu.
  3. Press the Yes button in the dialog box that pops up to confirm you want to remove the group (including all its sub-groups, and all parameters in the selected group and in its sub-groups).

Rename group

  1. Select a group.
  2. Select the Rename group option from the context menu.
  3. Enter a new name.
  4. A group can also be renamed by double-clicking it.

Export parameter

Import parameter

Right panel

The right panel shows the parameters in the group selected in the left panel. If a group only contains sub-groups the left panel will be empty.

If there are parameters in the group the following options are available in the panel's context menu:

Change value

Remove key

Rename key

New string item

New float item

New integer item

New unsigned item

New Boolean item

Sorting

By default the groups in each tree level in the left panel are sorted alphabetically. The parameters in the right panel are sorted alphabetically as well. But the order in each panel can be reversed by clicking the 'Group' or 'Name' header respectively.

Quick search

Find

Notes

  • The Fine-tuning page lists a number of parameters that may be of interest.

Scripting

See also: FreeCAD Scripting Basics.

For a scripting example see Std SelBoundingBox.