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