Std DlgParameter: Difference between revisions

From FreeCAD Documentation
m (</translate>)
(3 intermediate revisions by 2 users not shown)
Line 24: Line 24:
[[Image:Parameter_editor.png]]
[[Image:Parameter_editor.png]]


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


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


Line 37: Line 38:
}}
}}


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

}}
.GetInt
.GetInt
.RemInt
.RemInt
.GetUnsigned
.GetUnsigned
}}
{{Code|

{{Code|code=
App.ParamGet('User Parameters:BaseApp').GetGroup()
App.ParamGet('User Parameters:BaseApp').GetGroup()
.GetContents()
.GetContents()
}}
}}
<translate>


<!--T:9-->
<!--T:9-->

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()