Std DlgParameter: Difference between revisions

From FreeCAD Documentation
No edit summary
m (</translate>)
(13 intermediate revisions by 6 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand|Name=Std DlgParameter|Workbenches=All|MenuLocation=[[Std Tools Menu|Tools]] → Parameter |Shortcut=|SeeAlso=}}
|Name=Parameter editor
|Icon=Std DlgParameter.svg
|Workbenches=All
|MenuLocation=[[Std Tools Menu|Tools]] → Edit parameters...
}}


==Description== <!--T:2-->
==Description== <!--T:2-->
Allows you to access and alter parameters/preferences of the different functions and workbenches.
The [[Std DlgParameter|parameter editor]] allows you to access, create, and modify the parameter table that controls different behaviors of FreeCAD and its workbenches.


==Use== <!--T:3-->
<!--T:7-->
The most common options can be changed from the [[Preferences Editor|preferences editor]], but certain tweaks are only accessible through the parameter editor.
Choose {{KEY| Tools}} → {{KEY| Edit parameters...}} from the top menu.

==How to use== <!--T:3-->
Go to the menu {{MenuCommand|Tools → Edit parameters}}; then browse the different categories to access the variables under each category.

<!--T:8-->
See [[Fine-tuning|fine-tuning]] for some parameters that can be changed.


<!--T:6-->
<!--T:6-->
[[Image:Parameter_Editor.jpg]]
[[Image:Parameter_editor.png]]

==Scripting== <!--T:10-->
It is possible to manipulate the Parameter Tree using the FreeCAD Python API:

</translate>
{{Code|code=
.GetBool(variable,bool) # method to get boolean

.SetBool # method to set boolean
.GetString
.SetString
.GetFloat
.SetFloat
}}

{{Code|code=
.SetInt(variable, int) method to set integer
Example: to set the height of the Addon Manager
pref = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Addons")
pref.SetInt("WindowHeight",480)


.GetInt
==Limitations== <!--T:4-->
.RemInt
<br />
.GetUnsigned
}}


{{Code|code=
==Notes== <!--T:5-->
App.ParamGet('User Parameters:BaseApp').GetGroup()
<br />
.GetContents()
}}
<translate>


<!--T:9-->
{{Std Base}}
{{Userdocnavi}}
</translate>
</translate>
{{clear}}

Revision as of 11:22, 29 October 2019

Parameter editor

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

Description

The parameter editor allows you to access, create, and modify the parameter table that controls different behaviors of FreeCAD and its workbenches.

The most common options can be changed from the preferences editor, but certain tweaks are only accessible through the parameter editor.

How to use

Go to the menu Tools → Edit parameters; then browse the different categories to access the variables under each category.

See fine-tuning for some parameters that can be changed.

Scripting

It is possible to manipulate the Parameter Tree using the FreeCAD Python API:

.GetBool(variable,bool) # method to get boolean

.SetBool        # method to set boolean
.GetString
.SetString
.GetFloat
.SetFloat
.SetInt(variable, int) method to set integer
Example: to set the height of the Addon Manager 
pref = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Addons")
pref.SetInt("WindowHeight",480)

.GetInt
.RemInt
.GetUnsigned
App.ParamGet('User Parameters:BaseApp').GetGroup()
.GetContents()