Comandi dell'interfaccia grafica
Comandi dell'interfaccia grafica dell'utente
I comandi dell'interfaccia grafica dell'utente (GuiCommand) sono una delle più importanti funzioni di FreeCAD e 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...
_
_
Denominazione - Nome del comando
Il Comando Gui è denominato nel modo: ModuleName_CommandName.
Per esempio "Base_Open" è, nell'interfaccia grafica, il comando Apri nel sistema Base.
I comandi della Gui in un modulo specifico sono denominati con il nome del modulo come prefissso. Ad esempio: "Part_Cylinder".
Se la sua documentazione non è completa viene visualizzata la maschera di 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 deell'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.
Produrre preferiblemente tutte le icone in formato Grafico Vettoriale Scalabile (SVG) per esempio con Inkscape. Questo rende più facile applicare le modifiche e ricavare ulteriori icone nell'ambito della stessa applicazione.
Requisiti di qualità
In FreeCAD esistono diversi comandi dell'interfaccia grafica (Funzioni) che sono sperimentali o utilizzati raramente in attesa di implementazione. Questi comandi Gui si trovano per lo più negli ambienti specifici quali Parte, Mesh o Cam.
Per consentire all'utente una sperimentazione efficace si è creato un ambiente di lavoro definito Completo. Questo è l'ambiente di lavoro predefinito all'avvio di FreeCAD e incorpora tutte i comandi Gui che soddisfano determinati requisiti di qualità che sono descritti qui:
- Il comando/funzione è stato terminato. Nessun lavoro in corso!
- Ha una pagina di aiuto come Draft ShapeString
- Tutti i campi del modello Template:GuiCommand - Maschera di GuiCommand sono compilati
- Visualizza l'eventuale finestra di dialogo del comando
- Descrizione dettagliata del comando, di tutti i suoi parametri e delle impostazioni
- Descrizione delle interfacce e classi Python correlate con codici di esempio
- E' definita una icona appropriata e una posizione nel menu
Si spera che questo sia vero per tutti i comandi Gui della List of Commands - Lista dei comandi.
