Функция добавляет новый присоединяемый модуль в GEDI.
Синтаксис
int moduleAddDockModule(string moduleName, string panelFile, [, dyn_string dollars] [, mapping options]);
Параметры
Параметр | Описание |
moduleName | Имя присоединяемого модуля. |
panelFile | Панель, которая должна быть открыта в присоединяемом модуле, например, console.pnl . |
dollars | Передаваемые $-параметры. |
options | Доступны следующие ключи:«area»(string): месторасположение присоединяемого модуля: LeftDockWidgetArea, RightDockWidgetArea, TopDockWidgetArea, BottomDockWidgetArea. Значение по умолчанию: RightDockWidgetArea«allowedAreas»(string): допустимая область перемещения присоединяемого модуля. При указании допустимой области перемещения могут использоваться ключи для области «area» (см. выше), а также: AllDockWidgetAreas, NoDockWidgetArea. Возможно использование нескольких значений, перечисляемых с применением разделителя «|», например, «LeftDockWidgetArea|RightDockWidgetArea». Значение по умолчанию: AllDockWidgetAreas«features»(string): Комбинация ключей: DockWidgetClosable, DockWidgetMovable, DockWidgetFloatable, DockWidgetVerticalTitleBar AllDockWidgetFeatures, NoDockWidgetFeatures Значение по умолчанию: DockWidgetClosable|DockWidgetMovable|DockWidgetFloatable«tabifyWith»(string): имя другого [ранее созданного] присоединяемого модуля, который будет находиться в одном окне рядом с создаваемым модулем (на соседней вкладке).«floating»(bool): при значении, равном «true», присоединяемый модуль может перемещаться над основным модулем без присоединения к основному модулю, то есть модуль представляет собой окно, независимое от родительского окна. Значение по умолчанию: false (активирована привязка к родительскому окну)В том случае, если основной модуль был открыт на позиции (-2, -2), позиция и состояние присоединяемого модуля (закрыт/открыт, активация привязки к родительскому окну и т.д.) сохраняются в файле PVSS00ui.ini (директория в ОС Windows — …\Users\<User>\AppData\Roaming\Sybcom\) .Сохраненные настройки автоматически применяются при следующем создании в рамках основного модуля нового присоединяемого модуля с ранее использовавшимся именем. Подобные настройки сохраняются в области настроек основного модуля.В качестве заголовка присоединяемого модуля используется имя текущей панели, заданное в GEDI для соответствующего языка.При следующем вызове функции moduleAddDockModule() с указанием в качестве аргумента ранее использовавшегося имени присоединяемого модуля, заданные настройки, включая имя панели, применяются к создаваемому модулю. |
Возвращаемое значение
Идентификатор добавленного присоединяемого модуля. |
Ошибки
Пропущенные или неверные аргументы. |
Описание
Функция добавляет новый присоединяемый модуль в GEDI или VISION. При необходимости добавления присоединяемого модуля в редакторе GEDI, сценарий должен находиться в директории путь_КАСКАД [или <путь_проекта>]/scripts/gedi и должен именоваться как <имя>_ext.ctl . При запуске редактора GEDI загружаются все сценарии из данной директории. |
ПРИМЕР В приведенном ниже примере в модуле GEDI добавляется присоединяемый модуль «MyDock», содержащий console.pnl .ПРИМЕЧАНИЕ В связи с тем, что в качестве аргумента должно использоваться новое имя присоединяемого модуля, для получения аргумента «moduleName» не следует использовать функцию myModuleName(). |
main() { moduleAddDockModule(«myDock», «projAdmin/console.pnl»); } |
Рисунок: Присоединяемый модуль, содержащий панель консоли |
Следующий пример демонстрирует создание нескольких модулей, находящихся на различных позициях.
- main(){ mapping oleft, oright, oright2, otop, obottom; //»area»(string): месторасположение модуля: LeftDockWidgetArea, RightDockWidgetArea, TopDockWidgetArea, BottomDockWidgetArea. Значение по умолчанию:
//RightDockWidgetArea oleft[«area»] = «LeftDockWidgetArea»; oright[«area»] = «RightDockWidgetArea»; otop[«area»] = «TopDockWidgetArea»; obottom[«area»] = «BottomDockWidgetArea»; //»allowedAreas»(string): допустимая область перемещения присоединяемого модуля. // Ключи: для области «area», а также: AllDockWidgetAreas, NoDockWidgetArea. Возможно использование нескольких значений,
// перечисляемых с применением разделителя «|», например, «LeftDockWidgetArea|RightDockWidgetArea». Значение по умолчанию: AllDockWidgetAreas oleft[«allowedAreas»] = «LeftDockWidgetArea»; // oright[«allowedAreas»] = «RightDockWidgetArea»; // otop[«allowedAreas»] = «TopDockWidgetArea»; // obottom[«allowedAreas»] = «BottomDockWidgetArea»; oright[«allowedAreas»] = «RightDockWidgetArea|TopDockWidgetArea»; otop[«allowedAreas»] = «AllDockWidgetAreas»; obottom[«allowedAreas»] = «NoDockWidgetArea»; // «features»(string): Комбинация ключей: DockWidgetClosable DockWidgetMovable DockWidgetFloatable DockWidgetVerticalTitleBar
// AllDockWidgetFeatures NoDockWidgetFeatures ( см. http://doc.qt.io/qt-5/qdockwidget.php#DockWidgetFeature-enum ) // Если не указано явно, то используется значение по умолчанию: DockWidgetClosable|DockWidgetMovable|DockWidgetFloatable oleft[«features»] = «DockWidgetClosable»; //oleft[«features»] = «DockWidgetMovable»; //oleft[«features»] = «DockWidgetFloatable»; //oleft[«features»] = «DockWidgetVerticalTitleBar»; oright[«features»] = «DockWidgetFloatable|DockWidgetVerticalTitleBar»; otop[«features»] = «AllDockWidgetFeatures»; obottom[«features»] = «NoDockWidgetFeatures»; // «tabifyWith»(string): имя другого [ранее созданного] присоединяемого модуля, // который будет находиться в одном окне рядом с создаваемым модулем (на соседней вкладке). //При значении, равном «true», присоединяемый модуль может перемещаться над основным модулем без присоединения к основному модулю.
//При этом модуль представляет собой окно, независимое от родительского окна. Значение по умолчанию: false (активирована привязка к родительскому окну) otop[«floating»] = «true»; // Добавление панелей в различные модули moduleAddDockModule(«left», «docksub1.pnl», makeDynString(«$a:hello»,»$b:hallo»), oleft); moduleAddDockModule(«right», «docksub2.pnl», makeDynString(«$a:hello»,»$b:hallo»), oright); moduleAddDockModule(«top», «docksub3.pnl», makeDynString(«$a:hello»,»$b:hallo»), otop); moduleAddDockModule(«bottom», «docksub4.pnl», makeDynString(«$a:hello»,»$b:hallo»), obottom); moduleAddDockModule(«right2», «docksub5.pnl», makeDynString(«$a:hello»,»$b:hallo»), oright2);}
Присвоение
Прочие функции |
Применение
Интерфейс пользователя |
См. также