Gui Command

From FreeCAD Documentation
Revision as of 23:55, 5 April 2011 by Splineman (talk | contribs) (Created page with 'Los comandos de la interfaz gráfica de usuario (GuiCommand) son una de las funciones más importantes de FreeCAD en el principal punto de interacción del usuario. Cada vez que …')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Los comandos de la interfaz gráfica de usuario (GuiCommand) son una de las funciones más importantes de FreeCAD en el principal punto de interacción del usuario. Cada vez que el usuario selecciona un elemento del menú o presiona un botón de una barra de herramientas se activa un comando de la interfaz gráfica de usuario. Alguno de los atributos de un comandos de la interfaz gráfica de usuario (GuiCommand) son:

  • Define un nombre
  • Contiene un icono
  • Define el alcance para deshacer/rehacer
  • Tiene una página de ayuda
  • Abre y controla letreros de diálogo
  • Grabación de macros
  • etc...

Denominación

Los comandos de la interfaz gráfica de usuario se denominan de cierta forma: ModuleName_CommandName Por ejemplo "Base_Open" este es el comandos de la interfaz gráfica de usuario en el sistema base. Los comandos de la interfaz gráfica de usuario en un módulo determinado se denominan con el nombre del módulo como prefijo. Por ejemplo "Part_Cylinder".

Página de ayuda

Todos los comandos de la interfaz gráfica de usuario deben tener una página de ayuda. La página de ayuda está alojada en la wiki de documentación de FreeCAD. El artículo tiene el mismo nombre que el comando de la interfaz gráfica de usuario. Por ejemplo Std_ViewScreenShot.

Para crear tus propias páginas de ayuda puedes utilizar la plantilla: GuiCommand model

Ejemplo:

Iconos

Tango-Palette.png

Todos los comandos de la interfaz gráfica de usuario deben tener un icono. We use the 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.

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

Available translations of this page: Flag-ru.jpg