Une GuiCommand, est l'une des fonctions les plus importantes du point de vue interaction entre l'utilisateur et FreeCAD. Chaque fois que l'utilisateur sélectionne un élément du menu, ou appuie sur un bouton de la barre d'outils, il active une GuiCommand. Quelques-uns des attributs d'un GuiCommand sont les suivants :
- Définir un nom
- Contenir une icône
- Définir l'action annuler/rétablir
- Une page d'aide
- Ouvre et contrôle les boîtes de dialogues
- Enregistrement de macros
- et ainsi de suite ...
Nommage
La GuiCommand est appelée d'une certaine manière : ModuleName CommandName par exemple "Base Open", c'est l'Open Gui Command dans le système de base. Dans certains modules, la GuiCommand porte le nom du module, comme, par exemple "Part Cylinder".
Si le document n'est pas fini, utilisez le bandeau Template:UnfinishedDocu
Pages d'aide
Chaque GuiCommand doit avoir une page d'aide. La page d'aide est hébergée sur, le FreeCAD docu wiki. L'article porte le même nom que le GuiCommand, par exemple Std ViewScreenShot.
Pour créer vos propres pages d'aide vous pouvez utiliser le modèle de base : GuiCommand
Exemples :
Icônes
Chaque GuiCommand doit avoir une icône. Nous utilisons le jeu d'icônes Tango, et sa philosophie (guidelines). Sur le côté droit, vous voyez la palette de couleurs tango.
Il est conseillé de faire toutes les icônes en format SVG, par exemple avec Inkscape. Cela rend plus facile l’application des changements et d'en tirer des icônes supplémentaires dans l'espace même de l'application. Pour avoir accès à la palette Tango dans Inkscape, cliquez, sur la flèche, qui se trouve en bas, au niveau de la barre des couleurs, à l’extrême droite et, choisir "Tango icons" dans la liste offerte.
Avec Gimp, vous pouvez y accéder :
- à partir du menu : Image → Fenêtres → Fenêtres ancrables → Palettes → Tango Icon Theme.
- à partir de la fenêtre ancrable, en cliquant sur le petit bouton Configurer cet onglet, et en choisissant Ajouter un onglet → Palettes → Tango Icon Theme.
- Le fichier palette Tango.gpl se trouve dans C:\Program Files\GIMP 2\share\gimp\2.0\palettes
icons color coding chart
Nous essayons autant que possible de respecter ce tableau, de sorte que la couleur des icônes soit dans la même ligne.
Exigences de qualité
Il y a beaucoup de fonctions GuiCommands dans FreeCAD, certaines sont expérimentales ou utilisées à des fins provisoires ou en prévision. Ces GuiCommands sont pour la plupart dans les ateliers dédiés comme Part, Mesh ou Path. Pour assurer à l'utilisateur une utilisation facile, le workbench complet a été créé. C'est l'atelier de démarrage par défaut de FreeCAD, et, intègre toutes les GuiCommands qui satisfont aux exigences de qualité qui sont décrites ici :
- La commande/fonction doit être terminé. Pas un travail en cours !
- Doit avoir une page d'aide comme celle-ci
- Tous les champs de modèle : GuiCommand doivent remplir,
- Une image des boîtes de dialogue de la commande finalement,
- Donnent une description détaillée de la commande et de tous ses paramètres et réglages
- Description des interfaces connexes Python et des classes avec un exemple de code.
- Mettre en place une icône appropriée, et, sa position dans le menu.
Espérons que cela devienne vrai pour toutes les GuiCommands de la liste des commandes.