Detailed Description
- See also:
- Class IMenu
- Description:
- This class is available in release 4.0 and later only.
This abstract class represents an interface for a multi-menu.
#include <imenus.h>
Inheritance diagram for IMultiMenu:
Public Member Functions |
|
| virtual | ~IMultiMenu () |
| virtual int | NumMenusAllowed () const =0 |
| virtual int | NumMenus () const =0 |
| virtual IMenu * | GetMenu (int position)=0 |
| virtual void | AddMenu (IMenu *menu, int pos=-1)=0 |
| virtual void | RemoveMenu (int position)=0 |
| virtual void | RemoveMenu (IMenu *menu)=0 |
| virtual void | SetTitle (const MCHAR *customTitle, int pos)=0 |
| virtual const MSTR & | GetTitle (int pos)=0 |
| virtual void | SetUseCustomTitle (int pos, bool useCustomTitle)=0 |
| virtual bool | GetUseCustomTitle (int pos) const =0 |
Constructor & Destructor Documentation
| virtual ~IMultiMenu | ( | ) | [inline, virtual] |
- Remarks:
- Destructor.
{;}
Member Function Documentation
| virtual int NumMenusAllowed | ( | ) | const [pure virtual] |
- Remarks:
- This method returns the number of contained menus allowed. A value of -1 will indicate an infinite number.
| virtual int NumMenus | ( | ) | const [pure virtual] |
- Remarks:
- This method returns the number of menus contained.
| virtual IMenu* GetMenu | ( | int | position | ) | [pure virtual] |
- Remarks:
- This method returns a pointer to a menu from the multi-menu depending on its position index.
- Parameters:
- int position
The position/index of the menu you wish to retrieve.
| virtual void AddMenu | ( | IMenu * | menu, |
| int | pos = -1 |
||
| ) | [pure virtual] |
- Remarks:
- This method allows you to add a menu into the container. Each new menu which is added will default to the end position.
- Parameters:
- IMenu* menu
A pointer to the menu to add.
int pos = -1
The position to insert the menu at, -1 for the end of the list, and 0 signifies the beginning of the list.
| virtual void RemoveMenu | ( | int | position | ) | [pure virtual] |
- Remarks:
- This method allows you to remove the menu at the specified position.
- Parameters:
- int position
The position/index of the menu to remove.
| virtual void RemoveMenu | ( | IMenu * | menu | ) | [pure virtual] |
- Remarks:
- This method allows you to remove the specified menu from the container.
- Parameters:
- IMenu* menu
A pointer to the menu to remove
| virtual void SetTitle | ( | const MCHAR * | customTitle, |
| int | pos | ||
| ) | [pure virtual] |
- Remarks:
- This method allows you to set the title for the specified menu position.
- Parameters:
- MCHAR *customTitle
The custom title string.
int pos
The menu position.
| virtual const MSTR& GetTitle | ( | int | pos | ) | [pure virtual] |
- Remarks:
- This method returns the title for the specified menu position.
| virtual void SetUseCustomTitle | ( | int | pos, |
| bool | useCustomTitle | ||
| ) | [pure virtual] |
- Remarks:
- This method allows you to set whether the menu at indicated position should use a custom title.
- Parameters:
- int pos
The position of the menu.
bool useCustomTitle
TRUE to set the menu to use a custom title, otherwise FALSE.
| virtual bool GetUseCustomTitle | ( | int | pos | ) | const [pure virtual] |
- Remarks:
- This method returns TRUE if the menu as the specified position is using a custom title, otherwise FALSE.
- Parameters:
- int pos
The position of the menu.
