imenus.h File Reference

#include "maxheap.h"
#include "strclass.h"
#include "color.h"
#include "GetCOREInterface.h"
#include "iFnPub.h"

Go to the source code of this file.

Classes
struct	MenuEvent
class	ItemID
class	IMenuTimer
class	MenuColors
class	IMenuSettings
class	IMenuGlobalContext
class	IMenuLocalContext
class	IQuadMenuSettings
class	IMenuElement
class	IMenuItem
class	IMenu
class	IPopupMenu
class	IMultiMenu
class	IMenuBar
class	IQuadMenu
Defines
#define	MENUS_API   __declspec(dllimport)
#define	MENU_SETTINGS   Interface_ID(0x31561ddb, 0x1a2f4619)
#define	MENU_ITEM_INTERFACE   Interface_ID(0x2e926bd1, 0x296e68f6)
#define	MENU_INTERFACE   Interface_ID(0x4bd57e2e, 0x6de57aeb)
#define	QUAD_MENU_INTERFACE   Interface_ID(0x78b735e9, 0x7c001f68)
Typedefs
typedef unsigned int	ValidityToken
Enumerations
enum	Event {   EVENT_BEGIN_TRACK = 0, EVENT_CURSOR_DOWN, EVENT_RIGHT_CURSOR_DOWN, EVENT_CURSOR_MOVED,   EVENT_CURSOR_UP, EVENT_END_TRACK, EVENT_KEY, EVENT_RIGHT_CURSOR_UP,   EVENT_MIDDLE_CURSOR_DOWN, EVENT_MIDDLE_CURSOR_UP }
enum	EventParam { EP_NULL = 0, EP_SHOW_SUBMENU, EP_HIDE_SUBMENU }
enum	QuadIndex { QUAD_ONE = 0, QUAD_TWO, QUAD_THREE, QUAD_FOUR }
enum	DisplayMethod { DM_NORMAL = 0, DM_STRETCH, DM_FADE, DM_NUM_METHODS }
Functions
bool	operator== (ItemID &a, ItemID &b)
COLORREF	MakeCOLORREF (const Color &c)
IQuadMenuSettings *	GetQuadSettings ()
MENUS_API IMenuItem *	GetIMenuItem ()
MENUS_API void	ReleaseIMenuItem (IMenuItem *)
MENUS_API IMenu *	GetIMenu ()
MENUS_API void	ReleaseIMenu (IMenu *)
MENUS_API IQuadMenu *	GetIQuadMenu ()
MENUS_API void	ReleaseIQuadMenu (IQuadMenu *)

---

Define Documentation

#define MENUS_API   __declspec(dllimport)

Search for all occurrences

Definition at line 30 of file imenus.h.

#define MENU_SETTINGS   Interface_ID(0x31561ddb, 0x1a2f4619)

Search for all occurrences

Definition at line 1333 of file imenus.h.

#define MENU_ITEM_INTERFACE   Interface_ID(0x2e926bd1, 0x296e68f6)

Search for all occurrences

Definition at line 1431 of file imenus.h.

#define MENU_INTERFACE   Interface_ID(0x4bd57e2e, 0x6de57aeb)

Search for all occurrences

Definition at line 1631 of file imenus.h.

#define QUAD_MENU_INTERFACE   Interface_ID(0x78b735e9, 0x7c001f68)

Search for all occurrences

Definition at line 1964 of file imenus.h.

---

Typedef Documentation

typedef unsigned int ValidityToken

Search for all occurrences

Definition at line 209 of file imenus.h.

---

Enumeration Type Documentation

enum Event

Search for all occurrences

Enumerator:

EVENT_BEGIN_TRACK	Search for all occurrences
EVENT_CURSOR_DOWN	Search for all occurrences
EVENT_RIGHT_CURSOR_DOWN	Search for all occurrences
EVENT_CURSOR_MOVED	Search for all occurrences
EVENT_CURSOR_UP	Search for all occurrences
EVENT_END_TRACK	Search for all occurrences
EVENT_KEY	Search for all occurrences
EVENT_RIGHT_CURSOR_UP	Search for all occurrences
EVENT_MIDDLE_CURSOR_DOWN	Search for all occurrences
EVENT_MIDDLE_CURSOR_UP	Search for all occurrences

