|
LibreOfficeDev
LibreOfficeDev 25.8 SDK API Reference
|
specifies a simple menu. More...
import"XMenu.idl";
Public Member Functions | |
| void | addMenuListener ([in] XMenuListener xListener) |
| adds the specified menu listener to receive events from this menu. More... | |
| void | removeMenuListener ([in] XMenuListener xListener) |
| removes the specified menu listener so that it no longer receives events from this menu. More... | |
| void | insertItem ([in] short nItemId, [in] string aText, [in] short nItemStyle, [in] short nItemPos) |
| inserts an item into the menu. More... | |
| void | removeItem ([in] short nItemPos, [in] short nCount) |
| removes one or more items from the menu. More... | |
| void | clear () |
| removes all items from the menu. More... | |
| short | getItemCount () |
| returns the number of items in the menu. More... | |
| short | getItemId ([in] short nItemPos) |
| returns the ID of the item at the specified position. More... | |
| short | getItemPos ([in] short nItemId) |
| returns the position of the item with the specified ID. More... | |
| ::com::sun::star::awt::MenuItemType | getItemType ([in] short nItemPos) |
| retrieves the type of the menu item. More... | |
| void | enableItem ([in] short nItemId, [in] boolean bEnable) |
| enables or disables the menu item. More... | |
| boolean | isItemEnabled ([in] short nItemId) |
| returns the state of the menu item. More... | |
| void | hideDisabledEntries ([in] boolean bHide) |
| specifies whether disabled menu entries should be hidden, or not. More... | |
| void | enableAutoMnemonics ([in] boolean bEnable) |
| specifies whether mnemonics are automatically assigned to menu items, or not. More... | |
| void | setItemText ([in] short nItemId, [in] string aText) |
| sets the text for the menu item. More... | |
| string | getItemText ([in] short nItemId) |
| returns the string for the given item id. More... | |
| void | setCommand ([in] short nItemId, [in] string aCommand) |
| sets the command string for the menu item. More... | |
| string | getCommand ([in] short nItemId) |
| retrieves the command string for the menu item. More... | |
| void | setHelpCommand ([in] short nItemId, [in] string aCommand) |
| sets the help command string for the menu item. More... | |
| string | getHelpCommand ([in] short nItemId) |
| retrieves the help command string for the menu item. More... | |
| void | setHelpText ([in] short nItemId, [in] string sHelpText) |
| sets the help text for the menu item. More... | |
| string | getHelpText ([in] short nItemId) |
| retrieves the help text for the menu item. More... | |
| void | setTipHelpText ([in] short nItemId, [in] string sTipHelpText) |
| sets the tip help text for the menu item. More... | |
| string | getTipHelpText ([in] short nItemId) |
| retrieves the tip help text for the menu item. More... | |
| boolean | isPopupMenu () |
| checks whether an XMenu is an XPopupMenu. More... | |
| void | setPopupMenu ([in] short nItemId, [in] XPopupMenu aPopupMenu) |
| sets the popup menu for a specified menu item. More... | |
| XPopupMenu | getPopupMenu ([in] short nItemId) |
| returns the popup menu from the menu item. More... | |
Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. More... | |
| void | acquire () |
| increases the reference counter by one. More... | |
| void | release () |
| decreases the reference counter by one. More... | |
specifies a simple menu.
| void addMenuListener | ( | [in] XMenuListener | xListener | ) |
adds the specified menu listener to receive events from this menu.
| xListener | the XMenuListener to be added. |
| void clear | ( | ) |
removes all items from the menu.
| void enableAutoMnemonics | ( | [in] boolean | bEnable | ) |
specifies whether mnemonics are automatically assigned to menu items, or not.
| bEnable | if TRUE, mnemonics are automatically assigned to menu items. |
| void enableItem | ( | [in] short | nItemId, |
| [in] boolean | bEnable | ||
| ) |
enables or disables the menu item.
| nItemId | specifies the menu item ID. |
| bEnable | specifies whether the menu item should be enabled (TRUE) or disabled (FALSE). |
| string getCommand | ( | [in] short | nItemId | ) |
retrieves the command string for the menu item.
| nItemId | specifies the menu item ID for which the command URL should be set. |
| string getHelpCommand | ( | [in] short | nItemId | ) |
retrieves the help command string for the menu item.
| nItemId | specifies the menu item ID for which the help command should be set. |
| string getHelpText | ( | [in] short | nItemId | ) |
retrieves the help text for the menu item.
| nItemId | specifies the menu item identifier for which the help text should be retrieved. |
| short getItemCount | ( | ) |
returns the number of items in the menu.
| short getItemId | ( | [in] short | nItemPos | ) |
returns the ID of the item at the specified position.
| nItemPos | specifies the position of the menu item for which the item ID is queried. |
| short getItemPos | ( | [in] short | nItemId | ) |
returns the position of the item with the specified ID.
| nItemId | specifies the ID of the menu item for which the item position is queried. |
| string getItemText | ( | [in] short | nItemId | ) |
returns the string for the given item id.
| nItemId | specifies the ID of the menu item. |
| ::com::sun::star::awt::MenuItemType getItemType | ( | [in] short | nItemPos | ) |
retrieves the type of the menu item.
| nItemPos | specifies the position of the menu item for which the item type is queried. |
| XPopupMenu getPopupMenu | ( | [in] short | nItemId | ) |
returns the popup menu from the menu item.
| nItemId | specifies the menu item ID for which the XPopupMenu should be retrieved. |
| string getTipHelpText | ( | [in] short | nItemId | ) |
retrieves the tip help text for the menu item.
| nItemId | specifies the menu item identifier for which the tip help text should be retrieved. |
| void hideDisabledEntries | ( | [in] boolean | bHide | ) |
specifies whether disabled menu entries should be hidden, or not.
| bHide | if TRUE, disabled menu entries are hidden. |
| void insertItem | ( | [in] short | nItemId, |
| [in] string | aText, | ||
| [in] short | nItemStyle, | ||
| [in] short | nItemPos | ||
| ) |
inserts an item into the menu.
The item is appended if the position is greater than or equal to getItemCount() or if it is negative.
| nItemId | specifies the ID of the menu item to be inserted. |
| aText | specifies the label of the menu item. |
| nItemStyle | specifies the style of the menu item, as defined in MenuItemStyle. |
| nItemPos | specifies the position where the menu item will be inserted. |
| boolean isItemEnabled | ( | [in] short | nItemId | ) |
returns the state of the menu item.
| nItemId | specifies the menu item ID. |
TRUE if the item is enabled, FALSE otherwise. | boolean isPopupMenu | ( | ) |
checks whether an XMenu is an XPopupMenu.
| void removeItem | ( | [in] short | nItemPos, |
| [in] short | nCount | ||
| ) |
removes one or more items from the menu.
| nItemPos | specifies the position of the (first) menu item to be removed. |
| nCount | specifies the number of menu items to remove. |
| void removeMenuListener | ( | [in] XMenuListener | xListener | ) |
removes the specified menu listener so that it no longer receives events from this menu.
| xListener | the XMenuListener to be removed. |
| void setCommand | ( | [in] short | nItemId, |
| [in] string | aCommand | ||
| ) |
sets the command string for the menu item.
| nItemId | specifies the menu item ID for which the command should be set. |
| aCommand | specifies the command for the menu item. |
| void setHelpCommand | ( | [in] short | nItemId, |
| [in] string | aCommand | ||
| ) |
sets the help command string for the menu item.
| nItemId | specifies the menu item ID for which the help command URL be set. |
| aCommand | specifies the help command for the menu item. |
| void setHelpText | ( | [in] short | nItemId, |
| [in] string | sHelpText | ||
| ) |
sets the help text for the menu item.
| nItemId | specifies the menu item identifier for which the help text should be set. |
| sHelpText | specifies the help text for the menu item. |
| void setItemText | ( | [in] short | nItemId, |
| [in] string | aText | ||
| ) |
sets the text for the menu item.
| nItemId | specifies the ID of the menu item. |
| aText | specifies the label of the menu item. |
| void setPopupMenu | ( | [in] short | nItemId, |
| [in] XPopupMenu | aPopupMenu | ||
| ) |
sets the popup menu for a specified menu item.
| nItemId | specifies the menu item ID for which the XPopupMenu should be set. |
| aPopupMenu | specifies a XPopupMenu. |
| void setTipHelpText | ( | [in] short | nItemId, |
| [in] string | sTipHelpText | ||
| ) |
sets the tip help text for the menu item.
| nItemId | specifies the menu item identifier for which the tip help text should be set. |
| sTipHelpText | specifies the tip help text for the menu item. |
1.8.14