GuiCommand model: Difference between revisions
mNo edit summary |
m (png to svg) |
||
(22 intermediate revisions by 4 users not shown) | |||
Line 2: | Line 2: | ||
<translate> |
<translate> |
||
<!--T:15--> |
<!--T:15--> |
||
{{VeryImportantMessage|This page shows a model to document a [[Gui Command]]. Under the [[#Selectable block|Selectable block]] section below you will find the same content easily selectable for pasting in a new page.}} |
{{VeryImportantMessage|This page shows a model to document a [[Gui Command|Gui Command]]. Under the [[#Selectable block|Selectable block]] section below you will find the same content easily selectable for pasting in a new page.}} |
||
<!--T:1--> |
<!--T:1--> |
||
Line 10: | Line 10: | ||
|MenuLocation=Menu → Submenu → Command |
|MenuLocation=Menu → Submenu → Command |
||
|Workbenches=[[Workbench Name|Workbench]] |
|Workbenches=[[Workbench Name|Workbench]] |
||
|Shortcut=<!--delete this row if not used--> |
|Shortcut={{KEY|F}} {{KEY|C}} <!--delete this row if not used--> |
||
|SeeAlso=<!--add links to similar commands; delete this row if not used--> |
|SeeAlso=<!--add links to similar commands; delete this row if not used--> |
||
|Version=0.17 |
|Version=0.17 |
||
Line 17: | Line 17: | ||
==Description== <!--T:2--> |
==Description== <!--T:2--> |
||
<!--T:24--> |
|||
While the page is under construction, add the |
While the page is under construction, add the [[Template:UnfinishedDocu]] template at the top of the page by simply typing: '''<nowiki>{{UnfinishedDocu}}</nowiki>''' |
||
<!--T:13--> |
<!--T:13--> |
||
Insert here a short description of what the command does. |
Insert here a short description of what the command does. |
||
<!--T:29--> |
|||
Remember to use [[Template:Version]], [[Template:VersionMinus]], [[Template:VersionPlus]] and [[Template:Obsolete]] when applicable. |
|||
<!--T:30--> |
|||
For example: The feature to utilize {{incode|App::Link}} {{Version|0.19}} allows linking between sub-assemblies etc... |
|||
<!--T:16--> |
<!--T:16--> |
||
Line 30: | Line 37: | ||
{{Caption|Optional: add a caption below the image to explain what the tool is doing.}} |
{{Caption|Optional: add a caption below the image to explain what the tool is doing.}} |
||
<!--T:25--> |
|||
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. |
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== <!--T:3--> |
||
<!--T:4--> |
<!--T:4--> |
||
# 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) |
||
# Detailed steps as needed. |
|||
#* 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}}. |
# Set options and press {{Button|OK}}. |
||
Line 42: | Line 55: | ||
<!--T:18--> |
<!--T:18--> |
||
* List the command options here. Check out two examples, [[Draft Line]] and [[PartDesign Pad]]. |
* List the command options here. Check out two examples, {{Button|[[Image:Draft_Line.svg|16px]] [[Draft Line|Draft Line]]}} and {{Button|[[Image:PartDesign_Pad.svg|16px]] [[PartDesign Pad|PartDesign Pad]]}}. |
||
==Properties== <!--T:6--> |
==Properties== <!--T:6--> |
||
Line 61: | Line 74: | ||
==Scripting== <!--T:8--> |
==Scripting== <!--T:8--> |
||
<!--T:26--> |
|||
{{Emphasis|See also:}} [[:Category:API]] and [[FreeCAD Scripting Basics]]. |
{{Emphasis|See also:}} [[:Category:API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]]. |
||
<!--T:9--> |
<!--T:9--> |
||
The ExampleCommandModel tool can be used in [[macros]] and from the [[Python]] console by using the following function: |
The ExampleCommandModel tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following function: |
||
</translate> |
</translate> |
||
{{Code|code= |
{{Code|code= |
||
Line 70: | Line 85: | ||
}} |
}} |
||
<translate> |
<translate> |
||
<!--T:10--> |
<!--T:10--> |
||
* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}. |
* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}. |
||
Line 75: | Line 91: | ||
<!--T:11--> |
<!--T:11--> |
||
Example: |
Example: |
||
</translate> |
</translate> |
||
{{Code|code= |
{{Code|code= |
||
Line 91: | Line 108: | ||
</translate> |
</translate> |
||
{{clear}} |
{{clear}} |
||
<translate> |
|||
==Selectable block== |
==Selectable block== <!--T:28--> |
||
</translate> |
|||
<nowiki> |
<nowiki> |
||
{{UnfinishedDocu}} |
{{UnfinishedDocu}} |
||
<translate> |
|||
{{GuiCommand |
{{GuiCommand |
||
|Name=Base ExampleCommandModel |
|Name=Base ExampleCommandModel |
||
Line 101: | Line 122: | ||
|MenuLocation=Menu → Submenu → Command |
|MenuLocation=Menu → Submenu → Command |
||
|Workbenches=[[Workbench Name|Workbench]] |
|Workbenches=[[Workbench Name|Workbench]] |
||
|Shortcut=<!--delete this row if not used--> |
|Shortcut={{KEY|F}} {{KEY|C}} <!--delete this row if not used--> |
||
|SeeAlso=<!--add links to similar commands; delete this row if not used--> |
|SeeAlso=<!--add links to similar commands; delete this row if not used--> |
||
|Version=0.17 |
|Version=0.17 |
||
Line 113: | Line 134: | ||
</translate> |
</translate> |
||
[[ |
[[Image:Draft_Line_example.jpg|none|400px]] |
||
<translate> |
<translate> |
||
Line 120: | Line 141: | ||
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. |
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) |
||
# Detailed steps as needed. |
|||
#* 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}}. |
# Set options and press {{Button|OK}}. |
||
Line 145: | Line 171: | ||
==Scripting== |
==Scripting== |
||
{{Emphasis|See also:}} [[:Category:API]] and [[FreeCAD Scripting Basics]]. |
{{Emphasis|See also:}} [[:Category:API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]]. |
||
⚫ | |||
⚫ | |||
</translate> |
</translate> |
||
{{Code|code= |
{{Code|code= |
||
Line 153: | Line 180: | ||
}} |
}} |
||
<translate> |
<translate> |
||
* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}. |
* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}. |
||
Example: |
Example: |
||
</translate> |
</translate> |
||
{{Code|code= |
{{Code|code= |
||
Line 171: | Line 200: | ||
Optional |
Optional |
||
</translate> |
|||
</nowiki> |
</nowiki> |
||
<translate> |
|||
<!--T:27--> |
|||
[[Category:Wiki:Example]] |
[[Category:Wiki:Example]] |
||
</translate> |
Revision as of 00:33, 24 February 2020
Base ExampleCommandModel |
Menu location |
---|
Menu → Submenu → Command |
Workbenches |
Workbench |
Default shortcut |
F C |
Introduced in version |
0.17 |
See also |
None |
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:
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 File: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 → File:Std Close.png Command name
- Detailed steps as needed. Some steps may need Keyboard presses while others may require using the mouse to click on a Button
- Other commands may need to be referenced/used. Consider linking to their wiki pages along with their icons Draft Line or PartDesign Pad
- Set options and press OK.
Options
- List the command options here. Check out two examples, Draft Line and PartDesign Pad.
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
usingData1
andData2
.
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>