CursorIdent Class Reference

Used in the cursor stack - holds a pointer to a cursor and an identifying ID. More...

#include <csrstack.h>

List of all members.

Public Member Functions

 CursorIdent ()
 Default constructor for a CursorIdent object. Defaults fields to zero so that new objects are invalid.
 ~CursorIdent ()
 Default constructor for CursorIdent objects. Sets all fields back to zero so that a destructed object is invalid.
INT32 StoreNewCursor (Cursor *NewCursor)
 This function stores a pointer to a cursor in an ident object and generates a new unique ID which it returns, as well as storing it in the object itself. It also increments the static NextUniqueID counter.

Public Attributes

Cursor * pCursor
INT32 UniqueID

Static Public Attributes

static INT32 NextUniqueID = 1


Detailed Description

Used in the cursor stack - holds a pointer to a cursor and an identifying ID.

Author:
Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com>
Date:
27/1/95
See also:
CursorStack

Definition at line 119 of file csrstack.h.


Constructor & Destructor Documentation

CursorIdent::CursorIdent (   ) 
 

Default constructor for a CursorIdent object. Defaults fields to zero so that new objects are invalid.

Author:
Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com>
Date:
27/1/95
Parameters:
- [INPUTS]
- [OUTPUTS]
Returns:
-

Errors: -

See also:
-

Definition at line 739 of file csrstack.cpp.

00740     {
00741         pCursor = 0;
00742         UniqueID = 0;
00743     }

CursorIdent::~CursorIdent (   ) 
 

Default constructor for CursorIdent objects. Sets all fields back to zero so that a destructed object is invalid.

Author:
Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com>
Date:
27/1/95
Parameters:
- [INPUTS]
- [OUTPUTS]
Returns:
-

Errors: -

See also:
-

Definition at line 761 of file csrstack.cpp.

00762     {
00763         pCursor = 0;
00764         UniqueID = 0;
00765     }


Member Function Documentation

INT32 CursorIdent::StoreNewCursor (  Cursor *  NewCursor  ) 
 

This function stores a pointer to a cursor in an ident object and generates a new unique ID which it returns, as well as storing it in the object itself. It also increments the static NextUniqueID counter.

Author:
Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com>
Date:
27/1/95
Parameters:
NewCursor points at the cursor that's being stored in this ident object [INPUTS]
- [OUTPUTS]
Returns:
new unique ID (which is also stored in the object)

Errors: -

See also:
-

Definition at line 784 of file csrstack.cpp.

00785 {
00786     pCursor = NewCursor;
00787     UniqueID = NextUniqueID++;
00788     return UniqueID;
00789 }


Member Data Documentation

INT32 CursorIdent::NextUniqueID = 1 [static]
 

Definition at line 125 of file csrstack.h.

Cursor* CursorIdent::pCursor
 

Definition at line 122 of file csrstack.h.

INT32 CursorIdent::UniqueID
 

Definition at line 123 of file csrstack.h.


The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:53:18 2007 for Camelot by  doxygen 1.4.4