Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

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

interface XMenu

Base Interface
com::sun::star::uno::XInterface

Description
represents a simple menu.


Methods' Summary

addMenuListener adds the specified menu listener to receive events from this menu.
removeMenuListener removes the specified menu listener so it no longer receives item events from this menu.
insertItem inserts an item into the menu. This appends the item if the position is greater than or equal to getItemCount() or if it is negative.
removeItem remove one or more items from the menu.
getItemCount returns the number of items in the menu.
getItemId returns the id of the item at the specified position.
getItemPos returns the position of the item with the specified id.
enableItem enables or disables the menu item.
isItemEnabled returns the state of the menu item.
setItemText sets the text for the menu item.
getItemText
setPopupMenu set the popup menu for a specified menu item.
getPopupMenu returns the popup menu from the menu item.

Methods' Details

addMenuListener
 
[ oneway ] void
addMenuListener(
[ in ] com::sun::star::awt::XMenuListener xListener );

Description
adds the specified menu listener to receive events from this menu.
removeMenuListener
 
[ oneway ] void
removeMenuListener(
[ in ] com::sun::star::awt::XMenuListener xListener );

Description
removes the specified menu listener so it no longer receives item events from this menu.
insertItem
 
[ oneway ] void
insertItem(
[ in ] short nItemId,
[ in ] string aText,
[ in ] short nItemStyle,
[ in ] short nPos );

Description
inserts an item into the menu. This appends the item if the position is greater than or equal to getItemCount() or if it is negative.
removeItem
 
[ oneway ] void
removeItem(
[ in ] short nPos,
[ in ] short nCount );

Description
remove one or more items from the menu.
getItemCount
 
short
getItemCount();
Description
returns the number of items in the menu.
getItemId
 
short
getItemId(
[ in ] short nPos );

Description
returns the id of the item at the specified position.
getItemPos
 
short
getItemPos(
[ in ] short nId );

Description
returns the position of the item with the specified id.
enableItem
 
[ oneway ] void
enableItem(
[ in ] short nItemId,
[ in ] boolean bEnable );

Description
enables or disables the menu item.
isItemEnabled
 
boolean
isItemEnabled(
[ in ] short nItemId );

Description
returns the state of the menu item.
setItemText
 
[ oneway ] void
setItemText(
[ in ] short nItemId,
[ in ] string aText );

Description
sets the text for the menu item.
getItemText
 
string
getItemText(
[ in ] short nItemId );

Returns
the string for the given item id.
setPopupMenu
 
[ oneway ] void
setPopupMenu(
[ in ] short nItemId,
[ in ] com::sun::star::awt::XPopupMenu aPopupMenu );

Description
set the popup menu for a specified menu item.
getPopupMenu
 
com::sun::star::awt::XPopupMenu
getPopupMenu(
[ in ] short nItemId );

Description
returns the popup menu from the menu item.

Top of Page