ADTF_DISPLAY_TOOLBOX  3.8.0 (ADTF 3.14.3)
IMenuabstract

Interface for managing a (context) menu. More...

Inheritance diagram for IMenu:
[legend]

Public Member Functions

 ADTF_IID (IMenu, "menu.chewbacca.mixinlib.disptb.adtf.iid")
 Define an interface id for this class.
 
virtual IMenuAddMenu (const tChar *strText)=0
 Creates a new sub-menu for this menu. More...
 
virtual adtf::disptb::mixinlib::chewbacca::IMenuItemAddMenuItem (const tChar *strText)=0
 Creates a new menu item. More...
 
virtual adtf::disptb::mixinlib::chewbacca::IMenuItemAddSeparator ()=0
 Creates a seperator for this menu. More...
 
virtual tInt GetMenuItemCount () const =0
 Get number of menu items. More...
 
virtual IMenuItemGetMenuItem (tInt nIndex)=0
 Get an item. More...
 
virtual tVoid DeleteItems ()=0
 Removes all items from the menu.
 
- Public Member Functions inherited from IMenuItem
 ADTF_IID (IMenuItem, "menuitem.chewbacca.mixinlib.disptb.adtf.iid")
 Define an interface id for this class.
 
virtual tVoid SetText (const tChar *strText)=0
 Set the text of this menu item. More...
 
virtual tVoid SetToolTip (const tChar *strToolTip)=0
 Set the tool tip of this menu item. More...
 
virtual tVoid SetStatusTip (const tChar *strStatusTip)=0
 Set the status bar tip of this menu item. More...
 
virtual const tChar * GetText () const =0
 Get the text of this menu item. More...
 
virtual const tChar * GetToolTip () const =0
 Get the tool tip of this menu item. More...
 
virtual const tChar * GetStatusTip () const =0
 Get the status bar tip of this menu item. More...
 
virtual tVoid SetSeparator (tBool bSeparator)=0
 Mark this item as a separator. More...
 
virtual tVoid SetCheckable (tBool bCheckable)=0
 Mark this item as checkable. More...
 
virtual tVoid SetChecked (tBool bChecked)=0
 Set chack state of this item. More...
 
virtual tVoid SetEnabled (tBool bEnabled)=0
 Set enabled state of this item. More...
 
virtual tVoid SetVisible (tBool bVisible)=0
 Set visibility of this item. More...
 
virtual tBool IsCheckable () const =0
 Query whether the item is checkable. More...
 
virtual tBool IsChecked () const =0
 Query whether the item is checked. More...
 
virtual tBool IsEnabled () const =0
 Query whether the item is enabled. More...
 
virtual tBool IsVisible () const =0
 Query whether the item is visible. More...
 
virtual tBool IsSeparator () const =0
 Query whether the item is a separator. More...
 
virtual tVoid SetEventHandler (IMenuEventSink *pEvent)=0
 Set an event handler. More...
 
virtual adtf::disptb::mixinlib::chewbacca::IMenuEventSinkGetEventHandler ()=0
 Get the current event handler. More...
 

Detailed Description

Interface for managing a (context) menu.

Definition at line 164 of file menu_intf.h.

Member Function Documentation

◆ AddMenu()

virtual IMenu* AddMenu ( const tChar *  strText)
pure virtual

Creates a new sub-menu for this menu.

Parameters
strText[in] The caption of the sub-menu.
Returns
A pointer to the newly created sub-menu.

◆ AddMenuItem()

virtual adtf::disptb::mixinlib::chewbacca::IMenuItem* AddMenuItem ( const tChar *  strText)
pure virtual

Creates a new menu item.

Parameters
strText[in] The caption of the item.
Returns
A pointer to the new item.

◆ AddSeparator()

virtual adtf::disptb::mixinlib::chewbacca::IMenuItem* AddSeparator ( )
pure virtual

Creates a seperator for this menu.

Returns
A pointer to the new seperator.

◆ GetMenuItem()

virtual IMenuItem* GetMenuItem ( tInt  nIndex)
pure virtual

Get an item.

Parameters
nIndex[in] The index of the item in the menu.
Returns
A pointer to the item.

◆ GetMenuItemCount()

virtual tInt GetMenuItemCount ( ) const
pure virtual

Get number of menu items.

Returns
The amount of menu items in the menu.