Modèle GuiCommand

From FreeCAD Documentation
Jump to: navigation, search
This page is a translated version of the page GuiCommand model and the translation is 100% complete.

Other languages:
English • ‎español • ‎français • ‎italiano • ‎română • ‎русский
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.


Base ExampleCommandModel.png Modèle GuiCommand

Emplacement du menu
Menu → Submenu → Commande
Ateliers
Nom de l'atelier
Raccourci par défaut
F C
Introduit dans la version
0.17
Voir aussi


Description

tant que la page est en construction, ajouter le template Template:UnfinishedDocu en haut de la page le modèle en mettant le code {{UnfinishedDocu}}.

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

N'oubliez pas d'utiliser Template:Version/fr, Template:VersionMinus/fr, Template:VersionPlus/fr et Template:Obsolete/fr le cas échéant.

Par exemple: La fonctionnalité pour utiliser App::Link Introduit dans la version 0.19 permet la liaison entre les sous-ensembles, etc....

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

Draft Line example.jpg

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.

Utilisation

  1. Il existe plusieurs façons d'appeler la commande:
  2. * Le bouton Std Close.png Nom de la commande dans la barre d'outils (Note de l'éditeur: L'utilisation du modèle Template:Button, est nécessaire de lier la commande comme indiqué dans cet exemple)
  3. * Utilisation de Menu → Sous-menu → Commande dans le menu supérieur. (Note de l'éditeur: Ceci utilise le modèle wiki Template:MenuCommand)
  4. * Utilisez le raccourci clavier F puis C ou Ctrl + Z (Note de l'éditeur: Ceci utilise le Template:KEY modèle wiki)
  5. * (Facultatif) Menu contextuel RMB (bouton droit de la souris): RMB → Std Close.png Nom de la commande
  6. Étapes détaillées selon les besoins. Certaines étapes peuvent nécessiter des pressions sur Keyboard tandis que d'autres peuvent nécessiter l'utilisation de la souris pour cliquer sur un Button
  7. D'autres commandes peuvent devoir être référencées/utilisées. Pensez à créer un lien vers leurs pages wiki avec leurs icônes Draft Line.svg Draft Line ou PartDesign Pad.png PartDesign Pad
  8. Définissez les options et appuyez sur OK.

Options

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/fr 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


Bloc sélectionnable

{{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.png|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>