Skip to content

Latest commit

 

History

History
215 lines (125 loc) · 8.69 KB

GuiCommand_model.md

File metadata and controls

215 lines (125 loc) · 8.69 KB
Error in user YAML: (<unknown>): mapping values are not allowed in this context at line 3 column 8
---
- GuiCommand:
   Name:Base ExampleCommandModel
   Icon: 
   MenuLocation:Menu → Submenu → Menu text for the command
   Workbenches:[Workbench](Workbench_Name.md)
   Shortcut:**F** **C**
   Version:0.19
   SeeAlso: 
---

GuiCommand model/pt-br

Description

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

In this first paragraph give a short description of what the command does. The description can refer to other workbenches such as the Sketcher Workbench. (Editor note: The image is 24px, not 16px)

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

For example: The feature to utilize App::Link (v0.19) allows linking between sub-assemblies etc...

Add an image if possible, and please follow the guidelines in WikiPages#Graphics. Example taken from Part Sweep: Optional: add a caption below the image to explain what the tool does

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:
    • Press the Base ExampleCommandModel button. (Editor note: This uses the Template:Button template, it is necessary to link to the command as shown in this example)
    • Select the Menu → Submenu → Menu text for the command option from the menu. (Editor note: This uses the Template:MenuCommand template)
    • Select the Submenu → Menu text for the command option from the Tree view context menu or 3D view context menu. (Editor note: This also uses the Template:MenuCommand template, not all commands can be accessed from a context menu)
    • Use the keyboard shortcut F then C or Ctrl+Z. (Editor note: This uses the Template:KEY template, not all commands have a keyboard shortcut)
  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 or PartDesign Pad.
  4. Set options and press OK.

Options

Example

Optional.

Notes

  • Optional. Use a bullet list if there are multiple items. You can also mention limitations here.

Properties

Data

{{TitleProperty|Property Group}}

  • Property Name 1: Description of the property

View

{{TitleProperty|Property Group}}

  • Property Name 2: Description of the property

Scripting

See also: : 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)

Other

Optional.

Selectable block

{{GuiCommand |Name=Base ExampleCommandModel |Icon=  |MenuLocation=Menu → Submenu → Menu text for the command |Workbenches=Workbench |Shortcut=F C |Version=0.19 |SeeAlso=  }}

== Description ==

While the page is under construction, add the [[Template:UnfinishedDocu]] template at the top of the page by simply typing: ''''''

In this first paragraph give a short description of what the command does. The description can refer to other workbenches such as the  Sketcher Workbench. (''Editor note:'' The image is 24px, not 16px)

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

For example: The feature to utilize App::Link (v0.19)  allows linking between sub-assemblies etc...

Add an image if possible, and please follow the guidelines in Part Sweep:

Optional: add a caption below the image to explain what the tool does

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:  #* Press the  Base ExampleCommandModel button. (''Editor note:'' This uses the [[Template:Button]] template, it is necessary to link to the command as shown in this example) #* Select the Menu → Submenu →  Menu text for the command option from the menu. (''Editor note:'' This uses the [[Template:MenuCommand]] template) #* Select the Submenu →  Menu text for the command option from the Tree view context menu or 3D view context menu. (''Editor note:'' This also uses the [[Template:MenuCommand]] template, not all commands can be accessed from a context menu) #* Use the keyboard shortcut F then C or Ctrl+Z. (''Editor note:'' This uses the [[Template:KEY]] template, not all commands have a keyboard shortcut) # 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 ==

* Optional. List the command options here. Check out two examples,  Draft Line and  PartDesign Pad.

== Example ==

Optional.

== Notes ==

* Optional. Use a bullet list if there are multiple items. You can also mention limitations here.

== Properties ==

=== Data ===

{{TitleProperty|Property Group}}

* Property Name 1: Description of the property

=== View ===

{{TitleProperty|Property Group}}

* Property Name 2: Description of the property

== Scripting ==

See also: [FreeCAD Scripting Basics](: API]] and [[FreeCAD_Scripting_Basics.md).

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

```python Object = makeExampleCommandModel(Data1, Data2) ```

* Creates an Object using Data1 and Data2.

Example:

```python import FreeCAD, Base

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

<translate>

== Other ==

Optional.




</translate>
{{Workbench Tools navi}} 






{{Workbench Tools navi

}} 

[<img src="images/Property.png" style="width:16px"> Wiki:Example](<img src="images/Property.png" style="width:16px"> Wiki_Example.md)

---
[documentation index](../README.md) > [API]] and ](Category_API]] and .md) > GuiCommand model/pt-br