User Interface Description Reference

Root element to describe user interface. One element can be specified within the xvcd:vocabulary element. Optional. Within the element, describe the setting of the menu and toolbox corresponding to the vocabulary.

Attribute:

version (mandatory)

Sets the version number of the namespace for the user interface description. This must be 1.0.

Content:

Within the ui:ui element, be sure to describe it by combining one or more of the following elements:

• ui:main-menu Element
• ui:context-menu Element
• ui:tool-bar Element
• ui:accelerators Element
• ui:import Element
• ui:mount Element

Used to describe the content of a main menu.

Attribute:

No attributes for the element.

Content:

Within the ui:main-menu element, be sure to describe it by combining one or more of the following elements:

• ui:menu Element
• ui:menu-item Element
• ui:separator Element

Used to describe the content of a context menu.

Attribute:

No attributes for the element.

Content:

Within the ui:context-menu element, be sure to describe it by combining one or more of the following elements:

• ui:menu Element
• ui:menu-item Element
• ui:separator Element

Used to describe menu items which you select to display a sub-menu.

Attribute:

label

Specifies the label string to be displayed in a menu. It can be any string. However, as the strings beginning with # is internally reserved. To describe the strings beginning with #, describe beginning # as ## therefore:

Either the label attribute or the resource-key attribute is mandatory. If both of them are specified, the resource-key attribute takes precedence.

If omitted, the string specified in the resource-key attribute is used.

resource-key

Specifies the resource key of the string when retrieving the label string from the string resource, which is displayed in the menu. It can be any string.

Either the label attribute or the resource-key attribute is mandatory. If both of them are specified, the resource-key attribute takes precedence.

If omitted, the string specified in the label attribute is used.

mnemonic

Specifies mnemonic to be assigned to a menu. It can be any one single-byte character.

If omitted, a menu item without mnemonic is created.

icon

Specifies the icon to be displayed in a menu. It can be a URL string.

If omitted, a menu item without icon view is created.

Content:

Within the ui:menu element, be sure to describe it by combining one or more of the following elements:

• ui:menu Element
• ui:menu-item Element
• ui:separator Element

Used to describe menu items which you select to execute a command.

Attribute:

label

Specifies the label string to be displayed in a menu. It can be any string. However, as the strings beginning with # is internally reserved. To describe the strings beginning with #, describe beginning # as ## therefore:

Either the label attribute or the resource-key attribute is mandatory. If both of them are specified, the resource-key attribute takes precedence.

If omitted, the string specified in the resource-key attribute is used.

resource-key

Specifies the resource key of the string when retrieving the label string from the string resource, which is displayed in the menu. It can be any string.

Either the label attribute or the resource-key attribute is mandatory. If both of them are specified, the resource-key attribute takes precedence.

If omitted, the string specified in the label attribute is used.

command

Specifies the command to be executed when menu is selected. Specify the command name defined within the name attribute of the xvcd:command element or the command name provided by a platform.

If omitted, the command instruction column described within the element is executed. If both the command attribute and command instruction column are described at the same time, the specification within the command attribute takes precedence, and the command instruction column is ignored.

mnemonic

Specifies mnemonic to be assigned to a menu. It can be any one single-byte character.

If omitted, a menu item without mnemonic is created.

icon

Specifies the icon to be displayed in a menu. It can be a URL string.

If omitted, a menu item without icon view is created.

accelerator

Specifies the accelerator key to invoke a command by key operation during editing in the canvas. It can be a string. It is identified as follows. Items enclosed with [ ] are optional.

[Ctrl+][Alt+][Shift+] key

Ctrl+, Alt+, or Shift+ indicates that the key and the Ctrl, Alt, or Shift key, respectively, were pressed together. <key> is the string that identifies the character, function, or other key. It can be one of the characters or strings as listed below.

• For character key, numeric characters (0-9), or upper case characters (A-Z)
• For function or other keys:

Key name	String notation
Enter	ENTER
BackSpace	BACK_SPACE
Insert	INSERT
Delete	DELETE
Tab	TAB
Pause	PAUSE
CapsLock	CAPS_LOCK
Esc	ESCAPE
F1	F1
F2	F2
F3	F3
F4	F4
F5	F5
F6	F6
F7	F7
F8	F8
F9	F9
F10	F10
F11	F11
F12	F12
Space	SPACE
PageUp	PAGE_UP
PageDown	PAGE_DOWN
Home	HOME
End	END
Left Arrow	LEFT
Up Arrow	UP
Right Arrow	RIGHT
Down Arrow	DOWN
, (comma)	COMMA
. (period)	PERIOD
/ (slash)	SLASH

If omitted, a menu without an assigned accelerator key is created.

open-dialog

Specifies whether to display a dialog box which sets parameters used by menu commands and the command instruction column. It can be a true/false value. Specify true to use, or false not to use.

If omitted, false is assumed to be specified.

Content:

The contents that can be specified within the ui:menu-item element are listed below.

• ui:with-param Element
  The parameter to be passed to a command can be specified. Any number of elements can be specified, if needed. Optional.
• Command instruction columns
  The command instruction element for XML document editing and platform command instruction may be described. For more information about command instruction element for XML document editing, see the "Command instruction for XML document editing". And for more information about platform command instruction, see the Platform Command Instruction Reference.

Describes toolbar content.

Attribute:

No attributes for the element.

Content:

Within the ui:tool-bar element, be sure to describe it by combining one or more of the following elements:

• ui:tool-list Element
• ui:popup-button Element
• ui:tool-button Element
• ui:separator Element

Used to describe a list box containing many buttons, where user can select one of them to execute. For icon and text displayed in this list box, the icon of the button that is contained in it is used.

Attribute:

label

