Interface XMenuExtended2

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

:: com :: sun :: star :: awt ::

interface XMenuExtended2

Base Interfaces

XMenuExtended2
┣ XMenuExtended
┗ XMenu

XMenuExtended	Description specifies some extended menu functions, like setting a command URL and a help command for a menu item. These functions are available for both menu bar and popup menu.
XMenu	Description specifies basic menu functions.

Description: specifies extended menu functions.

Methods' Summary
isPopupMenu	checks whether an XMenu is an XPopupMenu.
clear	removes all items from the menu.
getItemType	retrieves the type of the menu item.
hideDisabledEntries	specifies whether disabled menu entries should be hidden, or not.

Methods' Details

isPopupMenu

boolean
isPopupMenu();

Description: checks whether an XMenu is an XPopupMenu.
Returns: true if the menu is a PopupMenu, false if it is a MenuBar.

clear

void
clear();

Description: removes all items from the menu.

getItemType

MenuItemType
getItemType(	[in] short	nItemPos )
raises(	::com::sun::star::container::NoSuchElementException );

Description: retrieves the type of the menu item.
Parameter nItemPos: specifies the position of the menu item for which the item type is queried.
Throws: ::com::sun::star::container::NoSuchElementException if there is no menu item in the position specified in nItemPos.
See also: MenuItemType

hideDisabledEntries

void
hideDisabledEntries(	[in] boolean	bHide );

Description: specifies whether disabled menu entries should be hidden, or not.
Parameter bHide: if true, disabled menu entries are hidden.
See also: XMenu::enableItem()

Top of Page

Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.