6. menu

6. menu
Prev	Chapter 4. Reference	Next

<menu
  name = NMTOKEN
  label = non empty token
  helpId = NMTOKEN
  insert = non empty token
>
  Content: ([ insert | action | menu | separator ]+ [ menuItems ]?)
           | menuItems
</menu>

<insert />

<action 
  name = NMTOKEN
/>

<menu 
  name = NMTOKEN
/>

<separator />

<menuItems 
  name = NMTOKEN
/>

Specifies a menu. A menu contains references to action, menu and menuItems elements declared elsewhere in the GUI specification. The reference to the menuItems element, if any, must always be the last reference contained in the menu element.

The insert child element or the insert attribute may be used to extend the previous definition of a menu. More information in About the insert child element and the insert attribute.

Attributes:

name: Required. Unique name identifying the menu in this GUI specification.
label: Required unless this declaration is an extension of the previous one (that is, <insert/> is used). Label of the menu.
helpId: Online help ID of the menu.

Example: an ordinary menu:

  <menu name="helpMenu" label="_Help" 
        helpId="helpMenu">
    <action name="helpAction" />
    <action name="contextualHelpAction" />
    <separator />
    <action name="showContentModelAction" />
    <separator />
    <action name="listBindingsAction" />
    <action name="listPluginsAction" />
    <separator />
    <action name="aboutAction" />
  </menu>

Example: a menu where all items are dynamic:

  <menu name="configSpecificMenu" label="XML" 
        helpId="configSpecificMenu">
    <menuItems name="configSpecificMenuItems" />
  </menu>

Example: a menu which has two static items followed by dynamic items:

  <menu name="viewMenu" label="_View" 
        helpId="viewMenu">
    <action name="addViewAction" />
    <action name="closeViewAction" />
    <menuItems name="setStyleSheetMenuItems" />
  </menu>

About the insert child element and the insert attribute

There are two ways to extend a composite part such as menu, menuBar, statusBar, toolBar, preferencesSheets, or a layout group such as topToolBars, bottomToolBars, leftToolBars, rightToolBars, leftPanes, rightPanes, hidden:

By using an insert child element.
By using an insert attribute.

Both methods cannot be used in the same element. Method 1 is faster and simpler to use than method 2.

Using the insert child element. Example:

<include location="common.xxe_gui" />
<!-- ====================================================
Let's suppose this tool bar is defined in common.xxe_gui:

<toolBar>
  <action name="openAction" />
</toolBar>
===================================================== -->

<toolBar>
  <action name="newAction" />
  <insert />
  <action name="saveAction" />
</toolBar>

The insert child element is a directive which means: insert all the buttons of the previous definition of the same tool bar here.

Using the insert attribute. Example:
```
<include location="common.xxe_gui" />


<toolBar insert="saveAction">
  <action name="openAction" />
</toolBar>
```
The insert attribute is a directive which means: insert all the buttons found in this tool bar into the previous definition of the same tool bar, and this, at specified position.
The value of the insert attribute is always the name of a part found in the previous definition of the same composite part. In the case of the above example, saveAction is the value of the name attribute of an action contained in the previous definition of the tool bar.
This name may be preceded by modifier "before " or by modifier "after ". Modifier "before " is the implicit one.
In the above example, extending the tool bar could have also been achieved by using:
```
<toolBar insert="before saveAction">
  <action name="openAction" />
</toolBar>
```
or by using:
```
<toolBar insert="after newAction">
  <action name="openAction" />
</toolBar>
```
The value of the insert attribute may start with ifDefined(system_property_name). In such case, the previously defined tool bar is extended if and only if a system property called system_property_name has been defined (no matter its value). Example:
```
<toolBar insert="ifDefined(XXE.Feature.Spreadsheet) after newAction">
  <action name="openAction" />
</toolBar>
```

Prev	Up	Next
5.8. The insert descendant element of layout	Home	7. menuBar