Programming Reference: ODMenuBar

# Programming Reference

## ODMenuBar

Class Definition File | MenuBar.idl
Class C++ Binding | MenuBar.xh

Class Hierarchy

    SOMObject
       ODObject
          ODRefCntObject
             ODBaseMenuBar
                ODMenuBar

Description

An object of the ODMenuBar class represents a composite menu-bar object, made up of menus from the document shell and the active part.

When OpenDoc first opens a document, the document shell creates a menu-bar object, adds menus to it, and installs it as the base menu-bar object, which contains the default set of menus shared by all parts in the document. Part editors can obtain a copy of the base menu-bar object, by calling the window-state object's CopyBaseMenuBar method, add menus to it, and install it as the current menu-bar object.

Your part creates an empty menu-bar by calling the window-state object's CopyBaseMenuBar method. Your part can also create a copy of an existing menu-bar object by calling its menu-bar object's Copy method. These methods return a reference to the menu bar object.

OpenDoc allows the document shell and part editors to register command IDs for menu items. If no command ID is registered, a synthetic command ID, one that is manufactured from the menu and menu item IDs, is generated. If a command ID is not registered and not synthetic, a part should not handle it.

Methods

The methods defined by the ODMenuBar class include:

- AddMenuBefore
- AddMenuBeforeEx (Windows)
- AddMenuItemBefore
- AddMenuItemLast
- AddMenuLast
- AddMenuLastEx (Windows)
- AddSubMenuBefore
- AddSubMenuBeforeEx (Windows)
- AddSubMenuLast
- AddSubMenuLastEx (Windows)
- AddToAccelTable
- CheckMenuItem
- Copy
- CreateX11PlatformMenu (AIX)
- DestroyX11PlatformMenu (AIX)
- Display
- EnableMenu
- EnableMenuItem
- GetMenu
- GetMenuItem
- GetMenuItemText
- GetMenuText
- IsItemChecked
- IsItemEnabled
- IsItemHidden
- IsMenuEnabled
- IsValid
- MenuExists
- MenuItemExists
- RemoveMenu
- RemoveMenuItem
- RestoreAccelTable
- SetHideMenuItem
- SetMenuItemText
- SetMenuText
- SetShowMenuItem

Deprecated Methods

The following deprecated methods are still defined by the ODMenuBar class, but each is superseded by newer methods.

- Exists
- InsertSubmenu

Overridden Methods | There are no methods overridden by the ODMenuBar class.

### AddMenuBefore

This method inserts a new menu before another specified menu on this menu bar.

Signature

    void AddMenuBefore (ODMenuID menuID,
                        ODPlatformMenu menu,
                        ODPart *part,
                        ODMenuID beforeID)

Parameters

menuID (ODMenuID) - input

  The platform-specific ID of the new menu.

menu (ODPlatformMenu) - input

  A platform-specific menu handle for the specified menu ID.

part (ODPart *) - input

  A reference to the part that owns the menu or kODNULL if the menu is a document shell menu.

beforeID (ODMenuID) - input

  The menu ID of the menu that follows the new menu.

Returns

None.

Exception Handling

kODErrOutOfMemory | There is not enough memory to allocate the menu.

### AddMenuBeforeEx (Windows)

This method inserts a new menu before another specified menu on this menu bar. This method is similar to AddMenuBefore but takes additional parameters to specify the IDs for the submenus in the menu being added. This is necessary because Windows NT does not support IDs for submenus.

Signature

    void AddMenuBeforeEx (ODMenuID menuID,
                          ODPlatformMenu menu,
                          ODPart *part,
                          ODMenuID beforeID,
                          ODUShort subMenuIDCount,
                          ODMenuIDInfo *submenuIDInfo)

Parameters

menuID (ODMenuID) - input

  The platform-specific ID of the new menu.

menu (ODPlatformMenu) - input

  A platform-specific menu handle for the specified menu ID.

part (ODPart *) - input

  A reference to the part that owns the menu or kODNULL if the menu is a document shell menu.

