IMenuLocalContext Class Reference

Search for all occurrences

---

Detailed Description

See also:

Class IMenuItem, Class IMenuColors, Class IPoint2

Description:

This class is available in release 4.0 and later only.

This abstract class represents a local context interface for a specific menu and is used internally. Methods that are marked as internal should not be used.

#include <imenus.h>

Inheritance diagram for IMenuLocalContext:

List of all members.

Public Member Functions
virtual	~IMenuLocalContext ()
virtual void	SetHDrawDC (HDC hDrawDC)=0
virtual HDC	GetHDrawDC () const =0
virtual void	SetLocalCursorPosition (const IPoint2 &localCursorPos)=0
virtual const IPoint2 &	GetLocalCursorPosition () const =0
virtual void	SetMenuItemWidth (int menuWidth)=0
virtual int	GetMenuItemWidth () const =0
virtual void	SetLevel (int level)=0
virtual int	GetLevel () const =0
virtual void	SetLastExecutedItemPath (Tab< IMenuItem * > *pExecutedItemPath)=0
virtual Tab< IMenuItem * > *	GetLastExecutedItemPath ()=0
virtual void	SetMenuColors (const MenuColors *pMenuColors)=0
virtual const MenuColors *	GetMenuColors () const =0
virtual void	SetIMenuGlobalContext (IMenuGlobalContext *pIMenuGlobalContext, int level, Tab< IMenuItem * > *pExecutedItemPath, const MenuColors *pMenuColors)=0
virtual IMenuGlobalContext *	GetIMenuGlobalContext () const =0

---

Constructor & Destructor Documentation

virtual ~IMenuLocalContext

(

)

[inline, virtual]

Remarks:

Destructor.

{;}

---

Member Function Documentation

virtual void SetHDrawDC

(

HDC

hDrawDC

)

[pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method allows you to set the handle to the drawing device context.

Parameters:

HDC hDrawDC

The handle to the drawing device context.

virtual HDC GetHDrawDC

(

)

const [pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method returns the handle to the drawing device context.

virtual void SetLocalCursorPosition

(

const IPoint2 &

localCursorPos

)

[pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method allows you to set the cursor position in the local coordinate system of the menu.

Parameters:

const IPoint2& localCursorPos

The cursor position coordinates.

virtual const IPoint2& GetLocalCursorPosition

(

)

const [pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method returns the cursor position in the local coordinate system of the menu.

virtual void SetMenuItemWidth

(

int

menuWidth

)

[pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method allows you to set the menu's current width.

Parameters:

int menuWidth

The menu width.

virtual int GetMenuItemWidth

(

)

const [pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method returns the menu's current width.

virtual void SetLevel

(

int

level

)

[pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method allows you to set the menu's current level. Submenus are indexed by a level > 0.

Parameters:

int level

The current level to set.

virtual int GetLevel

(

)

const [pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method returns the menu's current level.

virtual void SetLastExecutedItemPath

(

Tab< IMenuItem * > *

pExecutedItemPath

)

[pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method allows you to set the menu's last executed item path. The item path is a table of IMenuItem entries, listing the selected item at each menu level.

Parameters:

Tab<IMenuItem *> *pExecutedItemPath

A pointer to the item path.

virtual Tab<IMenuItem *>* GetLastExecutedItemPath

(

)

[pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method returns the menu's last executed item path. The item path is a table of IMenuItem entries, listing the selected item at each menu level.

virtual void SetMenuColors

(

const MenuColors *

pMenuColors

)

[pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method allows you to set the menu's current colors.

Parameters:

MenuColors *pMenuColors

A pointer to the menu colors.

virtual const MenuColors* GetMenuColors

(

)

const [pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method returns a pointer to the menu's current colors.

virtual void SetIMenuGlobalContext	(	IMenuGlobalContext *	pIMenuGlobalContext,
		int	level,
		Tab< IMenuItem * > *	pExecutedItemPath,
		const MenuColors *	pMenuColors
	)		[pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method allows you to set the global menu context.

Parameters:

IMenuGlobalContext* pIMenuGlobalContext

A pointer to the menu's global context object.

int level

The menu level.

Tab<IMenuItem *> *pExecutedItemPath

A pointer to the item path. The item path is a table of IMenuItem entries, listing the selected item at each menu level.

MenuColors *pMenuColors

A pointer to the menu colors.

virtual IMenuGlobalContext* GetIMenuGlobalContext

(

)

const [pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method returns a pointer to the menu's global context object.