GuiCommand model

From FreeCAD Documentation
Jump to navigation Jump to search
This page is a translated version of the page GuiCommand model and the translation is 3% complete.
Outdated translations are marked like this.
Other languages:
English • ‎español • ‎français • ‎italiano • ‎română • ‎русский
This page shows a model of a recommended GuiCommand page. Under the Selectable block section below you will find the same content easily selectable for pasting in a new page.

Base ExampleCommandModel.png Base ExampleCommandModel

Расположение в меню
Sample -> Command
Верстаки
Wb1,Wb2
Быстрые клавиши
отсутствуют
Представлено в версии
-
См. также
...


Description

While the page is under construction, add the Template:UnfinishedDocu template at the top of the page by simply typing: {{UnfinishedDocu}}

Insert here a short description of what the command does.

Remember to use Template:Version, Template:VersionMinus, Template:VersionPlus and Template:Obsolete when applicable.

For example: The feature to utilize App::Link introduced in version 0.19 allows linking between sub-assemblies etc...

Add an image if possible, and please follow the guidelines in WikiPages#Graphics. Example taken from Draft Line:

Draft Line example.jpg

Optional: add a caption below the image to explain what the tool is doing.


Closing and opening translate tags should surround images, and other fixed elements, if they don't need to be translated. The caption should always be translated.

Usage

  1. There are several ways to invoke the command:
    • The Std Close.png Command name button from the toolbar (Editor note: Using the Template:Button template, it is necessary to link to command as shown in this example)
    • Using the Menu → Submenu → Command from the top menu. (Editor note: This uses the Template:MenuCommand wiki template)
    • Use the keyboard shortcut F then C or Ctrl + Z (Editor note: This uses the Template:KEY wiki template)
    • (Optional) RMB (Right Mouse Button) context menu: RMB → Std Close.png Command name
  2. Detailed steps as needed. Some steps may need Keyboard presses while others may require using the mouse to click on a Button
  3. Other commands may need to be referenced/used. Consider linking to their wiki pages along with their icons Draft Line.svg Draft Line or PartDesign Pad.svg PartDesign Pad
  4. Set options and press OK.

Options

Properties

Data

  • DataPropertyName1: Description of the property

View

  • ViewPropertyName2: Description of the property

Example

Optional

Scripting

See also: Category:API and FreeCAD Scripting Basics.

The ExampleCommandModel tool can be used in macros and from the Python console by using the following function:

Object = makeExampleCommandModel(Data1, Data2)
  • Creates an Object using Data1 and Data2.

Example:

import FreeCAD, Base

Model = Base.makeExampleCommandModel(FreeCAD.Data1, FreeCAD.Data2)

Limitations

  • Optional, use bullet list if multiple items

Other

Optional


Selectable block

{{UnfinishedDocu}}
<translate>

{{GuiCommand
|Name=Base ExampleCommandModel
|Icon=<!--filename of icon with extension (e.g. svg, png) if not the same name as command; delete this row if not used-->
|MenuLocation=Menu → Submenu → Command
|Workbenches=[[Workbench Name|Workbench]]
|Shortcut={{KEY|F}} {{KEY|C}} <!--delete this row if not used-->
|SeeAlso=<!--add links to similar commands; delete this row if not used-->
|Version=0.17
}}

==Description==

While the page is under construction, add the {{UnfinishedDocu}} template at the top of the page.

Insert here a short description of what the command does.

</translate>
[[Image:Draft_Line_example.jpg|none|400px]]
<translate>

{{Caption|Optional: add a caption below the image to explain what the tool is doing.}}

Closing and opening translate tags should surround images, and other fixed elements, if they don't need to be translated. The caption should always be translated.

==Usage==

# There are several ways to invoke the command: 
#* The {{Button|[[Image:Std Close.png|16px]] [[GuiCommand model|Command name]]}} button from the toolbar (''Editor note:'' Using the [[Template:Button]] template, it is necessary to link to command as shown in this example)
#* Using the {{MenuCommand|Menu → Submenu → Command}} from the top menu. (''Editor note:'' This uses the [[Template:MenuCommand]] wiki template)
#* Use the keyboard shortcut {{KEY|F}} then {{KEY|C}} or {{KEY|Ctrl}} + {{KEY|Z}} (''Editor note:'' This uses the [[Template:KEY]] wiki template)
#* (Optional) RMB (Right Mouse Button) context menu: {{MenuCommand|RMB → {{Button|[[Image:Std Close.png|16px]] [[GuiCommand model|Command name]]}}}}
# Detailed steps as needed. Some steps may need {{KEY|Keyboard}} presses while others may require using the mouse to click on a {{Button|Button}} 
# Other commands may need to be referenced/used. Consider linking to their wiki pages along with their icons {{Button|[[Image:Draft_Line.svg|16px]] [[Draft Line|Draft Line]]}} or {{Button|[[Image:PartDesign_Pad.svg|16px]] [[PartDesign Pad|PartDesign Pad]]}}
# Set options and press {{Button|OK}}.

==Options==

* List the command options here.

==Properties==

===Data===

* {{PropertyData|PropertyName1}}: Description of the property

===View===

* {{PropertyView|PropertyName2}}: Description of the property

==Example==

Optional

==Scripting==
{{Emphasis|See also:}} [[:Category:API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].

The ExampleCommandModel tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following function:

</translate>
{{Code|code=
Object = makeExampleCommandModel(Data1, Data2)
}}
<translate>

* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}.

Example:

</translate>
{{Code|code=
import FreeCAD, Base

Model = Base.makeExampleCommandModel(FreeCAD.Data1, FreeCAD.Data2)
}}
<translate>

==Limitations==

* Optional, use bullet list if multiple items

==Other==

Optional

</translate>