beforeID (ODMenuID) - input

  The menu ID of the menu that follows the new menu.

subMenuIDCount (ODUShort) - input

  The number of submenu IDs to be passed.

subMenuIDInfo (ODMenuIDInfo *) - input

  A reference to an array of submenu ID information.

  Each element has:

  - A /BEGIN-ITALICS/ hmenu /END-ITALICS/ field that should contain the Windows menu handle of the submenu.
  - A /BEGIN-ITALICS/ id /END-ITALICS/ field that should contain the menu ID associated with that submenu.

Returns

None.

Exception Handling

kODErrOutOfMemory | There is not enough memory to allocate the menu.

### AddMenuItemBefore

This method inserts a menu item in the specified menu before the specified menu item.

Signature

    ODBoolean AddMenuItemBefore (ODMenuID menuID,
                                 ODMenuItemID itemID,
                                 ODPlatformMenuItem *menuItem,
                                 ODMenuItemID beforeID)

Parameters

menuID (ODMenuID) - input

  The ID of the menu on which the menu item is to be placed.

itemID (ODMenuItemID) - input

  The ID of the new menu item.

menuItem (ODPlatformMenuItem *) - input

  The menu structure containing the menu item information.

beforeID (ODMenuItemID) - input

  The menu item before which the new item is to be inserted.

Returns

rv (ODBoolean) - returns

  A flag indicating the success.

  kODTrue | Successful completion.
  kODFalse | Error occurred.

Remarks

This method inserts a menu item in the specified menu before the specified menu item.

### AddMenuItemLast

This method inserts a menu item at the end of the specified menu.

Signature

    ODBoolean AddMenuItemLast (ODMenuID menuID,
                               ODMenuItemID itemID,
                               ODPlatformMenuItem *menuItem)

Parameters

menuID (ODMenuID) - input

  The ID of the menu on which the menu item is to be placed.

itemID (ODMenuItemID) - input

  The ID of the new menu item.

menuItem (ODPlatformMenuItem *) - input

  The menu structure containing the menu-item information.

Returns

rv (ODBoolean) - returns

  A flag indicating the success.

  kODTrue | Successful completion.
  kODFalse | Error occurred.

Remarks

This method inserts a menu item at the end of the specified menu.

### AddMenuLast

This method appends a new menu to the end of this menu bar if there is no IDMS_HELP in the menu; otherwise, it is inserted before the IDMS_HELP entry.

Signature

    void AddMenuLast (ODMenuID menuID,
                      ODPlatformMenu menu,
                      ODPart *part)

Parameters

menuID (ODMenuID) - input

  The platform-specific ID of the new menu.

menu (ODPlatformMenu) - input

  A platform-specific menu handle for the specified menu ID.

part (ODPart *) - input

  A reference to a part that owns the menu or kODNULL if the menu is a document shell menu.

Returns

None.

Exception Handling

kODErrOutOfMemory | There is not enough memory to allocate the menu.

### AddMenuLastEx (Windows)

This method appends a new menu to the end of this menu bar if there is no IDMS_HELP in the menu; otherwise, it is inserted before the IDMS_HELP entry.

This method is similar to AddMenuLast but takes additional parameters that specifies the IDs of any submenu in the menu being added. This is necessary because Windows NT does not support IDs for submenus.

Signature

    void AddMenuLastEx (ODMenuID menuID,
                        ODPlatformMenu menu,
                        ODPart *part,
                        ODUShort subMenuIDCount,
                        ODMenuItemID *submenuIDInfo)

Parameters

menuID (ODMenuID) - input

  The platform-specific ID of the new menu.

menu (ODPlatformMenu) - input

  A platform-specific menu handle for the specified menu ID.

part (ODPart *) - input

  A reference to a part that owns the menu or kODNULL if the menu is a document shell menu.

subMenuIDCount (ODUShort) - input

  The number of submenu IDs to be passed.

