GuiCommand model

From FreeCAD Documentation
Revision as of 09:20, 24 November 2018 by FuzzyBot (talk | contribs) (Updating to match new version of source page)
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

poziția meniului
Sample → Command
Ateliere
scurtătură
nici unul
Prezentat în versiune
-
A se vedea, de asemenea,
nici unul

Descriere

Insert here a short description of what the command does.

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

Optional: add a caption in italics below the image.

Cum se folosește

  1. Apăsați butonul File:Std Close.png Command name.
  2. Detalierea pașilor este necesară.
  3. Definiți opțiunile și apăsați OK.

Opțiuni

Create Geometry

{{TitleTasks|[[Image:Icon.png|24]] + Text}} (Code for the main title Tasks)
  • TASK Tasks : Tasks
{{PropertyTasks|Tasks}} (Code of title Tasks)
  • Options

Proprietăți

Base

{{TitleProperty|Base}}  (Code for the main title Properties)
  • DateProperties: Properties
{{PropertyData|Properties}} (Code of title Data)
  • VizualizareProperties: Properties
{{PropertyView|Properties}} (Code of title View)

Data

  • DatePropertyName1: Description of the property

View

  • VizualizarePropertyName2: Description of the property

Exemplu

Opțional

Scrip-Programare

Instrumentul ExampleCommandModel poate fi utilizat în macros și din consola python utilizând următoarea funcție:

makeExampleCommandModel(Data, Data)
  • Creează un CommandModel folosind Data.
  • Returnează obiectul nou creat.

Exempluː

import FreeCAD, Base
Base.makeExampleCommandModel(FreeCAD.Data,FreeCAD.Data)

Limitations

  • Optional, use bullet list if multiple items

Other

Optional

Selectable block

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

==Description==

Insert here a short description of what the command does.

</translate>
[[File:Draft_Line_example.jpg|none|400px]]
<translate>
''Optional: add a caption in italics.''

==How to use==

# Press the {{KEY|[[File:Std Close.png|24px]] '''Command name'''}} button.
# Detailed steps as needed.
# Set options and press {{KEY|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==

The ExampleCommandModel tool can be used in [[macros]] and from the python console by using the following function:
</translate>
 '''makeExampleCommandModel(Data, Data)'''
<translate>
* Creates a CommandModel using Data.
* Returns the newly created object.

Example:
</translate>
 import FreeCAD, Base
 Base.makeExampleCommandModel(FreeCAD.Data,FreeCAD.Data)
<translate>

==Limitations==

* Optional, use bullet list if multiple items

==Other==

Optional