API GUI Commands

For background information about the commands described on this page, refer to the information about user interface configuration in the corresponding section of the API reference. Alternatively, you can use user interface extension to control some aspects of the user interface.

On this page, API commands of the graphical user interface category are described. This category covers all commands to configure the uDraw(Graph) user interface by adding dialog elements (i.e. menus and icons) that are exclusively used by the application. The commands of this category are enclosed by keyword "gui(...)". They are only available when command-line option -nogui has been used. Click here to get an overview of all API commands.

gui(configure(filename))

To configure the user interface of a new, unconfigured context using the configuration file "filename". The suffix ".menu" is automatically added behind "filename". The file has to be in the current working directory, in directory "$UDG_HOME/lib/uDrawGraph" or anywhere when an absolute filename is used. For each context (see multi-graph mode), this command can only be used once, because it is not possible to reconfigure the user interface of an already open base window. When uDraw(Graph) is started with command-line option -nogui, no initial base window will appear as long as this command or command window(deiconify) have not been used. The same is true for each subsequent context opened afterwards. So with option "-nogui", you have to configure the user interface for any new context before you can see the first base window. This way it is possible to switch the user interface with every context. More details are available in the user interface configuration guide.

Note: Windows^® users please use "/" (slash) instead of "\" (backslash) as a directory separator.

gui(activate_menus(menu_ids))

To activate the application menu entries specified by "menu_ids", so it is possible to select them with the mouse. All the other entries previously defined in the configuration file and not member of list "menu_ids" are automatically deactivated at the same time, so they cannot be selected by the user. In other words, the application only has to enable the menus that should be available at a time without deactivating the other ones. The built-in menu entries of uDraw(Graph) cannot be activated using the API. More details are available in the user interface configuration guide.

gui(set_radio_menus(menu_ids))

To select the specified "menu_ids" in a radio menu. A radio menu is a group of menu entries where only one entry of a group can be selected at a time, either by the user or by the application using this command. The menu IDs in the parameter must exclusively belong to radio menus. Make sure that only one entry of a radio menu is used here at a time. More details are available in the user interface configuration guide.

gui(activate_icons(icon_ids))

To activate the application icon entries specified by "icon_ids", so it is possible to select them with the mouse. All the other entries previously defined in the configuration file and not member of list "icon_ids" are automatically deactivated at the same time, so they cannot be selected by the user. In other words, the application only has to enable the icons that should be available at a time without deactivating the other ones. The built-in icon entries of uDraw(Graph) cannot be activated using the API. More details are available in the user interface configuration guide.

gui(set_radio_icons(icon_ids))

To select the specified "icon_ids" in a radio icon. A radio icon is a group of icon entries where only one entry of a group can be selected at a time, either by the user or by the application using this command. The icon IDs in the parameter must exclusively belong to radio icons. Make sure that only one entry of a radio icon is used here at a time. More details are available in the user interface configuration guide.