[wxWidgets.git] / docs / latex / wx / clasinfo.tex

\section{\class{wxClassInfo}}\label{wxclassinfo}

This class stores meta-information about classes. Instances of this class are
not generally defined directly by an application, but indirectly through use
of macros such as {\bf DECLARE\_DYNAMIC\_CLASS} and {\bf IMPLEMENT\_DYNAMIC\_CLASS}.

\wxheading{Derived from}

No parent class.

\wxheading{Include files}

<wx/object.h>

\wxheading{See also}

\helpref{Overview}{wxclassinfooverview}, \helpref{wxObject}{wxobject}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxClassInfo::wxClassInfo}\label{wxclassinfoconstr}

\func{}{wxClassInfo}{\param{wxChar * }{className}, \param{wxChar * }{baseClass1}, \param{wxChar * }{baseClass2},
 \param{int}{ size}, \param{wxObjectConstructorFn }{fn}}

Constructs a wxClassInfo object. The supplied macros implicitly construct objects of this
class, so there is no need to create such objects explicitly in an application.

\membersection{wxClassInfo::CreateObject}

\func{wxObject*}{CreateObject}{\void}

Creates an object of the appropriate kind. Returns NULL if the class has not been declared
dynamically creatable (typically, it is an abstract class).

\membersection{wxClassInfo::FindClass}

\func{static wxClassInfo *}{FindClass}{\param{wxChar * }{name}}

Finds the wxClassInfo object for a class of the given string name.

\membersection{wxClassInfo::GetBaseClassName1}

\constfunc{wxChar *}{GetBaseClassName1}{\void}

Returns the name of the first base class (NULL if none).

\membersection{wxClassInfo::GetBaseClassName2}

\constfunc{wxChar *}{GetBaseClassName2}{\void}

Returns the name of the second base class (NULL if none).

\membersection{wxClassInfo::GetClassName}

\constfunc{wxChar *}{GetClassName}{\void}

Returns the string form of the class name.

\membersection{wxClassInfo::GetSize}

\constfunc{int}{GetSize}{\void}

Returns the size of the class.

\membersection{wxClassInfo::InitializeClasses}

\func{static void}{InitializeClasses}{\void}

Initializes pointers in the wxClassInfo objects for fast execution
of IsKindOf. Called in base wxWidgets library initialization.

\membersection{wxClassInfo::IsKindOf}\label{wxclassinfoiskindof}

\func{bool}{IsKindOf}{\param{wxClassInfo* }{info}}

Returns true if this class is a kind of (inherits from) the given class.
Commit	Line	Data
a660d684 KB	1	\section{\class{wxClassInfo}}\label{wxclassinfo}
	2
	3	This class stores meta-information about classes. Instances of this class are
	4	not generally defined directly by an application, but indirectly through use
	5	of macros such as {\bf DECLARE\_DYNAMIC\_CLASS} and {\bf IMPLEMENT\_DYNAMIC\_CLASS}.
	6
	7	\wxheading{Derived from}
	8
	9	No parent class.
	10
954b8ae6 JS	11	\wxheading{Include files}
	12
	13	<wx/object.h>
	14
a660d684 KB	15	\wxheading{See also}
a660d684 KB	16
2bb0cd28	17	\helpref{Overview}{wxclassinfooverview}, \helpref{wxObject}{wxobject}
a660d684 KB	18
	19	\latexignore{\rtfignore{\wxheading{Members}}}
	20
	21	\membersection{wxClassInfo::wxClassInfo}\label{wxclassinfoconstr}
	22
7bef714c	23	\func{}{wxClassInfo}{\param{wxChar * }{className}, \param{wxChar * }{baseClass1}, \param{wxChar * }{baseClass2},
a660d684 KB	24	\param{int}{ size}, \param{wxObjectConstructorFn }{fn}}
	25
	26	Constructs a wxClassInfo object. The supplied macros implicitly construct objects of this
	27	class, so there is no need to create such objects explicitly in an application.
	28
	29	\membersection{wxClassInfo::CreateObject}
	30
	31	\func{wxObject*}{CreateObject}{\void}
	32
	33	Creates an object of the appropriate kind. Returns NULL if the class has not been declared
f6bcfd97	34	dynamically creatable (typically, it is an abstract class).
a660d684 KB	35
	36	\membersection{wxClassInfo::FindClass}
	37
7bef714c	38	\func{static wxClassInfo }{FindClass}{\param{wxChar }{name}}
a660d684 KB	39
	40	Finds the wxClassInfo object for a class of the given string name.
	41
	42	\membersection{wxClassInfo::GetBaseClassName1}
	43
7bef714c	44	\constfunc{wxChar *}{GetBaseClassName1}{\void}
a660d684 KB	45
	46	Returns the name of the first base class (NULL if none).
	47
	48	\membersection{wxClassInfo::GetBaseClassName2}
	49
7bef714c	50	\constfunc{wxChar *}{GetBaseClassName2}{\void}
a660d684 KB	51
	52	Returns the name of the second base class (NULL if none).
	53
	54	\membersection{wxClassInfo::GetClassName}
	55
7bef714c	56	\constfunc{wxChar *}{GetClassName}{\void}
a660d684 KB	57
	58	Returns the string form of the class name.
	59
	60	\membersection{wxClassInfo::GetSize}
	61
	62	\constfunc{int}{GetSize}{\void}
	63
	64	Returns the size of the class.
	65
	66	\membersection{wxClassInfo::InitializeClasses}
	67
	68	\func{static void}{InitializeClasses}{\void}
	69
	70	Initializes pointers in the wxClassInfo objects for fast execution
fc2171bd	71	of IsKindOf. Called in base wxWidgets library initialization.
a660d684 KB	72
	73	\membersection{wxClassInfo::IsKindOf}\label{wxclassinfoiskindof}
	74
	75	\func{bool}{IsKindOf}{\param{wxClassInfo* }{info}}
	76
cc81d32f	77	Returns true if this class is a kind of (inherits from) the given class.
a660d684 KB	78
a660d684 KB	79