Std DlgParameter: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>

{{Page in progress}}

<translate>
<translate>


<!--T:27-->
{{Docnav
{{Docnav
|
|
Line 19: Line 17:
|MenuLocation=Tools → Edit parameters...
|MenuLocation=Tools → Edit parameters...
|Workbenches=All
|Workbenches=All
|SeeAlso=[[Preferences_Editor|Preferences Editor]]
}}
}}


Line 24: Line 23:


<!--T:2-->
<!--T:2-->
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 '''Std DlgParameter''' command opens the Parameter Editor. In the Parameter Editor the parameters that control the behavior of FreeCAD and its workbenches can be inspected and optionally removed, added or changed. The parameters are stored in a file called {{FileName|user.cfg}}, the location of this file depends on your OS.


<!--T:7-->
<!--T:7-->
The most common parameters are more conveniently accessible via the [[Preferences_Editor|Preferences Editor]].
Working with the Parameter Editor requires some experience. For the most common parameters you can also use the more convenient [[Preferences_Editor|Preferences Editor]].


</translate>
</translate>
[[Image:Parameter_editor.png]]
[[Image:Std_DlgParameter_dialog.png]]
<translate>
<translate>
<!--T:28-->
{{Caption|The Parameter Editor dialog box}}
{{Caption|The Parameter Editor dialog box}}


Line 37: Line 37:


<!--T:3-->
<!--T:3-->
# Select the {{MenuCommand|View → [[Image:Std_DlgParameter.svg|16px]] Edit parameters...}} option from the menu.
# Select the {{MenuCommand|Tools → [[Image:Std_DlgParameter.svg|16px]] Edit parameters...}} option from the menu.
# The Parameter Editor dialog box opens. For more information see [[#Options|Options]].
# Browse to the correct sub-group.
# Optionally press the {{Button|Save to disk}} button to immediately update the {{FileName|user.cfg}} file. This is not required as FreeCAD will automatically update that file when the application closes.
# Optionally add a sub-group by choosing {{MenuCommand|Add sub-group}} from the context menu in the left panel.
# Optionally add a parameter:
#* Select {{MenuCommand|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 {{Button|OK}} button.
#* Enter a value in the next dialog box.
#* Press the {{Button|OK}} button.
# Optionally modify a parameter value:
#* Right-click the parameter in the right panel and choose {{MenuCommand|Change value}}. Or double-click the parameter's value field.
#* Enter a new value in the dialog box that pops up.
#* Press the {{Button|OK}} button.
# There is no need to use the {{Button|Save to disk}} button. All changes are immediately saved.
# Press the {{Button|Close}} button to close the Parameter Editor.
# Press the {{Button|Close}} button to close the Parameter Editor.


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


===Left panel===
===Left panel=== <!--T:30-->


<!--T:31-->
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 parameter groups and sub-groups.


<!--T:32-->
====Expand/Collapse====
''The following options are available in the panel's context menu:''


====Expand/Collapse==== <!--T:33-->
# If a selected group has one or more sub-groups it can be expanded or collapsed by choosing this option in the context menu. Of course you can also expand and collapse the tree in the usual manner.


<!--T:34-->
====Add sub-group====
# If a selected group has one or more sub-groups it can be expanded or collapsed by choosing this option from the context menu. But you can also expand and collapse the tree in the usual manner.


====Add sub-group==== <!--T:35-->

<!--T:36-->
# Select a group.
# Select a group.
# Select the {{MenuCommand|Add sub-group}} option from the context menu.
# Select the {{MenuCommand|Add sub-group}} option from the context menu.
# Enter the name for the new sub-group in the dialog box that pops up.
# Enter a name for the new sub-group in the dialog box that opens.
# Press the {{Button|OK}} button.
# Press the {{Button|OK}} button.


====Remove group====
====Remove group==== <!--T:37-->


<!--T:38-->
# Select a group.
# Select a group.
# Select the {{MenuCommand|Remove group}} option from the context menu.
# Select the {{MenuCommand|Remove group}} option from the context menu.
# Press the {{Button|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).
# Press the {{Button|Yes}} button in the dialog box that opens to confirm you want to remove the group (including all its sub-groups, and all parameters in the group and its sub-groups).


====Rename group====
====Rename group==== <!--T:39-->


<!--T:40-->
# Select a group.
# Select a group.
# Select the {{MenuCommand|Rename group}} option from the context menu.
# Select the {{MenuCommand|Rename group}} option from the context menu.
# Enter a new name.
# Enter a new name.
# A group can also be renamed by double-clicking it.

