Gui Command/fr: Difference between revisions
Renatorivo (talk | contribs) (Created page with "Il est conseillé de faire toutes les icônes en format SVG, par exemple avec [http://inkscape.org/?lang=fr&css=css/base.css Inkscape]. Cela rend plus facile l’application d...") |
No edit summary |
||
(76 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
⚫ | |||
Une '''GuiCommand''', est l'une des fonctions les plus importantes du point de vue interaction entre l'utilisateur et '''FreeCAD'''. |
|||
{{TOCright}} |
|||
⚫ | |||
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 certain module, 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> |
|||
'''icons color coding chart''' |
|||
===Code des couleurs des icônes=== |
|||
[[Image:Colorchart.png|200px]] |
[[Image:Colorchart.png|200px]] |
||
Nous essayons autant que possible de respecter ce tableau, la couleur des icônes a donc une signification directe. |
|||
=== Quality requirements === |
|||
There are a lot of GuiCommands (Features) in FreeCAD which are experimental |
|||
or used shortly for implementation purposes. These GuiCommands are mostly in |
|||
the dedicated workbenches like Part, Mesh or Cam. |
|||
To ensure a good user experience the workbench ''Complete'' was created. This |
|||
is the default start workbench of FreeCAD and incorporates all GuiCommands |
|||
which meet certain '''Quality requirements''' which are described here: |
|||
{{Powerdocnavi{{#translation:}}}} |
|||
* The Command/Feature has to be '''finished'''. No work in progress! |
|||
* Has to have a '''help page''' like [[Draft ShapeString]] |
|||
** All the fields in [[Template:GuiCommand]] have to filled in |
|||
** A picture of the dialogs the command eventually yield |
|||
** detailed description of the command and all its parameters and settings |
|||
** Description of the related python interfaces and classes with example code |
|||
* Set up a proper Icon and menu position |
|||
Hopefully this becomes true for all GuiCommands in the [[List of Commands]]. |
|||
[[Category:User Documentation]] |
|||
[[Category:Command_Reference]] |
|||
{{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é)