subMenuIDInfo (ODMenuIDInfo *) - input

  A reference to an array of submenu ID information.

  Each element has:

  - A /BEGIN-ITALICS/ hmenu /END-ITALICS/ field that should contain the Windows menu handle of the submenu.
  - A /BEGIN-ITALICS/ id /END-ITALICS/ field that should contain the menu ID associated with that submenu.

Returns

None.

Exception Handling

kODErrOutOfMemory | There is not enough memory to allocate the menu.

### AddSubMenuBefore

This method inserts a new cascading submenu into the specified menu or submenu before the specified menu item.

Signature

    ODBoolean AddSubMenuBefore (ODMenuID menuID,
                                ODMenuItemID subMenuItemID,
                                ODPlatformMenu newSubMenu,
                                ODMenuItemID beforeID)

Parameters

menuID (ODMenuID) - input

  The ID of the menu where the new submenu is to be added.

subMenuItemID (ODMenuItemID) - input

  The ID of the menu from which the new submenu cascades.

newSubMenu (ODPlatformMenu) - input

  A platform-specific menu handle for the new submenu.

beforeID (ODMenuItemID) - input

  The menu item before which the new submenu is to be inserted.

Returns

rv (ODBoolean) - returns

  The A flag indicating success.

  kODTrue | Successful completion.
  kODFalse | Error occurred.

### AddSubMenuBeforeEx (Windows)

This method inserts a new cascading submenu into the specified menu or submenu before the specified menu item.

This method is similar to AddSubMenuBefore but takes additional parameters that specifies the IDs of any submenu in the menu being added. This is necessary because Windows NT does not support IDs for submenus.

Signature

    ODBoolean AddSubMenuBeforeEx (ODMenuID menuID,
                                  ODMenuItemID subMenuItemID
                                  ODPlatformMenu newSubMenu,
                                  ODMenuItemID beforeID
                                  ODUShort subMenuIDCount,
                                  ODMenuIDInfo *submenuIDInfo)

Parameters

menuID (ODMenuID) - input

  The ID of the menu where the new submenu is to be added.

subMenuItemID (ODMenuItemID) - input

  The ID of the menu item from which the new submenu cascades.

newSubMenu (ODPlatformMenu) - input

  A platform-specific menu handle for the new submenu.

beforeID (ODMenuItemID) - input

  The menu item before which the new submenu is to be inserted.

subMenuIDCount (ODUShort) - input

  The number of submenu IDs to be passed.

subMenuIDInfo (ODMenuIDInfo *) - input

  A reference to an array of submenu ID information.

  Each element has:

  - A /BEGIN-ITALICS/ hmenu /END-ITALICS/ field that should contain the Windows menu handle of the submenu.
  - A /BEGIN-ITALICS/ id /END-ITALICS/ field that should contain the menu ID associated with that submenu.

Returns

rv (ODBoolean) - returns

  The A flag indicating success.

  kODTrue | Successful completion.
  kODFalse | Error occurred.

### AddSubMenuLast

This method inserts a new cascading submenu to the end of the specified menu or submenu.

Signature

    ODBoolean AddSubMenuBefore (ODMenuID menuID,
                                ODMenuItemID subMenuItemID,
                                ODPlatformMenu newSubMenu)

Parameters

menuID (ODMenuID) - input

  The ID of the menu where the new submenu is to be added.

subMenuItemID (ODMenuItemID) - input

  The ID of the the new submenu.

newSubMenu (ODPlatformMenu) - input

  A platform-specific menu handle for the new submenu.

Returns

rv (ODBoolean) - returns

  The A flag indicating success.

  kODTrue | Successful completion.
  kODFalse | Error occurred.

### AddSubMenuLastEx (Windows)

This method inserts a new cascading submenu to the end of the specified menu or submenu.

This method is similar to AddSubMenuLast but takes additional parameters that specifies the IDs of any submenu in the menu being added. This is necessary because Windows NT does not support IDs for submenus.

Signature

    ODBoolean AddSubMenuBeforeEx (ODMenuID menuID,
                                  ODMenuItemID subMenuItemID
                                  ODPlatformMenu newSubMenu,
                                  ODUShort subMenuIDCount,
                                  ODMenuIDInfo *submenuIDInfo)

