Gui Command

From FreeCAD Documentation
Revision as of 09:34, 28 February 2019 by FuzzyBot (talk | contribs) (Updating to match new version of source page)

GuiCommand - одна из наиболее важных функций FreeCAD при взаимодействии с пользователем. Каждый раз, когда пользователь выбирает опцию в меню или нажимает на кнопку панели инструментов, активируется GuiCommand. Некоторые из атрибутов GuiCommand:

  • Задано имя
  • Содержит иконку
  • Определена возможности для отмены/повтора
  • Есть страница справки
  • Открывает и управляет диалогами
  • Записывается в макрос
  • и.т.д...

Назначение имен

GuiCommand именуются определенным образом: ИмяМодуля_ИмяКоманды т.е. "Base_Open" это команда Открыть(Open) графического интерфейса в Base (базовой системе). GuiCommand в определенном модуле получает имя имя модуля впереди, например "Part_Cylinder".

Если документ не закончен (в смысле wiki статья) используйте шаблон Template:UnfinishedDocu

Страница справки

Каждая GuiCommand должна обладать страницей справки. Страница справки должна располагаться в FreeCAD wiki. Статья имеет то же имя, что и GuiCommand, например, Draft ShapeString.

Чтобы создать ваши собственные справочные страницы используйте шаблон: GuiCommand model

Примеры:

Иконки

Каждая GuiCommand-а должна иметь иконку. Мы используем Tango набор иконок и его принципы. Справа вы можете видеть палитру цветов tango.

Предпочтительней всех, иконки нарисованные в SVG , например с помощью Inkscape. Это упрощает добавление изменений и получение дополнительных Иконок в том же пространстве приложения.

диаграмма цветового кодирования иконок

Мы стараемся насколько возможно следовать этой диаграмме, так что цвета иконок имеют прямое значение.

Требования к качеству

Существует множество GuiCommands (Особенностей/Фишек) в FreeCAD которые являются экспериментальными или используются недолгое время для реализации целей. Эти GuiCommands в основном помещаются в инструментарии, такие как Part, Mesh или Cam. Для обеспечения хорошей работы пользователя, был созданПолный(Complete) инструментарий. Это инструментарий, который запускается по умолчанию при старте FreeCAD и он включает в себя все GuiCommand-ы, отвечающие Требованиям к качеству ,описанным здесь:

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:

  • Команда/Функция должна быть законченой. Никаких незавершенных работ!
  • Должен иметь справочную страницу как эта
    • Все поля Template:GuiCommand должны быть заполнены
    • Картинки с изображением диологов команды и конечный вывод
    • детальное описание команды и всех её параметров и настроек
    • Описание связанных python интерфесов и классов с примерами кода
  • Настройка надлежащей иконки и позиции в меню

Надеюсь, что так будет со всеми GuiCommands из Списка команд.