Gui Command/fr: Difference between revisions
(Updating to match new version of source page) |
No edit summary |
||
(64 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
{{TOCright}} |
|||
Une '''GuiCommand''', est l'une des fonctions les plus importantes du point de vue interaction entre l'utilisateur et '''FreeCAD'''. |
|||
⚫ | |||
Quelques-uns des attributs d'un '''GuiCommand''' sont les suivants : |
|||
⚫ | |||
* Définir un nom |
* Définir un nom |
||
* Contenir une icône |
* Contenir une icône |
||
* Définir l'action annuler/rétablir |
* Définir l'action annuler/rétablir |
||
* |
* Aller à une page d'aide |
||
* |
* Ouvrir et contrôler des boîtes de dialogues |
||
* Enregistrer une macro |
|||
* Enregistrement de macros |
|||
* et ainsi de suite ... |
* et ainsi de suite ... |
||
<span id="Naming"></span> |
|||
== Nommage == |
|||
La |
La GuiCommand est appelée selon un certain standard : ''ModuleName_CommandName'', par exemple "[[Base_Open/fr|Base Open]]" est la Gui Command Open dans le système Base. Dans certains modules, la GuiCommand a pour préfixe le nom du module, comme par exemple "[[Part_Cylinder|Part_Cylinder]]". |
||
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 [[ |
Si le document n'est pas fini, utilisez le bandeau [[Template:UnfinishedDocu]]. |
||
<span id="Help_page"></span> |
|||
== Pages d'aide == |
|||
Chaque |
Chaque GuiCommand doit avoir une page d'aide. La page d'aide est hébergée sur le wiki de documentation FreeCAD. L'article porte le même nom que la GuiCommand, par exemple [[Draft_ShapeString/fr|Draft Forme à partir d'un texte]]. |
||
L'article porte le même nom que le '''GuiCommand''', par exemple [[Std ViewScreenShot/fr|Std ViewScreenShot]]. |
|||
Pour créer vos propres pages d'aide vous pouvez utiliser le |
Pour créer vos propres pages d'aide vous pouvez utiliser le [[GuiCommand_model/fr|modèle GuiCommand]]. |
||
Exemples : |
Exemples : |
||
* [[ |
* [[Draft_ShapeString/fr|Draft Forme à partir d'un texte]] |
||
* [[ |
* [[Draft_Line/fr|Draft Ligne]] |
||
<span id="Icons"></span> |
|||
⚫ | |||
⚫ | |||
[[Image:Tango-Palette.png|400px|right]] |
[[Image:Tango-Palette.png|400px|right]] |
||
Chaque |
Chaque GuiCommand doit avoir une icône. Nous utilisons le [http://tango-project.org/Tango_Desktop_Project jeu d'icônes Tango], et ses recommandations. Sur le côté droit, vous voyez la palette de couleurs tango. |
||
Sur le côté droit, vous voyez la palette de couleurs tango. |
|||
Il est conseillé de faire toutes les icônes |
Il est conseillé de faire toutes les icônes au format [[SVG/fr|SVG]], par exemple avec [http://inkscape.org/?lang=fr&css=css/base.css Inkscape]. Cela rend plus facile l’application des changements et des icônes dérivés dans l'espace de la même 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. |
|||
<span id="Icons_color_coding_chart"></span> |
|||
Avec [http://www.gimp.org/ Gimp], vous pouvez y accéder : |
|||
===Code des couleurs des icônes=== |
|||
* à 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 {{KEY|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''' |
|||
[[Image:Colorchart.png|200px]] |
[[Image:Colorchart.png|200px]] |
||
Nous essayons autant que possible de respecter ce tableau, |
Nous essayons autant que possible de respecter ce tableau, la couleur des icônes a donc une signification directe. |
||
=== 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_Module/fr|Part]], [[Mesh_Module/fr|Mesh]] ou [[Path_Workbench/fr|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 [[Draft ShapeString/fr|celle-ci]] |
|||
** Tous les champs de modèle : '''[[GuiCommand_model/fr|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 [[List_of_Commands/fr|liste des commandes]]. |
|||
[[Category:User Documentation/fr]] |
|||
[[Category:Command_Reference/fr]] |
|||
{{Powerdocnavi{{#translation:}}}} |
|||
{{clear}} |
Latest revision as of 11:00, 1 November 2023
La 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. Certains des attributs d'une GuiCommand sont :
- Définir un nom
- Contenir une icône
- Définir l'action annuler/rétablir
- Aller à une page d'aide
- Ouvrir et contrôler des boîtes de dialogues
- Enregistrer une macro
- et ainsi de suite ...
Nommage
La GuiCommand est appelée selon un certain standard : ModuleName_CommandName, par exemple "Base Open" est la Gui Command Open dans le système Base. Dans certains modules, la GuiCommand a pour préfixe 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 wiki de documentation FreeCAD. L'article porte le même nom que la GuiCommand, par exemple Draft Forme à partir d'un texte.
Pour créer vos propres pages d'aide vous pouvez utiliser le modèle GuiCommand.
Exemples :
Icônes
Chaque GuiCommand doit avoir une icône. Nous utilisons le jeu d'icônes Tango, et ses recommandations. Sur le côté droit, vous voyez la palette de couleurs tango.
Il est conseillé de faire toutes les icônes au format SVG, par exemple avec Inkscape. Cela rend plus facile l’application des changements et des icônes dérivés dans l'espace de la même application.
Code des couleurs des icônes
Nous essayons autant que possible de respecter ce tableau, la couleur des icônes a donc une signification directe.
- Scripts FreeCAD : Python, Introduction à Python, Tutoriel sur les scripts Python, Débuter avec les scripts
- Modules : Modules intégrés, Unités, Quantity
- Ateliers : Création d'atelier, Commands Gui, Les commandes, Installer des ateliers supplémentaires
- Maillages et objets Parts : Scripts Mesh, Script de données topologiques, Conversion objet Mesh en Part, PythonOCC
- Objets paramétriques : Objets créés par script, Viewproviders (Icône personnalisée dans l'arborescence)
- Scénographie : Graphe de scène Coin (Inventor), Pivy
- Interface graphique : Création d'interface, Création d'une boite de dialogue (1, 2, 3, 4, 5), PySide, Exemples PySide débutant, intermédiaire, expérimenté
- Macros : Macros, Comment installer des macros
- Intégration : Intégrer FreeCAD, Intégration de FreeCADGui
- Autre : Expressions, Extraits de codes, Fonction - tracer une ligne, Bibliothèque mathématique vectorielle de FreeCAD (déprécié)