Detailed Description
- See also:
- Class ImenuItem, Class IMenuSettings, Class IMenuTimer, Class ItemID, Class IPoint2
- Description:
- This class is available in release 4.0 and later only.
This abstract class represents an global context interface for all menus that might be displayed during a user's menuing action and is used internally. Methods that are marked as internal should not be used.
#include <imenus.h>
Inheritance diagram for
IMenuGlobalContext:
Public Member Functions |
|
| virtual | ~IMenuGlobalContext () |
| virtual void | SetIMenuSettings (IMenuSettings *pIMenuSettings)=0 |
| virtual IMenuSettings * | GetIMenuSettings () const =0 |
| virtual void | UpdateCursorPosition ()=0 |
| virtual const IPoint2 & | GetCursorPosition () const =0 |
| virtual const IPoint2 & | GetInitialCursorPosition () const =0 |
| virtual void | SetInitialCursorPosition (IPoint2 &initPos)=0 |
| virtual void | SetIMenuTimer (IMenuTimer *pIMenuTimer)=0 |
| virtual IMenuTimer * | GetIMenuTimer () const =0 |
| virtual void | SetHDisplayWnd (HWND hDisplayWnd)=0 |
| virtual HWND | GetHDisplayWnd () const =0 |
| virtual void | SetHMessageWnd (HWND hDisplayWnd)=0 |
| virtual HWND | GetHMessageWnd () const =0 |
| virtual void | SetHDisplayDC (HDC hDisplayDC)=0 |
| virtual HDC | GetHDisplayDC () const =0 |
| virtual void | SetTitleHFont (HFONT hTitleFont)=0 |
| virtual HFONT | GetTitleHFont () const =0 |
| virtual void | SetItemHFont (HFONT hItemFont)=0 |
| virtual HFONT | GetItemHFont () const =0 |
| virtual void | SetAcceleratorHFont (HFONT hItemFont)=0 |
| virtual HFONT | GetAcceleratorHFont () const =0 |
| virtual void | SetUniformItemSize (const IPoint2 &itemSize)=0 |
| virtual const IPoint2 & | GetUniformItemSize () const =0 |
| virtual int | GetTitleBarHeight ()=0 |
| virtual ItemID & | GetCurrentItemID ()=0 |
| virtual ItemID & | GetSelectionItemID ()=0 |
| virtual bool | HasSelection ()=0 |
| virtual bool | IsCurrentMenuSelected ()=0 |
| virtual bool | IsCurrentItemSelected ()=0 |
| virtual void | SelectCurrentItem ()=0 |
Constructor & Destructor Documentation
| virtual ~IMenuGlobalContext | ( | ) | [inline, virtual] |
- Remarks:
- Destructor.
{}
Member Function Documentation
| virtual void SetIMenuSettings | ( | IMenuSettings * | pIMenuSettings | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method allows you to set the menu settings associated with this global context.
- Parameters:
- IMenuSettings* pIMenuSettings
A pointer to a menu settings object.
| virtual IMenuSettings* GetIMenuSettings | ( | ) | const [pure virtual] |
- Remarks:
- This method is used internally.
This method returns a pointer to the menu settings associated with this global context.
| virtual void UpdateCursorPosition | ( | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method updates the cursor position from Win32.
| virtual const IPoint2& GetCursorPosition | ( | ) | const [pure virtual] |
- Remarks:
- This method is used internally.
This method returns the cached cursor position.
- Returns:
- The x and y coordinates of the cursor.
| virtual const IPoint2& GetInitialCursorPosition | ( | ) | const [pure virtual] |
- Remarks:
- This method is used internally.
This method returns the cached initial cursor position (i.e. the coordinate where the user clicked).
- Returns:
- The x and y coordinates of the cached initial cursor position.
| virtual void SetInitialCursorPosition | ( | IPoint2 & | initPos | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method allows you to set the cached initial cursor position (i.e. the coordinate where the user clicked).
- Parameters:
- IPoint2&
initPos
The x and y coordinate of the cursor position.
| virtual void SetIMenuTimer | ( | IMenuTimer * | pIMenuTimer | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method allows you to set a global timer for the menu's global context.
- Parameters:
- IMenuTimer* pIMenuTimer
A pointer to the menu timer object,
| virtual IMenuTimer* GetIMenuTimer | ( | ) | const [pure virtual] |
- Remarks:
- This method is used internally.
This method returns a pointer to the global timer for the menu's global context.
| virtual void SetHDisplayWnd | ( | HWND | hDisplayWnd | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method allows you to set the handle to the display window.
- Parameters:
- HWND hDisplayWnd
The handle to the display window.
| virtual HWND GetHDisplayWnd | ( | ) | const [pure virtual] |
- Remarks:
- This method is used internally.
This method returns the handle to the display window.
| virtual void SetHMessageWnd | ( | HWND | hDisplayWnd | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method allows you to set the handle to the message window
- Parameters:
- HWND hDisplayWnd
The handle to the message window.
| virtual HWND GetHMessageWnd | ( | ) | const [pure virtual] |
- Remarks:
- This method is used internally.
This method returns the handle to the message window.
| virtual void SetHDisplayDC | ( | HDC | hDisplayDC | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method allows you to set a handle to the display device context.
- Parameters:
- HDC hDisplayDC
The handle to the display device context.
| virtual HDC GetHDisplayDC | ( | ) | const [pure virtual] |
- Remarks:
- This method is used internally.
This method returns the handle to the display device context.
| virtual void SetTitleHFont | ( | HFONT | hTitleFont | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method allows you to set the handle to the title font.
- Parameters:
- HFONT hTitleFont
The handle to the title font.
| virtual HFONT GetTitleHFont | ( | ) | const [pure virtual] |
- Remarks:
- This method is used internally.
This method returns the handle to the title font.
| virtual void SetItemHFont | ( | HFONT | hItemFont | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method allows you to set the handle to the item font.
- Parameters:
- HFONT hItemFont
The handle to the item font.
| virtual HFONT GetItemHFont | ( | ) | const [pure virtual] |
- Remarks:
- This method is used internally.
This method returns the handle to the item font.
| virtual void SetAcceleratorHFont | ( | HFONT | hItemFont | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method allows you to set the handle to the accelerator font.
- Parameters:
- HFONT hItemFont
The handle to the accelerator font.
| virtual HFONT GetAcceleratorHFont | ( | ) | const [pure virtual] |
- Remarks:
- This method is used internally.
This method returns the handle to the accelerator font.
| virtual void SetUniformItemSize | ( | const IPoint2 & | itemSize | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method allows you to set the menu's maximum uniform item size.
- Parameters:
- IPoint2&
itemSize
The size rectangle.
| virtual const IPoint2& GetUniformItemSize | ( | ) | const [pure virtual] |
- Remarks:
- This method is used internally.
This method returns the menu's maximum uniform item size as a rectangle.
| virtual int GetTitleBarHeight | ( | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method returns the height of the title bar, not counting the border.
| virtual ItemID& GetCurrentItemID | ( | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method returns the ItemID of the menu/item triplet that's currently being traversed.
| virtual ItemID& GetSelectionItemID | ( | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method returns the ItemID of the menu/item triplet that's currently selected.
| virtual bool HasSelection | ( | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method will determine selection is available and will return TRUE if selection is available or FALSE if it is not.
| virtual bool IsCurrentMenuSelected | ( | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method will determine the selection status of the current menu and will return TRUE if the current menu is selected or FALSE if it is not.
| virtual bool IsCurrentItemSelected | ( | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method will determine the selection status of the current menu and item and will return TRUE if the current menu and item are selected or FALSE if they are not.
| virtual void SelectCurrentItem | ( | ) | [pure virtual] |
- Remarks:
- This method is used internally.
This method selects the current item.