Specifies a label string of a button in list box format. It can be any string. However, as the strings beginning with # is internally reserved. To describe the strings beginning with #, describe beginning # as ## therefore: This label string is used for a tool tip of a button in list box format.

Either the label attribute or the resource-key attribute is mandatory. If both of them are specified, the resource-key attribute takes precedence.

If omitted, the string specified in the resource-key attribute is used.

resource-key

Specifies the resource key of the string when retrieving the label string of the button in list box format from the string resource. It can be any string.

Either the label attribute or the resource-key attribute is mandatory. If both of them are specified, the resource-key attribute takes precedence.

If omitted, the string specified in the label attribute is used.

Content:

The elements that can be specified within the ui:tool-list element are listed below.

• ui:tool-button Element
  Be sure to describe one or more elements.
• ui:separator Element

Used to describe a button containing many buttons, where user can select one of them to execute. A popup menu is displayed by clicking a button. For icon displayed in this button, the icon of the button that is contained in it is used.

Attribute:

label

Specifies a label string of a button in pop-up button format. It can be any string. However, as the strings beginning with # is internally reserved. To describe the strings beginning with #, describe beginning # as ## therefore: This label string is used to identify other items in the same layer, but not used for displaying.

Either the label attribute or the resource-key attribute is mandatory. If both of them are specified, the resource-key attribute takes precedence.

If omitted, the string specified in the resource-key attribute is used.

resource-key

Specifies the resource key of the string when retrieving the label string of the button in list box format from the string resource. It can be any string.

Either the label attribute or the resource-key attribute is mandatory. If both of them are specified, the resource-key attribute takes precedence.

If omitted, the string specified in the label attribute is used.

Content:

The elements that can be specified within the ui:popup-button element are listed below.

• ui:tool-button Element
  Be sure to describe one or more elements.
• ui:separatorElement

Used to describe a toolbar button.

Attribute:

label

Specifies toolbar label string. It can be any string. However, as the strings beginning with # is internally reserved. To describe the strings beginning with #, describe beginning # as ## therefore:

Either the label attribute or the resource-key attribute is mandatory. If both of them are specified, the resource-key attribute takes precedence.

If omitted, the string specified in the resource-key attribute is used.

resource-key

Specifies the resource key of the string when retrieving the label string of the tool bar from the string resource.

Either the label attribute or the resource-key attribute is mandatory. If both of them are specified, the resource-key attribute takes precedence.

If omitted, the string specified in the label attribute is used.

command

Specifies the command to be executed when button is clicked. Specify the command name defined within the name attribute of the xvcd:command element or the command name provided by a platform.

If omitted, the command instruction column described within the element is executed. If both the command attribute and command instruction column are described at the same time, the specification within the command attribute takes precedence, and the command instruction column is ignored.

icon

Specifies the icon to be displayed in a button. It can be a URL string.

If omitted, a button which has a string specified within the resource-key attribute or the label attribute on its face is created.

Content:

The contents that can be specified within the ui:tool-button element are listed below.

• ui:with-param Element
  The parameter to be passed to a command can be specified. Any number of elements can be specified, if needed. Optional.
• Command instruction columns
  The command instruction element for XML document editing and platform command instruction may be described. For more information about command instruction element for XML document editing, see the "Command instruction for XML document editing". And for more information about platform command instruction, see the Platform Command Instruction Reference.

Used to insert a separator in a menu or tool bar.

Attribute:

No attributes for the element.

Content:

The ui:separator element is empty.

ui:accelerators element is the container of ui:accelerator.

Attribute:

No attributes for the element.

Content:

The elements that can be specified within the ui:accelerators element are listed below.

• ui:accelerator Element
  Key accelerator settings can be described. Any number of elements can be specified, if needed. Optional.

Indicates key accelerator settings. The combination of keys and the executed command can be described.

Attribute:

key-sequence (mandatory)

Specifies the accelerator key to invoke a command by key operation during editing in the canvas. It can be a string. Specify the combination of keys in the same format as the accelerator attribute of the ui:menu-item element.

command

Specifies the command executed when the key operation that is specified within the key-sequence attribute is performed. Specify the command name defined within the name attribute of the xvcd:command element or the command name provided by a platform.

If omitted, the command instruction column described within the element is executed. If both the command attribute and command instruction column are described at the same time, the specification within the command attribute takes precedence, and the command instruction column is ignored.

Content:

The contents that can be specified within the ui:accelerator element are listed below.

• ui:with-param Element
  The parameter to be passed to a command can be specified. Any number of elements can be specified, if needed. Optional.
• Command instruction columns
  The command instruction element for XML document editing and platform command instruction may be described. For more information about command instruction element for XML document editing, see the "Command instruction for XML document editing". And for more information about platform command instruction, see the Platform Command Instruction Reference.

Used to import the user interface definition described in another file.

Attribute:

href (mandatory)

Specifies the file in which the user interface definition to be imported is described. It can be a URL string.

Content:

The ui:import element is empty.

Adds a user interface item when the user agent is enabled to be added to a menu or tool bar.

Attribute:

name (mandatory)

Describes the name specified at the position where the user interface item of the user agent is added. It can be QName.

Content:

Within the ui:mount element, be sure to describe it by combining one or more of the following elements:

• ui:menu Element
• ui:menu-item Element
• ui:tool-bar Element
• ui:tool-list Element
• ui:tool-button Element
• ui:separator Element
• Enhanced user interface item

Used to specify the parameter to be passed to a command.

Attribute:

name (mandatory)

Specifies the parameter name. It can be QName. As to the parameter name to specify, describe the name set within the name attribute of the instruction:param element described within the xvcd:command element.

Content:

The content to be passed to a command as a parameter can be specified within the ui:with-param element. It can be PCDATA string.