Gui Command

From FreeCAD Documentation
Revision as of 18:09, 4 March 2019 by FuzzyBot (talk | contribs) (Updating to match new version of source page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Other languages:
čeština • ‎English • ‎español • ‎français • ‎italiano • ‎português • ‎română • ‎русский • ‎svenska

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 comando Abrir 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".

Si la documentación no está terminada utiliza la plantilla Template:UnfinishedDocu

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 Draft ShapeString.

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

Iconos

Tango-Palette.png

Todos los comandos de la interfaz gráfica de usuario deben tener un icono. Utilizamos la Colección de iconos Tango y sus recomendaciones. A la derecha puedes ver la paleta de colores del proyecto Tango.

Preferiblemente todos los iconos serán dibujados en formato de Gráficos Vectoriales Escalables (SVG) por ejemplo con Inkscape. Esto hace que sea más sencillo aplicar cambios y crear iconos adicionales similares en el mismo espacio de la aplicación.

Icons color coding chart

Colorchart.png

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

Requerimientos de Calidad

Existen muchos comandos de la interfaz gráfica de usuario (operaciones) en FreeCAD que son experimentales o utilizados brevemente con propósitos de implementación. Estos comandos de la interfaz gráfica de usuario están la mayoría en los entornos de trabajo dedicados como los de Piezas, Mallas o Mecanizado (CAM). Para asegurar una buena experiencia al usuario se ha creado el entorno de trabajo Completo. Este es el entorno de trabajo de inicio por defecto de FreeCAD e incorpora todos los comandos de la interfaz gráfica de usuario que cumplan con ciertos Requerimientos de Calidad los cuales se describen aquí:

There are a lot of GuiCommands (tools) in FreeCAD which are experimental or used for a short time to test implementation of new features. 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 workbench incorporates all GuiCommands which meet certain quality requirements which are described here:

  • El comando/operación debe estar terminado. No en desarrollo!
  • Debe tener una página de ayuda como esta
    • Todos los campos de la plantilla Template:GuiCommand deben estar cubiertos
    • Una imagen de los letreros de diálogo que el comando eventualmente muestra
    • Descripción detallada del comando y de todos sus parámetros y configuración
    • Descripción de las interfaces de Python relacionadas y las clases con código de ejemplo
  • Definir un icono apropiado y la posición en los menús

Se espera que esto sea cierto para todos los comandos de la interfaz gráfica de usuario en la Lista de comandos.