Parameters

menuID (ODMenuID) - input

  The ID of the menu where the new submenu is to be added.

subMenuItemID (ODMenuItemID) - input

  The ID of the new submenu cascades.

newSubMenu (ODPlatformMenu) - input

  A platform-specific menu handle for the new submenu.

subMenuIDCount (ODUShort) - input

  The number of submenu IDs to be passed.

subMenuIDInfo (ODMenuIDInfo *) - input

  A reference to an array of submenu ID information.

  Each element has:

  - A /BEGIN-ITALICS/ hmenu /END-ITALICS/ field that should contain the Windows menu handle of the submenu.
  - A /BEGIN-ITALICS/ id /END-ITALICS/ field that should contain the menu ID associated with that submenu.

Returns

rv (ODBoolean) - returns

  The A flag indicating success.

  kODTrue | Successful completion.
  kODFalse | Error occurred.

### AddToAccelTable

This method adds accelerators to the accelerator table.

Signature

    ODBoolean AddToAccelTable (ODULong ulNumberofAccels,
                               ODACCEL *NewAccels)

Parameters

ulNumberofAccels (ODULong) - input

  The number of accelerators to be added to the default table. A maximum of 20 accelerators can be added at one time.

NewAccels (ODACCEL *) - input

  A structure containing the accelerators and their attributes.

Returns

rv (ODBoolean) - returns

  A flag indicating the success.

  kODTrue | Successful completion.
  kODFalse | Error occurred.

### CheckMenuItem

This method checks or unchecks the specified menu item in the menu.

Signature

    ODBoolean CheckMenuItem (ODMenuID menuID,
                             ODMenuItemID menuItemID,
                             ODBoolean check)

Parameters

menuID (ODMenuID) - input

  The ID of the menu containing the specified menu item.

menuItemID (ODMenuItemID) - input

  The ID of the menu item to be checked or unchecked.

check (ODBoolean) - input

  A flag indicating whether the menu item is to be checked.

  kODTrue | The menu item is to be checked.
  kODFalse | The menu item is to be unchecked.

Returns

rv (ODBoolean) - returns

  A flag indicating the success.

  kODTrue | Successful completion.
  kODFalse | Error occurred.

### Copy

This method copies this menu-bar object.

Signature

    ODMenuBar *Copy ()

Parameters

None.

Returns

rv (ODMenuBar *) - returns

  A reference to a copy of this menu-bar object.

Remarks

OpenDoc calls this method; this method is not called by most parts.

### CreateX11PlatformMenu (AIX)

This method creates a new platform menu.

Signature

    ODPlatformMenu CreateX11PlatformMenu (ODMenuID menuID)

Parameters

menuID (ODMenuID) - input

  The ID of the new platform menu.

Returns

rv (ODPlatformMenu) - returns

  A new ODPlatformMenu object. Pass this object to ODMenuBar methods that require an ODPlatfromMenu object as a parameter.

Remarks

This method creates a new platform menu for use on AIX with ODMenuBar methods that require a platform-menu parameter.

### DestroyX11PlatformMenu (AIX)

This method disposes of a platform menu.

Signature

    void DestroyX11PlatformMenu (ODPlatformMenu menu)

Parameters

menu (ODPlatformMenu) - input

  The platform menu to be destroyed.

Returns

None.

Remarks

This method disposes of a platform menu created by the CreateX11PlatformMenu method that is no longer needed.

### Display

This method installs this menu-bar object as the current menu-bar, making it visible and active.

Signature

    void Display ()

Parameters

None.

Returns

None.

### EnableMenu

This method enables or disables the specified item.

Signature

    ODBoolean EnableMenu (ODMenuID menuID,
                          ODBoolean enable)

Parameters

menuID (ODMenuID) - input

  The ID of the menu to be enabled or disabled.

enable (ODBoolean) - input

  A flag indicating whether the menu item is to be enabled.

  kODTrue | The menu item is to be enabled.
  kODFalse | The menu item is to be disabled.

