Modèle GuiCommand

Cette page montre un modèle de page Gui Command. Sous la section Bloc sélectionnable ci-dessous, vous trouverez le même contenu que vous pouvez facilement sélectionner pour le coller dans une nouvelle page.

Modèle GuiCommand
Emplacement du menu
Menu → Submenu → Command
Ateliers
Workbench
Raccourci par défaut
Aucun
Introduit dans la version
0.17
Voir aussi
Aucun

Description

tant que la page est en construction, laissez le modèle {{UnfinishedDocu}} en haut de la page.

Insérez ici une brève description de ce que fait la commande.

Ajoutez une image si possible et suivez les instructions dans WikiPages#Graphics. Exemple tiré de Draft Line :

Facultatif : ajoutez une légende sous l'image pour expliquer le fonctionnement de l'outil.

La fermeture et l’ouverture des balises de traduction doivent entourer les images et d’autres éléments fixes, s’ils ne nécessitent pas de traduction. La légende doit toujours être traduite.

Comment l'utiliser

1. Pressez sur le bouton File:Std Close.png Nom de la commande. Le bouton doit être un lien vers cette commande.
2. Étapes détaillées au besoin.
3. Définissez les options et appuyez sur le bouton OK.

Options

• Énumérez les options de commande ici. Découvrez deux exemples, Draft Line/fr et PartDesign Pad/fr.

Propriétés

Données

• DonnéesPropertyName1 : Description de la propriété

Vue

• VuePropertyName2 : Description de la propriété

Exemple

Optionnel

Script

Voir aussi : Category:API et Débuter avec les scripts.

L'outil ExampleCommandModel peut être utilisé dans une macro et depuis la console Python en utilisant la fonction suivante :

Object = makeExampleCommandModel(Data1, Data2)

• Créer un Object utilisant Data1 et Data2.

Exemple :

import FreeCAD, Base

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

Limitations

• Facultativement, utilisez une liste à puces si plusieurs éléments

Autre

Optionnel

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=<!--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>
[[File: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.

==How to use==

# Press the {{Button|[[File:Std Close.png|16px]] [[GuiCommand model|Command name]]}} button. The button must be a link to this command.
# Detailed steps as needed.
# 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]].

The ExampleCommandModel tool can be used in [[macros]] and from the [[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>