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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.HeaderColumn:
==========================================================================================================================================
|phoenix_title| **wx.HeaderColumn**
==========================================================================================================================================
Represents a column header in controls displaying tabular data such as :ref:`wx.dataview.DataViewCtrl` or :ref:`wx.grid.Grid`.
Notice that this is an abstract base class which is implemented (usually using the information stored in the associated control) by the different controls using :ref:`wx.HeaderCtrl`. As the control only needs to retrieve the information about the column, this class defines only the methods for accessing the various column properties but not for changing them as the setters might not be needed at all, e.g. if the column attributes can only be changed via the methods of the main associated control (this is the case for :ref:`wx.grid.Grid` for example). If you do want to allow changing them directly using the column itself, you should inherit from :ref:`wx.SettableHeaderColumn` instead of this class.
Finally, if you don't already store the column information at all anywhere, you should use the concrete :ref:`wx.HeaderColumnSimple` class and :ref:`wx.HeaderCtrlSimple`.
|
|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>HeaderColumn</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.HeaderColumn_inheritance.png" alt="Inheritance diagram of HeaderColumn" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.HeaderColumn.html" title="wx.HeaderColumn" alt="" coords="5,5,144,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.SettableHeaderColumn`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.HeaderColumn.GetAlignment` Returns the current column alignment.
:meth:`~wx.HeaderColumn.GetBitmap` Returns the bitmap in the header of the column, if any.
:meth:`~wx.HeaderColumn.GetFlags` Get the column flags.
:meth:`~wx.HeaderColumn.GetMinWidth` Return the minimal column width.
:meth:`~wx.HeaderColumn.GetTitle` Get the text shown in the column header.
:meth:`~wx.HeaderColumn.GetWidth` Returns the current width of the column.
:meth:`~wx.HeaderColumn.HasFlag` Return ``True`` if the specified flag is currently set for this column.
:meth:`~wx.HeaderColumn.IsHidden` Returns ``True`` if the column is currently hidden.
:meth:`~wx.HeaderColumn.IsReorderable` Returns ``True`` if the column can be dragged by user to change its order.
:meth:`~wx.HeaderColumn.IsResizeable` Return ``True`` if the column can be resized by the user.
:meth:`~wx.HeaderColumn.IsShown` Returns ``True`` if the column is currently shown.
:meth:`~wx.HeaderColumn.IsSortKey` Returns ``True`` if the column is currently used for sorting.
:meth:`~wx.HeaderColumn.IsSortOrderAscending` Returns ``True``, if the sort order is ascending.
:meth:`~wx.HeaderColumn.IsSortable` Returns ``True`` if the column can be clicked by user to sort the control contents by the field in this column.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.HeaderColumn.Alignment` See :meth:`~wx.HeaderColumn.GetAlignment`
:attr:`~wx.HeaderColumn.Bitmap` See :meth:`~wx.HeaderColumn.GetBitmap`
:attr:`~wx.HeaderColumn.Flags` See :meth:`~wx.HeaderColumn.GetFlags`
:attr:`~wx.HeaderColumn.Hidden` See :meth:`~wx.HeaderColumn.IsHidden`
:attr:`~wx.HeaderColumn.MinWidth` See :meth:`~wx.HeaderColumn.GetMinWidth`
:attr:`~wx.HeaderColumn.Reorderable` See :meth:`~wx.HeaderColumn.IsReorderable`
:attr:`~wx.HeaderColumn.Resizeable` See :meth:`~wx.HeaderColumn.IsResizeable`
:attr:`~wx.HeaderColumn.Shown` See :meth:`~wx.HeaderColumn.IsShown`
:attr:`~wx.HeaderColumn.SortKey` See :meth:`~wx.HeaderColumn.IsSortKey`
:attr:`~wx.HeaderColumn.SortOrderAscending` See :meth:`~wx.HeaderColumn.IsSortOrderAscending`
:attr:`~wx.HeaderColumn.Sortable` See :meth:`~wx.HeaderColumn.IsSortable`
:attr:`~wx.HeaderColumn.Title` See :meth:`~wx.HeaderColumn.GetTitle`
:attr:`~wx.HeaderColumn.Width` See :meth:`~wx.HeaderColumn.GetWidth`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.HeaderColumn(object)
Represents a column header in controls displaying tabular data such as
DataViewCtrl or Grid.
.. method:: GetAlignment(self)
Returns the current column alignment.
:rtype: :ref:`wx.Alignment`
:returns:
One of ``wx.ALIGN_CENTRE``, ``wx.ALIGN_LEFT`` or ``wx.ALIGN_RIGHT``.
.. method:: GetBitmap(self)
Returns the bitmap in the header of the column, if any.
If the column has no associated bitmap, NullBitmap should be returned.
:rtype: :ref:`wx.Bitmap`
.. method:: GetFlags(self)
Get the column flags.
This method retrieves all the flags at once, you can also use :meth:`HasFlag` to test for any individual flag or :meth:`IsResizeable` , :meth:`IsSortable` , :meth:`IsReorderable` and :meth:`IsHidden` to test for particular flags.
:rtype: `int`
.. method:: GetMinWidth(self)
Return the minimal column width.
:rtype: `int`
:returns:
The minimal width such that the user can't resize the column to lesser size (notice that it is still possible to set the column width to smaller value from the program code). Return 0 from here to allow resizing the column to arbitrarily small size.
.. method:: GetTitle(self)
Get the text shown in the column header.
:rtype: `string`
.. method:: GetWidth(self)
Returns the current width of the column.
:rtype: `int`
:returns:
Width of the column in pixels, never ``wx.COL_WIDTH_DEFAULT`` or ``wx.COL_WIDTH_AUTOSIZE``.
.. method:: HasFlag(self, flag)
Return ``True`` if the specified flag is currently set for this column.
:param `flag`:
:type `flag`: int
:rtype: `bool`
.. method:: IsHidden(self)
Returns ``True`` if the column is currently hidden.
This corresponds to ``wx.COL_HIDDEN`` flag which is off by default.
:rtype: `bool`
.. method:: IsReorderable(self)
Returns ``True`` if the column can be dragged by user to change its order.
This corresponds to ``wx.COL_REORDERABLE`` flag which is on by default.
:rtype: `bool`
.. method:: IsResizeable(self)
Return ``True`` if the column can be resized by the user.
Equivalent to HasFlag(wxCOL_RESIZABLE).
:rtype: `bool`
.. method:: IsShown(self)
Returns ``True`` if the column is currently shown.
This corresponds to the absence of ``wx.COL_HIDDEN`` flag.
:rtype: `bool`
.. method:: IsSortKey(self)
Returns ``True`` if the column is currently used for sorting.
:rtype: `bool`
.. method:: IsSortOrderAscending(self)
Returns ``True``, if the sort order is ascending.
Notice that it only makes sense to call this function if the column is used for sorting at all, i.e. if :meth:`IsSortKey` returns ``True``.
:rtype: `bool`
.. method:: IsSortable(self)
Returns ``True`` if the column can be clicked by user to sort the control contents by the field in this column.
This corresponds to ``wx.COL_SORTABLE`` flag which is off by default.
:rtype: `bool`
.. attribute:: Alignment
See :meth:`~wx.HeaderColumn.GetAlignment`
.. attribute:: Bitmap
See :meth:`~wx.HeaderColumn.GetBitmap`
.. attribute:: Flags
See :meth:`~wx.HeaderColumn.GetFlags`
.. attribute:: Hidden
See :meth:`~wx.HeaderColumn.IsHidden`
.. attribute:: MinWidth
See :meth:`~wx.HeaderColumn.GetMinWidth`
.. attribute:: Reorderable
See :meth:`~wx.HeaderColumn.IsReorderable`
.. attribute:: Resizeable
See :meth:`~wx.HeaderColumn.IsResizeable`
.. attribute:: Shown
See :meth:`~wx.HeaderColumn.IsShown`
.. attribute:: SortKey
See :meth:`~wx.HeaderColumn.IsSortKey`
.. attribute:: SortOrderAscending
See :meth:`~wx.HeaderColumn.IsSortOrderAscending`
.. attribute:: Sortable
See :meth:`~wx.HeaderColumn.IsSortable`
.. attribute:: Title
See :meth:`~wx.HeaderColumn.GetTitle`
.. attribute:: Width
See :meth:`~wx.HeaderColumn.GetWidth`
|
