[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{char* }{className}, \param{char* }{baseClass1}, \param{char* }{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 createable (typically, it's an abstract class).

\membersection{wxClassInfo::FindClass}

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

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

\membersection{wxClassInfo::GetBaseClassName1}

\constfunc{char*}{GetBaseClassName1}{\void}

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

\membersection{wxClassInfo::GetBaseClassName2}

\constfunc{char*}{GetBaseClassName2}{\void}

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

\membersection{wxClassInfo::GetClassName}

\constfunc{char *}{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 wxWindows 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
	23	\func{}{wxClassInfo}{\param{char* }{className}, \param{char* }{baseClass1}, \param{char* }{baseClass2},
	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
	34	dynamically createable (typically, it's an abstract class).
	35
	36	\membersection{wxClassInfo::FindClass}
	37
	38	\func{static wxClassInfo }{FindClass}{\param{char }{name}}
	39
	40	Finds the wxClassInfo object for a class of the given string name.
	41
	42	\membersection{wxClassInfo::GetBaseClassName1}
	43
	44	\constfunc{char*}{GetBaseClassName1}{\void}
	45
	46	Returns the name of the first base class (NULL if none).
	47
	48	\membersection{wxClassInfo::GetBaseClassName2}
	49
	50	\constfunc{char*}{GetBaseClassName2}{\void}
	51
	52	Returns the name of the second base class (NULL if none).
	53
	54	\membersection{wxClassInfo::GetClassName}
	55
	56	\constfunc{char *}{GetClassName}{\void}
	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
	71	of IsKindOf. Called in base wxWindows library initialization.
	72
	73	\membersection{wxClassInfo::IsKindOf}\label{wxclassinfoiskindof}
	74
	75	\func{bool}{IsKindOf}{\param{wxClassInfo* }{info}}
	76
	77	Returns TRUE if this class is a kind of (inherits from) the given class.
	78
	79