Comandi dell'interfaccia grafica

From FreeCAD Documentation
Revision as of 09:45, 30 March 2014 by Renatorivo (talk | contribs) (Created page with "Ogni comando dell'interfaccia grafica deve avere un'icona. Utilizziamo il [http://tango.freedesktop.org/Tango_Desktop_Project Set di icone Tango] e le sue linee guida. Sul lat...")

I comandi dell'interfaccia grafica dell'utente (GuiCommand) sono una delle funzioni più importanti di FreeCAD e sono il punto principale di interazione dell'utente. Ogni volta che l'utente seleziona una voce del menu o preme un pulsante si attiva un comando Gui. Alcuni degli attributi di un comando grafico sono:

  • Definisce un nome
  • Contiene una icona
  • Definisce la possibilità di annullare/ripetere
  • Ha una pagina di aiuto
  • Apre e controlla le finestre di dialogo
  • Registra macro
  • etc...

Nome del comando

Il Comando Gui è denominato nel modo: ModuleName_CommandName. Ad esempio, "Base_Open" nell'interfaccia grafica è il comando Open nel sistema Base. I comandi della Gui specifici di un modulo sono denominati con il nome del modulo come prefissso. Ad esempio: "Part_Cylinder".

Se la sua documentazione non è completa usare la maschera Template:UnfinishedDocu (en) - Documentazione incompleta (it).

Pagina di aiuto

Ogni GuiCommand deve avere una pagina di aiuto. La pagina di aiuto è ospitata sul wiki della documentazione di FreeCAD. L'articolo ha lo stesso nome del GuiCommand. Per esempio Draft ShapeString (in inglese) - Draft ShapeString (in it).

Per creare le proprie pagine di aiuto si può utilizzare il modello: GuiCommand model (en) - Modello di comando Gui (it)

Esempi in italiano:

Esempi in inglese:

Icone

Ogni comando dell'interfaccia grafica deve avere un'icona. Utilizziamo il Set di icone Tango e le sue linee guida. Sul lato destro si vede la tavolozza dei colori Tango.

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.