Returns

rv (ODBoolean) - returns

  A flag indicating success.

kODTrue | Successful completion.
kODFalse | Error occurred.

### EnableMenuItem

This method enables or disables the specified menu item.

Signature

    ODBoolean EnableMenuItem (ODMenuID menuID,
                              ODMenuItemID menuItemID,
                              ODBoolean enable)

Parameters

menuID (ODMenuID) - input

  The ID of the menu containing the specified menu item.

menuItemID (ODMenuItemID) - input

  The ID of the menu item to be enabled or disabled.

enable (ODBoolean) - input

  A flag indicating whether the menu item is to be enabled.

  kODTrue | The menu item is to be enabled.
  kODFalse | The menu item is to be disabled.

Returns

rv (ODBoolean) - returns

  A flag indicating the success.

  kODTrue | Successful completion.
  kODFalse | Error occurred.

### Exists

This method indicates whether the specified menu item exists.

Note:

> This method has been superseded by methods MenuExists and MenuItemExists.

Signature

    ODBoolean Exists (ODMenuID menuID,
                      ODMenuItemID menuItemID):

Parameters

menuID (ODMenuID) - input

  The ID of the menu containing the specified menu item.

menuItemID (ODMenuItemID) - input

  The ID of the menu item to be found.

Returns

rv (ODBoolean) - returns

  A flag indicating whether the menu item exists.

  kODTrue | The menu item exists.
  kODFalse | The menu item does not exist.

### GetMenu

This method returns a platform-specific menu structure for the specified menu ID.

Signature

    ODPlatformMenu GetMenu (ODMenuID menu)

Parameters

menu (ODMenuID) - input

  The platform-specific ID of a menu being requested or kODNULL if a handle to the base menu bar is to be returned.

Returns

rv (ODPlatformMenu) - returns

  A platform-specific menu handle for the specified menu ID.

### GetMenuItem

This method returns a platform-specific menu structure for the specified menu item ID.

Signature

    ODBoolean GetMenuItem (ODMenuID menuID,
                           ODMenuItemID menuItemID,
                           ODPlatformMenuItem *menuItem)

Parameters

menuID (ODMenuID) - input

  The ID of the menu containing the specified menu item.

menuItemID (ODMenuItemID) - input

  The ID of the menu item whose information is to be returned.

menuItem (ODPlatformMenuItem *) - output

  A menu-item structure containing the information of the specified menu-item ID.

Returns

rv (ODBoolean) - returns

  A flag indicating whether the item was successfully retrieved.

  kODTrue | The item was successfully retrieved.
  kODFalse | The item was not retrieved.

### GetMenuItemText

This method returns text associated with the specified menu item.

Signature

    ODUShort GetMenuItemText (ODMenuID menuID,
                              ODMenuItemID menuItemID,
                              string *menuItemString)

Parameters

menuID (ODMenuID) - input

  The ID of the menu containing the specified menu item.

menuItemID (ODMenuItemID) - input

  The ID of the menu item whose text is to be returned.

menuItemString (string *) - output

  A string containing text of the specified menu item.

Returns

rv (ODUShort) - returns

  The length of the returned string.

### GetMenuText

This method returns text associated with the specified menu.

Signature

    ODUShort GetMenuText (ODMenuID menuID,
                          string *menuString)

Parameters

menuID (ODMenuID) - input

  The ID of the menu whose text is to be returned.

menuString (string *) - output

  A string containing text of the specified menu.

Returns

rv (ODUShort) - returns

  The length of the returned string.

### InsertSubmenu

This method inserts a new submenu in the specified menu or submenu, creating a cascading menu.

Note:

> This method has been superseded by methods AddSubMenuBefore and AddSubMenuLast.

Signature

    ODBoolean InsertSubmenu (ODMenuID menuID,
                             ODMenuItemID subMenuID,
                             ODPlatformMenu newSubmenu)

Parameters

menuID (ODMenuID) - input

  The ID of the menu on which the new submenu item is to be inserted.

