CursorSpec Class Reference

#include <CursorSpec.h>

Public Types
typedef object_type	data_type

Public Member Functions
	CursorSpec ()
	CursorSpec (CreateCursorBitmapProc customDrawCallback, CursorID id)
	CursorSpec (CursorID id)
	CursorSpec (const PluginID &plugInId, CursorID id)
	CursorSpec (const IDFile &resFile, CursorID id)
	CursorSpec (const CursorSpec &spec)
	CursorSpec (const PluginID &plugInId, const IDFile &resFile, CursorID id, CreateCursorBitmapProc customDrawCallback, bool32 bDynamicBitmap=kFalse)
CursorSpec &	operator= (const CursorSpec &spec)
bool	operator== (const CursorSpec &spec) const
PluginID	GetPlugInID () const
IDFile	GetResourceFile () const
CursorID	GetID () const
CreateCursorBitmapProc	GetCustomBitmapCreationProc () const
bool32	GetDynamicCallback () const

Detailed Description

Data type used to refer to cursor resources. Contains both a PluginID and a CursorID to avoid potential conflicts between plugins. Can also contain a reference to a separate resource file.

Constructor & Destructor Documentation

CursorSpec::CursorSpec ( )

inline

Empty constructor

CursorSpec::CursorSpec ( CreateCursorBitmapProc  customDrawCallback, CursorID  id  )

inline

constructor for cursors with image data

CursorSpec::CursorSpec ( CursorID  id )

inline

Constructor: CursorID only

CursorSpec::CursorSpec ( const PluginID &  plugInId, CursorID  id  )

inline

Constructor: PluginID and CursorID

CursorSpec::CursorSpec ( const IDFile &  resFile, CursorID  id  )

inline

Constructor: IDFile and CursorID

CursorSpec::CursorSpec ( const CursorSpec &  spec )

inline

Copy Constructor

CursorSpec::CursorSpec ( const PluginID &  plugInId, const IDFile &  resFile, CursorID  id, CreateCursorBitmapProc  customDrawCallback, bool32  bDynamicBitmap = kFalse  )

inline

Constructor: PluginID, IDFile and CursorID (not sure why is this needed)

Parameters

customDrawCallback	[IN]: Pointer to a callback routine for the generation of a custom cursor.
bDynamicBitmap	[IN]: If kTrue, then the customDrawCallback might return a different cursor every time it is called. For example, if the cursor shows the X, Y position of the mouse, then kTrue should be passed to ensure that the callback gets a chance to be called.

Member Function Documentation

CreateCursorBitmapProc CursorSpec::GetCustomBitmapCreationProc ( ) const

inline

Get the custom draw proc, if any

bool32 CursorSpec::GetDynamicCallback ( ) const

inline

Get whether or not the custom draw proc's results are dynamic.

CursorID CursorSpec::GetID ( ) const

inline

Get the CursorID

PluginID CursorSpec::GetPlugInID ( ) const

inline

Get the PluginID

IDFile CursorSpec::GetResourceFile ( ) const

inline

Get the IDFile

CursorSpec& CursorSpec::operator= ( const CursorSpec &  spec )

inline

assignment operator

bool CursorSpec::operator== ( const CursorSpec &  spec ) const

inline

equality operator