LabRPS: Created page with "{{Docnav | |ProjectUtil |Std Tools Menu |IconL= |IconR=Std_ProjectUtil.svg |IconC=Labrps.svg }} {{GuiCommand |Name=Std DlgParameter |MenuLocation=Tools → Edit parameters... |Phenomena=All |SeeAlso=Preferences Editor }} ==Description== The '''Std DlgParameter''' command opens the Parameter Editor. In the Parameter Editor the parameters that control the behavior of LabRPS and its workbenches can be inspecte..."

2024-10-26T16:13:50Z

Created page with "{{Docnav | |ProjectUtil |Std Tools Menu |IconL= |IconR=Std_ProjectUtil.svg |IconC=Labrps.svg }} {{GuiCommand |Name=Std DlgParameter |MenuLocation=Tools → Edit parameters... |Phenomena=All |SeeAlso=Preferences Editor }} ==Description== The '''Std DlgParameter''' command opens the Parameter Editor. In the Parameter Editor the parameters that control the behavior of LabRPS and its workbenches can be inspecte..."

New page

{{Docnav
|
|[[Std_ProjectUtil|ProjectUtil]]
|[[Std_Tools_Menu|Std Tools Menu]]
|IconL=
|IconR=Std_ProjectUtil.svg
|IconC=Labrps.svg
}}

{{GuiCommand
|Name=Std DlgParameter
|MenuLocation=Tools → Edit parameters...
|Phenomena=All
|SeeAlso=[[Preferences_Editor|Preferences Editor]]
}}

==Description==

The '''Std DlgParameter''' command opens the Parameter Editor. In the Parameter Editor the parameters that control the behavior of LabRPS 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.

Working with the Parameter Editor requires some experience. For the most common parameters the [[Preferences_Editor|Preferences Editor]] should be used instead.

[[Image:Std_DlgParameter_dialog.png]]

{{Caption|The Parameter Editor dialog box}}

==Usage==

# 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]].
# Optionally press the {{Button|Save to disk}} button to immediately update the {{FileName|user.cfg}} file. This is not required as LabRPS will automatically update that file when the application closes.
# Press the {{Button|Close}} button to close the dialog box and finish the command.

==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====

# 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====

# Select a group.
# Select the {{MenuCommand|Add sub-group}} option from the context menu.
# Enter a name for the new sub-group in the dialog box that opens.
# Press the {{Button|OK}} button.

====Remove group====

# Select a group.
# Select the {{MenuCommand|Remove group}} option from the context menu.
# 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====

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

====Export parameter====

# 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====

# 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 an {{FileName|*.FCParam}} file in the dialog box.
# Press the {{Button|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====

# 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====

# Select a parameter.
# Select the {{MenuCommand|Remove key}} option from the context menu.

====Rename key====

# 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====

# 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====

# 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]]

====New integer item====

# 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====

# 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 Boolean 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===

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===

# 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 '''Groups''', '''Names''' and '''Values''' checkboxes. Note that only string values will be searched.
# Optionally (un)check the '''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 are 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.

==Scripting==

See also: [https://labrps.github.io/SourceDoc/ Autogenerated API documentation] and [[LabRPS_Scripting_Basics|LabRPS Scripting Basics]].

Preferences can be accessed from Python scripts using their corresponding path in the [[Std_DlgParameter|Parameter Editor]]. For example, the {{MenuCommand|Edit → Preferences → Import-Export → DXF → Import options → Join geometry}} preference appears in {{MenuCommand|Tools → Edit parameters → BaseApp → Preferences → Mod → Draft → dxfCreatePart}} and has type {{incode|Boolean}}. It can therefore be accessed in Python using the following code:

{{Code|code=
# get:
App.ParamGet("User parameter:BaseApp/Preferences/Mod/MyWorkbench").GetBool('myParameter')
# set:
App.ParamGet("User parameter:BaseApp/Preferences/Mod/MyWorkbench").SetBool('myOtherParameter', True)
}}

{{Docnav
|
|[[Std_ProjectUtil|ProjectUtil]]
|[[Std_Tools_Menu|Std Tools Menu]]
|IconL=
|IconR=Std_ProjectUtil.svg
|IconC=Labrps.svg
}}

{{Std_Base_navi}}
{{Userdocnavi}}

Std DlgParameter - Revision history