Std DlgParameter: Difference between revisions

Revision as of 14:11, 17 April 2020

Other languages:

This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.

Std ViewScreenShot

Std Tools Menu

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

Description

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 most common parameters are more conveniently accessible via the Preferences Editor.

The Parameter Editor dialog box

Usage

Select the View → Edit parameters... option from the menu.
Browse to the correct sub-group.
Optionally add a sub-group by choosing Add sub-group from the context menu in the left panel.
Optionally add a parameter:
- Select 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 OK button.
- Enter a value in the next dialog box.
- Press the OK button.
Optionally modify a parameter value:
- Right-click the parameter in the right panel and choose Change value. Or double-click the parameter's value field.
- Enter a new value in the dialog box that pops up.
- Press the OK button.
There is no need to use the Save to disk button. All changes are immediately saved.
Press the Close button to close the Parameter Editor.

Options

Todo.

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 ViewScreenShot

Std Tools Menu

Std Base

File: New, Open, Close, Close All, Save, Save As, Save a Copy, Save All, Revert, Import, Export,Merge project, Project information, Print, Print preview, Export PDF, Recent files, Exit

Edit: Undo, Redo, Cut, Copy, Paste, Duplicate selection, Refresh, Box selection, Box element selection, Select All, Delete, Send to Python Console, Placement, Transform, Alignment, Toggle Edit mode, Edit mode, Preferences

View:
- Miscellaneous: Create new view, Orthographic view, Perspective view, Fullscreen, Bounding box, Toggle axis cross, Clipping plane, Texture mapping, Toggle navigation/Edit mode, Appearance, Random color, Workbench, Status bar
- Standard views: Fit all, Fit selection, Isometric, Dimetric, Trimetric, Home, Front, Top, Right, Rear, Bottom, Left, Rotate Left, Rotate Right
- Freeze display: Save views, Load views, Freeze view, Clear views
- Draw style: As is, Points, Wireframe, Hidden line, No shading, Shaded, Flat lines
- Stereo: Stereo red/cyan, Stereo quad buffer, Stereo Interleaved Rows, Stereo Interleaved Columns, Stereo Off, Issue camera position
- Zoom: Zoom In, Zoom Out, Box zoom
- Document window: Docked, Undocked, Fullscreen
- Visibility: Toggle visibility, Show selection, Hide selection, Select visible objects, Toggle all objects, Show all objects, Hide all objects, Toggle selectability, Toggle measurement, Clear measurement
- Toolbars: File, Edit, Clipboard, Workbench, Macro, View, Structure, Help
- Panels: Tree view, Property view, Selection view, Tasks, Python console, DAG view, Model, Report view
- Link navigation: Go to linked object, Go to the deepest linked object, Select all links
- Tree view actions: Sync view, Sync selection, Sync placement, Pre-selection, Record selection, Single document, Multi document, Collapse/Expand, Initiate dragging, Go to selection, Selection Back, Selection Forward

Tools: Edit parameters, Save image, Load image, Scene inspector, Dependency graph, Project utility, Measure distance, Add text document, View turntable, Units calculator, Customize, Addon manager

Macro: Macro recording, Macros, Recent macros, Execute macro, Attach to remote debugger, Debug macro, Stop debugging, Step over, Step into, Toggle breakpoint

Windows: Next, Previous, Tile, Cascade, Windows

Help: Help, FreeCAD Website, Donate, Users documentation, Python scripting documentation, Automatic Python modules documentation, FreeCAD Forum, FreeCAD FAQ, Report a bug, About FreeCAD, What's This

Structure and Link: Std Part, Std Group, Make link, Make sub-link, Replace with link, Unlink, Import links, Import all links

User documentation

Getting started
Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

Help: Tutorials, Video tutorials
Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

Addons: Addon Manager, External workbenches, Scripting and macros

Hubs: User hub, Power users hub, Developer hub

@@ Line 1: / Line 1: @@
 <languages/>
-{{UnfinishedDocu{{#translation:}}}}
+{{Page in progress}}
 <translate>
+{{Docnav
+|
+|[[Std_ViewScreenShot|Std ViewScreenShot]]
+|[[Std_Tools_Menu|Std Tools Menu]]
+|IconL=
+|IconR=Std_ViewScreenShot.svg
+|IconC=Freecad.svg
+}}
 <!--T:1-->
 {{GuiCommand
-|Name=Parameter editor
+|Name=Std DlgParameter
+|MenuLocation=Tools → Edit parameters...
-|Icon=Std DlgParameter.svg
 |Workbenches=All
-|MenuLocation={{StdMenu|[[Std Tools Menu|Tools]]}} → Edit parameters...
 }}
 ==Description== <!--T:20-->
 <!--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.
+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.
 <!--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.
+The most common parameters are more conveniently accessible via the [[Preferences_Editor|Preferences Editor]].
+</translate>
-==Usage== <!--T:21-->
+[[Image:Parameter_editor.png]]
+<translate>
+{{Caption|The Parameter Editor dialog box}}
+==Usage== <!--T:21-->
 <!--T:3-->
-Go to the menu {{MenuCommand|{{StdMenu|Tools}} → Edit parameters}}; then browse the different categories to access the variables under each category.
+# Select the {{MenuCommand|View → [[Image:Std_DlgParameter.svg|16px]] Edit parameters...}} option from the menu.
+# Browse to the correct sub-group.
+# 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.
+==Options==
-<!--T:8-->
-See [[Fine-tuning|fine-tuning]] to learn what parameters can be changed.
+* Todo.
-<!--T:6-->
-[[Image:Parameter_editor.png]]
+==Notes==
-==Related== <!--T:22-->
+* The [[Fine-tuning|Fine-tuning]] page lists a number of parameters that may be of interest.
-<!--T:23-->
-* [[Path experimental]] using the Parameter editor to enable experimental features
 ==Scripting== <!--T:10-->
+{{Emphasis|See also:}} [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].
-<!--T:24-->
-{{VeryImportantMessage|This section is incomplete and needs to be formulated}}
+For a scripting example see [[Std_SelBoundingBox|Std SelBoundingBox]].
-<!--T:25-->
-It is possible to manipulate the Parameter Tree using the FreeCAD Python API:
+{{Docnav
-</translate>
+|
-{{Code|code=
+|[[Std_ViewScreenShot|Std ViewScreenShot]]
-.GetBool(variable,bool) # method to get boolean
+|[[Std_Tools_Menu|Std Tools Menu]]
+|IconL=
-.SetBool        # method to set boolean
+|IconR=Std_ViewScreenShot.svg
-.GetString
+|IconC=Freecad.svg
-.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]
 </translate>
-{{Std Base{{#translation:}}}}
+{{Std Base navi{{#translation:}}}}
 {{Userdocnavi{{#translation:}}}}
 {{clear}}