File: wx.ClassInfo.txt

package info (click to toggle)
wxpython4.0 4.2.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 232,540 kB
  • sloc: cpp: 958,937; python: 233,059; ansic: 150,441; makefile: 51,662; sh: 8,687; perl: 1,563; javascript: 584; php: 326; xml: 200
file content (253 lines) | stat: -rw-r--r-- 6,323 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.ClassInfo:

==========================================================================================================================================
|phoenix_title|  **wx.ClassInfo**
==========================================================================================================================================

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 ``DECLARE_DYNAMIC_CLASS``  and ``IMPLEMENT_DYNAMIC_CLASS``. 





         



.. seealso:: :ref:`wx.ClassInfo`, :ref:`wx.Object`    







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>ClassInfo</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.ClassInfo_inheritance.png" alt="Inheritance diagram of ClassInfo" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.ClassInfo.html" title="wx.ClassInfo" alt="" coords="5,5,111,35"/> </map> 
   </p>
   </div>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.ClassInfo.__init__`                                                   Constructs a :ref:`wx.ClassInfo`  object.
:meth:`~wx.ClassInfo.CreateObject`                                               Creates an object of the appropriate kind.
:meth:`~wx.ClassInfo.FindClass`                                                  Finds the :ref:`wx.ClassInfo`  object for a class with the given `name`.
:meth:`~wx.ClassInfo.GetBaseClassName1`                                          Returns the name of the first base class (``None`` if none).
:meth:`~wx.ClassInfo.GetBaseClassName2`                                          Returns the name of the second base class (``None`` if none).
:meth:`~wx.ClassInfo.GetClassName`                                               Returns the string form of the class name.
:meth:`~wx.ClassInfo.GetSize`                                                    Returns the size of the class.
:meth:`~wx.ClassInfo.IsDynamic`                                                  Returns ``True`` if this class info can create objects of the associated class.
:meth:`~wx.ClassInfo.IsKindOf`                                                   Returns ``True`` if this class is a kind of (inherits from) the given class.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.ClassInfo.BaseClassName1`                                             See :meth:`~wx.ClassInfo.GetBaseClassName1`
:attr:`~wx.ClassInfo.BaseClassName2`                                             See :meth:`~wx.ClassInfo.GetBaseClassName2`
:attr:`~wx.ClassInfo.ClassName`                                                  See :meth:`~wx.ClassInfo.GetClassName`
:attr:`~wx.ClassInfo.Size`                                                       See :meth:`~wx.ClassInfo.GetSize`
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.ClassInfo(object)

   This class stores meta-information about classes.



   .. method:: CreateObject(self)

      Creates an object of the appropriate kind.                  

                

      :rtype: :ref:`wx.Object`







      :returns: 

         ``None`` if the class has not been declared dynamically creatable (typically, this happens for abstract classes).   








   .. staticmethod:: FindClass(className)

      Finds the :ref:`wx.ClassInfo`  object for a class with the given `name`.                  


      :param `className`: 
      :type `className`: string




      :rtype: :ref:`wx.ClassInfo`








   .. method:: GetBaseClassName1(self)

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

      :rtype: :ref:`wx.Char`








   .. method:: GetBaseClassName2(self)

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

      :rtype: :ref:`wx.Char`








   .. method:: GetClassName(self)

      Returns the string form of the class name.                  

      :rtype: :ref:`wx.Char`








   .. method:: GetSize(self)

      Returns the size of the class.                  

      :rtype: `int`








   .. method:: IsDynamic(self)

      Returns ``True`` if this class info can create objects of the associated class.                  

      :rtype: `bool`








   .. method:: IsKindOf(self, info)

      Returns ``True`` if this class is a kind of (inherits from) the given class.                  


      :param `info`: 
      :type `info`: wx.ClassInfo




      :rtype: `bool`








   .. attribute:: BaseClassName1

      See :meth:`~wx.ClassInfo.GetBaseClassName1`


   .. attribute:: BaseClassName2

      See :meth:`~wx.ClassInfo.GetBaseClassName2`


   .. attribute:: ClassName

      See :meth:`~wx.ClassInfo.GetClassName`


   .. attribute:: Size

      See :meth:`~wx.ClassInfo.GetSize`