]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/clasinfo.tex
* Socket doc update.
[wxWidgets.git] / docs / latex / wx / clasinfo.tex
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
11 \wxheading{See also}
12
13 \helpref{Overview}{wxclassinfooverview}, \helpref{wxObject}{wxobject}
14
15 \latexignore{\rtfignore{\wxheading{Members}}}
16
17 \membersection{wxClassInfo::wxClassInfo}\label{wxclassinfoconstr}
18
19 \func{}{wxClassInfo}{\param{char* }{className}, \param{char* }{baseClass1}, \param{char* }{baseClass2},
20 \param{int}{ size}, \param{wxObjectConstructorFn }{fn}}
21
22 Constructs a wxClassInfo object. The supplied macros implicitly construct objects of this
23 class, so there is no need to create such objects explicitly in an application.
24
25 \membersection{wxClassInfo::CreateObject}
26
27 \func{wxObject*}{CreateObject}{\void}
28
29 Creates an object of the appropriate kind. Returns NULL if the class has not been declared
30 dynamically createable (typically, it's an abstract class).
31
32 \membersection{wxClassInfo::FindClass}
33
34 \func{static wxClassInfo *}{FindClass}{\param{char* }{name}}
35
36 Finds the wxClassInfo object for a class of the given string name.
37
38 \membersection{wxClassInfo::GetBaseClassName1}
39
40 \constfunc{char*}{GetBaseClassName1}{\void}
41
42 Returns the name of the first base class (NULL if none).
43
44 \membersection{wxClassInfo::GetBaseClassName2}
45
46 \constfunc{char*}{GetBaseClassName2}{\void}
47
48 Returns the name of the second base class (NULL if none).
49
50 \membersection{wxClassInfo::GetClassName}
51
52 \constfunc{char *}{GetClassName}{\void}
53
54 Returns the string form of the class name.
55
56 \membersection{wxClassInfo::GetSize}
57
58 \constfunc{int}{GetSize}{\void}
59
60 Returns the size of the class.
61
62 \membersection{wxClassInfo::InitializeClasses}
63
64 \func{static void}{InitializeClasses}{\void}
65
66 Initializes pointers in the wxClassInfo objects for fast execution
67 of IsKindOf. Called in base wxWindows library initialization.
68
69 \membersection{wxClassInfo::IsKindOf}\label{wxclassinfoiskindof}
70
71 \func{bool}{IsKindOf}{\param{wxClassInfo* }{info}}
72
73 Returns TRUE if this class is a kind of (inherits from) the given class.
74
75