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{See also}
  16
  17 \helpref{Overview}{wxclassinfooverview}, \helpref{wxObject}{wxobject}
  18
  19 \latexignore{\rtfignore{\wxheading{Members}}}
  20
  21 \membersection{wxClassInfo::wxClassInfo}\label{wxclassinfoconstr}
  22
  23 \func{}{wxClassInfo}{\param{wxChar * }{className}, \param{wxChar * }{baseClass1}, \param{wxChar * }{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 creatable (typically, it is an abstract class).
  35
  36 \membersection{wxClassInfo::FindClass}
  37
  38 \func{static wxClassInfo *}{FindClass}{\param{wxChar * }{name}}
  39
  40 Finds the wxClassInfo object for a class of the given string name.
  41
  42 \membersection{wxClassInfo::GetBaseClassName1}
  43
  44 \constfunc{wxChar *}{GetBaseClassName1}{\void}
  45
  46 Returns the name of the first base class (NULL if none).
  47
  48 \membersection{wxClassInfo::GetBaseClassName2}
  49
  50 \constfunc{wxChar *}{GetBaseClassName2}{\void}
  51
  52 Returns the name of the second base class (NULL if none).
  53
  54 \membersection{wxClassInfo::GetClassName}
  55
  56 \constfunc{wxChar *}{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 wxWidgets 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