ClassDesc Class Reference

#include <node.h>

Class Description

This structure represents and describes a class.

Examples:

Definition at line 22 of file node.h.

Public Member Functions
	ClassDesc (const ClassDesc *pParent0, const ClassDesc *pParent1, const QString &sName, const QString &sDisplayName, creator *pCreator, int iVersion=0, int iStreamVersion=0)
	Do not construct this structure directly, use the DECLARE_CLASS and #IMLEMENT_CLASS macros. More...
const ClassDesc *	Parent (unsigned int iIndex=0) const
	Get the class description for the parent class, or 0 if there is no parent. More...
const QString &	Name (void) const
	Returns the name of the class. More...
const QString &	DisplayName (void) const
	Returns the displayname of the class. More...
void	SetDisplayName (const QString &sName)
	Sets the displayname of the class. More...
bool	IsDerivedFrom (const ClassDesc *pClass) const
	Returns true if this class is derived from pClass. More...
class Node *	CreateInstances (int iCount=1) const
	Create instances of the class. More...
int	Version (void) const
	returns the version of the class. More...

Static Public Member Functions
static const ClassDesc *	ByName (const QString &sName)
	Returns a class by its name, or 0 if the class is not found. More...

Public Attributes
int	m_iStreamVersion

Friends
class	Node
class	Stream

Type enumeration functions
const ClassDesc *	Next (void) const
	Returns the next ClassDesc structure. Used when you want to enumerate all the classes (See also First()) More...
static const ClassDesc *	First (void)
	Returns the first ClassDesc (See also Next()). More...

Constructor & Destructor Documentation

ClassDesc	(	const ClassDesc *	pParent0,
		const ClassDesc *	pParent1,
		const QString &	sName,
		const QString &	sDisplayName,
		creator *	pCreator,
		int	iVersion = 0,
		int	iStreamVersion = 0
	)

Do not construct this structure directly, use the DECLARE_CLASS and #IMLEMENT_CLASS macros.

Member Function Documentation

const ClassDesc* Parent

(

unsigned int

iIndex = 0

)

const

Get the class description for the parent class, or 0 if there is no parent.

const QString& Name

(

void

)

const

Returns the name of the class.

const QString& DisplayName

(

void

)

const

Returns the displayname of the class.

void SetDisplayName

(

const QString &

sName

)

Sets the displayname of the class.

bool IsDerivedFrom

(

const ClassDesc *

pClass

)

const

Returns true if this class is derived from pClass.

class Node* CreateInstances

(

int

iCount = 1

)

const

Create instances of the class.

static const ClassDesc* First ( void  )

static

Returns the first ClassDesc (See also Next()).

const ClassDesc* Next ( void  ) const

inline

Returns the next ClassDesc structure. Used when you want to enumerate all the classes (See also First())

Definition at line 58 of file node.h.

{ return m_pNext; };

static const ClassDesc* ByName ( const QString &  sName )

static

Returns a class by its name, or 0 if the class is not found.

This method may be slow (linear search)

int Version

(

void

)

const

returns the version of the class.

Friends And Related Function Documentation

friend class Node

friend

Definition at line 67 of file node.h.

friend class Stream

friend

Definition at line 68 of file node.h.

Member Data Documentation

int m_iStreamVersion

Definition at line 34 of file node.h.

---

The documentation for this class was generated from the following file:

• Mudbox/node.h