subMenuID (ODMenuItemID) - input

  The ID of the menu item to which this submenu is to be attached. If this value is kODNULL, the submenu is to be inserted into menuID. This replaces any existing submenu in the menuID parameter.

newSubmenu (ODPlatformMenu) - input

  The menu handle containing the menu-item information.

Returns

rv (ODBoolean) - returns

  A flag indicating the success.

  kODTrue | Successful completion.
  kODFalse | Error occurred.

Remarks

The value of subMenuID determines where the new submenu is to be inserted in the menu. If subMenuID contains a kODNULL, the new submenu is inserted in menuID. If subMenuID contains a value, the submenu is inserted into subMenuID.

### IsItemChecked

This method indicates whether a menu item is checked.

Signature

    ODBoolean IsItemChecked (ODMenuID menuID,
                             ODMenuItemID menuItemID)

Parameters

menuID (ODMenuID) - input

  The ID of the menu containing the specified menu item.

menuItemID (ODMenuItemID) - input

  The ID of the menu item to be queried.

Returns

rv (ODBoolean) - returns

  A flag indicating whether the specified menu item is checked.

  kODTrue | The specified menu item is checked.
  kODFalse | The specified menu item is not checked.

### IsItemEnabled

This method indicates whether a menu item is enabled.

Signature

    ODBoolean IsItemEnabled (ODMenuID menuID,
                             ODMenuItemID menuItemID)

Parameters

menuID (ODMenuID) - input

  The ID of the menu containing the specified menu item.

menuItemID (ODMenuItemID) - input

  The ID of the menu item to be queried.

Returns

rv (ODBoolean) - returns

  A flag indicating whether the specified menu item is enabled.

  kODTrue | The specified menu item is enabled.
  kODFalse | The specified menu item is disabled.

### IsItemHidden

This method indicates whether a menu item is hidden from view.

Signature

    ODBoolean IsItemHidden (ODMenuID menuID,
                            ODMenuItemID menuItemID)

Parameters

menuID (ODMenuID) - input

  The ID of the menu containing the specified menu item.

menuItemID (ODMenuItemID) - input

  The ID of the menu item to be queried.

Returns

rv (ODBoolean) - returns

  A flag indicating whether the specified menu item is hidden.

  kODTrue | The specified menu item is hidden.
  kODFalse | The specified menu item is not hidden.

### IsMenuEnabled

This method indicates whether a menu is enabled.

Signature

    ODBoolean IsMenuEnabled (ODMenuID menuID)

Parameters

menuID (ODMenuID) - input

  The ID of the menu to be queried.

Returns

rv (ODBoolean) - returns

  A flag indicating whether a menu is enabled.

  kODTrue | The specified menu item is enabled.
  kODFalse | The specified menu item is disabled.

### IsValid

This method indicates whether this menu bar object is equivalent to the base menu bar object from which is was copied.

Signature

    ODBoolean IsValid ()

Parameters

None.

Returns

rv (ODBoolean) - returns

  A flag indicating whether this menu bar object is equivalent to the base menu bar object from which is was copied.

  kODTrue | The menu bar objects are not equivalent.
  kODFalse | The menu bar objects are equivalent.

Remarks

Your part calls its cached base menu bar's IsValid method before adding its own menus and displaying the composite menu bar. If this base menu bar is no longer valid, your part recopies the current base menu bar object by calling its window state's CopyBaseMenuBar method.

Related Methods

- ODWindowState::CopyBaseMenuBar

### MenuExists

This method indicates whether the specified menu exists.

Signature

    ODBoolean MenuExists (ODMenuID menuID)

Parameters

menuID (ODMenuID) - input

  The ID of the menu to be found.

Returns

rv (ODBoolean) - returns

  A flag indicating whether the menu exists.

  kODTrue | The menu exists.
  kODFalse | The menu does not exist.

### MenuItemExists

This method indicates whether the specified menu item exists.

Signature

    ODBoolean MenuItemExists (ODMenuID menuID,
                              ODMenuItemID menuItemID)

Parameters

