Gui Command/fr: Difference between revisions

From FreeCAD Documentation
(Created page with "Exemples : * Draft ShapeString * Draft Line")
(Created page with "=== Icônes === 400px|right")
Line 29: Line 29:
* [[Draft Line/fr|Draft Line]]
* [[Draft Line/fr|Draft Line]]


=== Icons ===
=== Icônes ===
[[Image:Tango-Palette.png|400px|right]]
[[Image:Tango-Palette.png|400px|right]]



Revision as of 09:59, 30 March 2014

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 certain module, 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 wiki FreeCAD document. 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

Every GuiCommand has to have an icon. We use the Tango icon set and its guidelines. On the right side you see the tango color palette.

Preferable all Icons are drafted with SVG with e.g. Inkscape. This makes it easier to apply changes and derive additional Icons in the same application space.

icons color coding chart

We try as much as possible to respect this chart, so the color of the icons has a direct meaning.

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:

  • 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.