====Export parameter==== <!--T:41-->

<!--T:42-->
# Select a group.
# Select the {{MenuCommand|Export parameter}} option from the context menu.
# Enter a filename in the dialog box.
# Press the {{Button|Save}} button.

====Import parameter==== <!--T:43-->

<!--T:44-->
# Select a group that does not contain any sub-groups or remove them first. Any existing parameters in the group will be lost.
# Select the {{MenuCommand|Import parameter}} option from the context menu.
# Select a *.FCParam file in the dialog box.
# Press the {{Button|Open}} button.

===Right panel=== <!--T:45-->

<!--T:46-->
The right panel shows the parameters in the group selected in the left panel. If this group only contains sub-groups the right panel will be empty.

<!--T:47-->
''The following options are available in the panel's context menu:''

====Change value==== <!--T:48-->

<!--T:49-->
# Select a parameter.
# Select the {{MenuCommand|Change value}} option from the context menu.
# Enter a new value in the dialog box that opens.
# Press the {{Button|OK}} button.
# A parameter's value can also be changed by double-clicking its 'Type' or 'Value' field.

====Remove key==== <!--T:50-->

<!--T:51-->
# Select a parameter.
# Select the {{MenuCommand|Remove key}} option from the context menu.

====Rename key==== <!--T:52-->

<!--T:53-->
# Select a parameter.
# Select the {{MenuCommand|Rename key}} option from the context menu.
# Enter a new name.
# A parameter can also be renamed by double-clicking its 'Name' field.

====New string item==== <!--T:54-->

<!--T:55-->
# Select the {{MenuCommand|New string item}} or {{MenuCommand|New → New string item}} option from the context menu.
# Enter a name in the dialog box that opens.
# Press the {{Button|OK}} button.
# Enter a value in the next dialog box.
# Press the {{Button|OK}} button.

====New float item==== <!--T:56-->


<!--T:57-->
====Export parameter====
# Select the {{MenuCommand|New float item}} or {{MenuCommand|New → New float item}} option from the context menu.
# The next steps are similar to those for a [[#New_string_item|New string item]]


====Import parameter====
====New integer item==== <!--T:58-->


<!--T:59-->
===Right panel===
# Select the {{MenuCommand|New integer item}} or {{MenuCommand|New → New integer item}} option from the context menu.
# The next steps are similar to those for a [[#New_string_item|New string item]]


====New unsigned item==== <!--T:60-->
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 following options are available in the panel's context menu:


<!--T:61-->
====New string item====
# Select the {{MenuCommand|New unsigned item}} or {{MenuCommand|New → New unsigned item}} option from the context menu.
# The next steps are similar to those for a [[#New_string_item|New string item]]


====New float item====
====New Boolean item==== <!--T:62-->


<!--T:63-->
====New integer item====
# Select the {{MenuCommand|New Boolean item}} or {{MenuCommand|New → New Boolean item}} option from the context menu.
# The next steps are similar to those for a [[#New_string_item|New string item]]


===Sorting=== <!--T:64-->
====New unsigned item====


<!--T:65-->
====New Boolean item====
By default the groups in each tree level in the left panel are sorted alphabetically, and 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=== <!--T:66-->
===Sorting===


<!--T:67-->
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.
Typing a (partial) string in this input box will fully expand the tree in the left panel and highlight all groups with names that match the entered value. If no matches are found the background of the input box will turn red.


===Find=== <!--T:68-->
===Quick search===


<!--T:69-->
===Find===
# In the left panel select the group where you want to start your search. The search direction is down. The search is not restricted to the group and its sub-groups, but rather the selected group and everything below it in the tree will be searched.
# Press the {{Button|Find...}} button.
# Enter a string in the '''Find what''' input box. The search is case-insensitive.
# Check one or more of the {{CheckBox|TRUE|Groups}}, {{CheckBox|TRUE|Names}} and {{CheckBox|TRUE|Values}} checkboxes. Note that only string values will be searched.
# Optionally (un)check the {{CheckBox|TRUE|Match whole string only}} checkbox.
# Press the {{Button|Find Next}} button to select the first group with a match. Matching parameters are not individually highlighted. Optionally repeat this until no further matches can be found.
# It is possible to start a new search without closing the dialog box. Again selecting the group from which to start searching is then usually required.
# Use the {{Button|Cancel}} button to close the dialog box.


