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{Include files}
  12
  13 <wx/object.h>
  14
  15 \wxheading{Library}
  16
  17 \helpref{wxBase}{librarieslist}
  18
  19 \wxheading{See also}
  20
  21 \helpref{Overview}{wxclassinfooverview}, \helpref{wxObject}{wxobject}
  22
  23 \latexignore{\rtfignore{\wxheading{Members}}}
  24
  25 \membersection{wxClassInfo::wxClassInfo}\label{wxclassinfoctor}
  26
  27 \func{}{wxClassInfo}{\param{const wxChar * }{className}, \param{const wxClassInfo * }{baseClass1}, \param{const wxClassInfo * }{baseClass2},
  28  \param{int}{ size}, \param{wxObjectConstructorFn }{fn}}
  29
  30 Constructs a wxClassInfo object. The supplied macros implicitly construct objects of this
  31 class, so there is no need to create such objects explicitly in an application.
  32
  33 \membersection{wxClassInfo::CreateObject}\label{wxclassinfocreateobject}
  34
  35 \constfunc{wxObject*}{CreateObject}{\void}
  36
  37 Creates an object of the appropriate kind. Returns NULL if the class has not been declared
  38 dynamically creatable (typically, it is an abstract class).
  39
  40 \membersection{wxClassInfo::FindClass}\label{wxclassinfofindclass}
  41
  42 \func{static wxClassInfo *}{FindClass}{\param{wxChar * }{name}}
  43
  44 Finds the wxClassInfo object for a class of the given string name.
  45
  46 \membersection{wxClassInfo::GetBaseClassName1}\label{wxclassinfogetbaseclassname1}
  47
  48 \constfunc{wxChar *}{GetBaseClassName1}{\void}
  49
  50 Returns the name of the first base class (NULL if none).
  51
  52 \membersection{wxClassInfo::GetBaseClassName2}\label{wxclassinfogetbaseclassname2}
  53
  54 \constfunc{wxChar *}{GetBaseClassName2}{\void}
  55
  56 Returns the name of the second base class (NULL if none).
  57
  58 \membersection{wxClassInfo::GetClassName}\label{wxclassinfogetclassname}
  59
  60 \constfunc{wxChar *}{GetClassName}{\void}
  61
  62 Returns the string form of the class name.
  63
  64 \membersection{wxClassInfo::GetSize}\label{wxclassinfogetsize}
  65
  66 \constfunc{int}{GetSize}{\void}
  67
  68 Returns the size of the class.
  69
  70 \membersection{wxClassInfo::InitializeClasses}\label{wxclassinfoinitializeclasses}
  71
  72 \func{static void}{InitializeClasses}{\void}
  73
  74 Initializes pointers in the wxClassInfo objects for fast execution
  75 of IsKindOf. Called in base wxWidgets library initialization.
  76
  77 \membersection{wxClassInfo::IsDynamic}\label{wxclassinfoisdynamic}
  78
  79 \constfunc{bool}{IsDynamic}{\void}
  80
  81 Returns true if this class info can create objects of the associated class.
  82
  83 \membersection{wxClassInfo::IsKindOf}\label{wxclassinfoiskindof}
  84
  85 \func{bool}{IsKindOf}{\param{wxClassInfo* }{info}}
  86
  87 Returns true if this class is a kind of (inherits from) the given class.
  88
  89