ItemID Class Reference
 
 
 
ItemID Class Reference

#include <imenus.h>

Inheritance diagram for ItemID:
MaxHeapOperators

Class Description

An ID for a Menu or Menu Item.

Note:
This class is used internally. Methods that are marked as internal should not be used.
See also:
Class IMenu, Class IMenuItem, Class IMenuGlobalContext

Public Member Functions

  ItemID ()
void  Null ()

Public Attributes

IMenu mpMenu
  Pointer to an IMenu.
IMenuItem mpItem
  Pointer to an IMenuItem.

Friends

bool  operator== (ItemID &a, ItemID &b)
bool  operator!= (ItemID &a, ItemID &b)

Constructor & Destructor Documentation

ItemID ( ) [inline]
Remarks:
This method is used internally.

Constructor. Initialized mpMenu(NULL) and mpItem(NULL).
Default Implementation:
{ }
: mpMenu(NULL), mpItem(NULL) { }

Member Function Documentation

void Null ( ) [inline]
Remarks:
This method is used internally.

Set mpMenu = NULL and mpItem = NULL.
{ mpMenu = NULL; mpItem = NULL; }

Friends And Related Function Documentation

bool operator== ( ItemID a,
ItemID b 
) [friend]
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.
{
        if ( a.mpMenu  != b.mpMenu  ||
                 a.mpItem  != b.mpItem )
                return false;
        else
                return true;
}
bool operator!= ( ItemID a,
ItemID b 
) [friend]
Remarks:
This method is used internally.

This operator tests for inequality of two ItemID's.
Parameters:
ItemID& a, ItemID& b

The two ItemID's you wish to test for inequality.
Default Implementation:
{ return !(a == b); }
{ return !(a == b); }

Member Data Documentation