Definition at line 33 of file imenus.h.

{
    EVENT_BEGIN_TRACK = 0,
    EVENT_CURSOR_DOWN,
    EVENT_RIGHT_CURSOR_DOWN,
    EVENT_CURSOR_MOVED,
    EVENT_CURSOR_UP,
    EVENT_END_TRACK,
    EVENT_KEY,
    EVENT_RIGHT_CURSOR_UP,
    EVENT_MIDDLE_CURSOR_DOWN, //RK:01/31/02, to support action options
    EVENT_MIDDLE_CURSOR_UP, 
};

enum EventParam

Search for all occurrences

Enumerator:

EP_NULL	Search for all occurrences
EP_SHOW_SUBMENU	Search for all occurrences
EP_HIDE_SUBMENU	Search for all occurrences

Definition at line 47 of file imenus.h.

{ EP_NULL = 0, EP_SHOW_SUBMENU, EP_HIDE_SUBMENU };

enum QuadIndex

Search for all occurrences

Enumerator:

QUAD_ONE	Search for all occurrences
QUAD_TWO	Search for all occurrences
QUAD_THREE	Search for all occurrences
QUAD_FOUR	Search for all occurrences

Definition at line 72 of file imenus.h.

{ QUAD_ONE = 0, QUAD_TWO, QUAD_THREE, QUAD_FOUR };

enum DisplayMethod

Search for all occurrences

Enumerator:

DM_NORMAL	Search for all occurrences
DM_STRETCH	Search for all occurrences
DM_FADE	Search for all occurrences
DM_NUM_METHODS	Search for all occurrences

Definition at line 74 of file imenus.h.

{ DM_NORMAL = 0, DM_STRETCH, DM_FADE, DM_NUM_METHODS };

---

Function Documentation

bool operator==	(	ItemID &	a,
		ItemID &	b
	)		[inline]

Remarks:

This method is used internally.

This operator tests for equality of two ItemID's.

Parameters:

ItemID& a, ItemID& b

The two ItemID's you wish to test for equality.

Definition at line 127 of file imenus.h.

{
    if ( a.mpMenu  != b.mpMenu  ||
         a.mpItem  != b.mpItem )
        return false;
    else
        return true;
}

COLORREF MakeCOLORREF

(

const Color &

c

)

[inline]

Search for all occurrences

Definition at line 257 of file imenus.h.

{ return RGB( FLto255(c.r), FLto255(c.g), FLto255(c.b) ); }

IQuadMenuSettings* GetQuadSettings

(

)

[inline]

Search for all occurrences

Definition at line 1334 of file imenus.h.

{ return (IQuadMenuSettings*)GetCOREInterface(MENU_SETTINGS); }

MENUS_API IMenuItem* GetIMenuItem

(

)

Search for all occurrences

Remarks:

This method will return a pointer to the IMenuItem.

MENUS_API void ReleaseIMenuItem

(

IMenuItem *

)

Search for all occurrences

Remarks:

This method will release the specified IMenuItem.

Parameters:

IMenuItem *

A pointer to the IMenuItem you wish to release.

MENUS_API IMenu* GetIMenu

(

)

Search for all occurrences

Remarks:

This method will return a pointer to the IMenu.

MENUS_API void ReleaseIMenu

(

IMenu *

)

Search for all occurrences

Remarks:

This method will release the specified IMenu.

Parameters:

IMenuItem *

A pointer to the IMenu you wish to release.

MENUS_API IQuadMenu* GetIQuadMenu

(

)

Search for all occurrences

Remarks:

This method will return a pointer to the IQuadMenu.

MENUS_API void ReleaseIQuadMenu

(

IQuadMenu *

)

Search for all occurrences

Remarks:

This method will release the specified IQuadMenu.

Parameters:

IMenuItem *

A pointer to the IQuadMenu you wish to release.