==Notes==
==Notes== <!--T:70-->


<!--T:71-->
* The [[Fine-tuning|Fine-tuning]] page lists a number of parameters that may be of interest.
* The [[Fine-tuning|Fine-tuning]] page lists a number of parameters that may be of interest.


==Scripting== <!--T:10-->
==Scripting== <!--T:10-->


<!--T:72-->
{{Emphasis|See also:}} [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].
{{Emphasis|See also:}} [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].


<!--T:73-->
For a scripting example see [[Std_SelBoundingBox|Std SelBoundingBox]].
For a scripting example see [[Std_SelBoundingBox|Std SelBoundingBox]].


<!--T:74-->
{{Docnav
{{Docnav
|
|

Revision as of 13:58, 8 May 2020

Other languages:

Std DlgParameter

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

Description

The Std DlgParameter command opens the Parameter Editor. In the Parameter Editor the parameters that control the behavior of FreeCAD and its workbenches can be inspected and optionally removed, added or changed. The parameters are stored in a file called user.cfg, the location of this file depends on your OS.

Working with the Parameter Editor requires some experience. For the most common parameters you can also use the more convenient Preferences Editor.

The Parameter Editor dialog box

Usage

  1. Select the Tools → Edit parameters... option from the menu.
  2. The Parameter Editor dialog box opens. For more information see Options.
  3. Optionally press the Save to disk button to immediately update the user.cfg file. This is not required as FreeCAD will automatically update that file when the application closes.
  4. Press the Close button to close the Parameter Editor.

Options

Left panel

The left panel shows a tree with 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. But 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 a name for the new sub-group in the dialog box that opens.
  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 opens to confirm you want to remove the group (including all its sub-groups, and all parameters in the group and 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

  1. Select a group.
  2. Select the Export parameter option from the context menu.
  3. Enter a filename in the dialog box.
  4. Press the Save button.

Import parameter

  1. Select a group that does not contain any sub-groups or remove them first. Any existing parameters in the group will be lost.
  2. Select the Import parameter option from the context menu.
  3. Select a *.FCParam file in the dialog box.
  4. Press the Open button.

Right panel

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

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

Change value

  1. Select a parameter.
  2. Select the Change value option from the context menu.
  3. Enter a new value in the dialog box that opens.
  4. Press the OK button.
  5. A parameter's value can also be changed by double-clicking its 'Type' or 'Value' field.

Remove key

  1. Select a parameter.
  2. Select the Remove key option from the context menu.

Rename key

  1. Select a parameter.
  2. Select the Rename key option from the context menu.
  3. Enter a new name.
  4. A parameter can also be renamed by double-clicking its 'Name' field.

New string item

  1. Select the New string item or New → New string item option from the context menu.
  2. Enter a name in the dialog box that opens.
  3. Press the OK button.
  4. Enter a value in the next dialog box.
  5. Press the OK button.

New float item

  1. Select the New float item or New → New float item option from the context menu.
  2. The next steps are similar to those for a New string item

New integer item

  1. Select the New integer item or New → New integer item option from the context menu.
  2. The next steps are similar to those for a New string item

New unsigned item

  1. Select the New unsigned item or New → New unsigned item option from the context menu.
  2. The next steps are similar to those for a New string item

New Boolean item

  1. Select the New Boolean item or New → New Boolean item option from the context menu.
  2. The next steps are similar to those for a New string item

Sorting

By default the groups in each tree level in the left panel are sorted alphabetically, and 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

Typing a (partial) string in this input box will fully expand the tree in the left panel and highlight all groups with names that match the entered value. If no matches are found the background of the input box will turn red.

Find

  1. In the left panel select the group where you want to start your search. The search direction is down. The search is not restricted to the group and its sub-groups, but rather the selected group and everything below it in the tree will be searched.
  2. Press the Find... button.
  3. Enter a string in the Find what input box. The search is case-insensitive.
  4. Check one or more of the Groups, Names and Values checkboxes. Note that only string values will be searched.
  5. Optionally (un)check the Match whole string only checkbox.
  6. Press the Find Next button to select the first group with a match. Matching parameters are not individually highlighted. Optionally repeat this until no further matches can be found.
  7. It is possible to start a new search without closing the dialog box. Again selecting the group from which to start searching is then usually required.
  8. Use the Cancel button to close the dialog box.

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.

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