Std DlgParameter: Difference between revisions

From FreeCAD Documentation
(Marked this version for translation)
(Marked this version for translation)
(32 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<languages/>
{{UnfinishedDocu{{#translation:}}}}
<translate>
<translate>


<!--T:1-->
<!--T:1-->
{{GuiCommand
{{Template:UnfinishedDocu}}
|Name=Parameter editor
|Icon=Std DlgParameter.svg
|Workbenches=All
|MenuLocation={{StdMenu|[[Std Tools Menu|Tools]]}} → Edit parameters...
}}


==Description== <!--T:20-->


<!--T:2-->
<!--T:2-->
The [[Std DlgParameter|parameter editor]] allows you to access, create, and modify the parameter table that controls different behaviors of FreeCAD and its workbenches.
{{GuiCommand|Name=Std DlgParameter|Workbenches=All|MenuLocation=[[Std Tools|Tools]] → Parameter |Shortcut=|SeeAlso=}}

<!--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.

==Usage== <!--T:21-->


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


<!--T:8-->
See [[Fine-tuning|fine-tuning]] to learn what parameters can be changed.

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

==Related== <!--T:22-->

<!--T:23-->
* [[Path experimental]] using the Parameter editor to enable experimental features

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

<!--T:24-->
{{VeryImportantMessage|This section is incomplete and needs to be formulated}}

<!--T:25-->
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
.RemInt
.GetUnsigned
}}

{{Code|code=
App.ParamGet('User Parameters:BaseApp').GetGroup()
.GetContents()
}}
<translate>
<!--T:26-->
See also this [https://forum.freecadweb.org/viewtopic.php?f=22&t=44171&p=376955#p376955 forum thread]


<!--T:4-->
[[Category:UnfinishedDocu]]


</translate>
</translate>
{{Std Base{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}
{{clear}}
<languages/>

Revision as of 21:19, 23 March 2020

This documentation is not finished. Please help and contribute documentation.

GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands.

See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.

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.

Usage

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

See fine-tuning to learn what parameters can be changed.

Related

Scripting

This section is incomplete and needs to be formulated

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

See also this forum thread