menuID (ODMenuID) - input

  The ID of the menu containing the specified menu item.

menuItemID (ODMenuItemID) - input

  The ID of the menu item to be found.

Returns

rv (ODBoolean) - returns

  A flag indicating whether the menu or menu item exists.

  kODTrue | The menu item exists.
  kODFalse | The menu item does not exist.

### RemoveMenu

This method removes the menu with the specified ID from this menu bar.

Signature

    void RemoveMenu (ODMenuID menu)

Parameters

menu (ODMenuID) - input

  The platform-specific ID of the menu to be removed.

Returns

None.

Remarks The displayed menu bar is not affected.

### RemoveMenuItem

This method removes the specified menu item from the menu bar.

Signature

    ODBoolean RemoveMenuItem (ODMenuID menuID,
                              ODMenuItemID menuItemID)

Parameters

menuID (ODMenuID) - input

  The ID of the menu containing the specified menu item.

menuItemID (ODMenuItemID) - input

  The ID of the menu item to be removed.

Returns

rv (ODBoolean) - returns

  A flag indicating whether the item was successfully removed.

  kODTrue | The item was successfully removed.
  kODFalse | The item was not removed.

### RestoreAccelTable

This method restores the OpenDoc accelerator table to its initial state and removes any part-defined accelerators.

Signature

    void RestoreAccelTable ()

Parameters

None.

Returns

None.

### SetHideMenuItem

This method hides the text of the specified menu item.

Signature

    ODBoolean SetHideMenuItem (ODMenuID menuID,
                               ODMenuItemID menuItemID)

Parameters

menuID (ODMenuID) - input

  The ID of the menu containing the specified menu item.

menuItemID (ODMenuItemID) - input

  The ID of the menu item whose text is to be hidden. This parameter can be set to one of the following values:

  VIEW_SHOWFRAMEOUTLINE | Hide the Hide/Show Frame Outline menu item.
  VIEW_SHOWLINKS | Hide the Hide/Show Links menu item.

Returns

rv (ODBoolean) - returns

  A flag indicating the success.

  kODTrue | Successful completion.
  kODFalse | Error occurred.

### SetMenuItemText

This method sets the text associated with the specified menu item.

Signature

    ODBoolean SetMenuItemText (ODMenuID menuID,
                               ODMenuItemID menuItemID,
                               string menuItemString)

Parameters

menuID (ODMenuID) - input

  The ID of the menu containing the specified menu item.

menuItemID (ODMenuItemID) - input

  The ID of the menu item whose text is to be changed.

menuItemString (string) - input

  A string containing the new text to place on the menu item.

Returns

rv (ODBoolean) - returns

  A flag indicating the success.

  kODTrue | Successful completion.
  kODFalse | Error occurred.

### SetMenuText

This method sets the text associated with the specified menu.

Signature

    ODBoolean SetMenuText (ODMenuID menuID,
                           string menuString)

Parameters

menuID (ODMenuID) - input

  The ID of the menu whose text is to be changed.

menuString (string) - input

  A string containing the new text to place on the menu.

Returns

rv (ODBoolean) - returns

  A flag indicating the success.

  kODTrue | Successful completion.
  kODFalse | Error occurred.

### SetShowMenuItem

This method displays the text of the specified menu item.

Signature

    ODBoolean SetShowMenuItem (ODMenuID menuID,
                               ODMenuItemID menuItemID)

Parameters

menuID (ODMenuID) - input

  The ID of the menu containing the specified menu item.

menuItemID (ODMenuItemID) - input

  The ID of the menu item whose text is to be displayed. This parameter can be set to one of the following values:

  VIEW_SHOWFRAMEOUTLINE | Displays the Hide/Show Frame Outline menu item.
  VIEW_SHOWLINKS | Displays the Hide/Show Links menu item.

Returns

rv (ODBoolean) - returns

  A flag indicating the success.

  kODTrue | Successful completion.
  kODFalse | Error occurred.

[ Top | Previous | Next | Contents | Index | Documentation Homepage ]