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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
|
.. 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.SettableHeaderColumn:
==========================================================================================================================================
|phoenix_title| **wx.SettableHeaderColumn**
==========================================================================================================================================
Adds methods to set the column attributes to :ref:`wx.HeaderColumn`.
This class adds setters for the column attributes defined by :ref:`wx.HeaderColumn`. It is still an abstract base class and needs to be implemented before using it with :ref:`wx.HeaderCtrl`.
|
|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>SettableHeaderColumn</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.SettableHeaderColumn_inheritance.png" alt="Inheritance diagram of SettableHeaderColumn" 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.SettableHeaderColumn.html" title="wx.SettableHeaderColumn" alt="" coords="5,83,197,112"/> <area shape="rect" id="node2" href="wx.HeaderColumn.html" title="wx.HeaderColumn" alt="" coords="32,5,171,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.dataview.DataViewColumn`, :ref:`wx.HeaderColumnSimple`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.SettableHeaderColumn.ChangeFlag` Set or clear the given flag.
:meth:`~wx.SettableHeaderColumn.ClearFlag` Clear the specified flag for the column.
:meth:`~wx.SettableHeaderColumn.SetAlignment` Set the alignment of the column header.
:meth:`~wx.SettableHeaderColumn.SetBitmap` Set the bitmap to be displayed in the column header.
:meth:`~wx.SettableHeaderColumn.SetFlag` Set the specified flag for the column.
:meth:`~wx.SettableHeaderColumn.SetFlags` Set the column flags.
:meth:`~wx.SettableHeaderColumn.SetHidden` Hide or show the column.
:meth:`~wx.SettableHeaderColumn.SetMinWidth` Set the minimal column width.
:meth:`~wx.SettableHeaderColumn.SetReorderable` Allow changing the column order by dragging it.
:meth:`~wx.SettableHeaderColumn.SetResizeable` Call this to enable or disable interactive resizing of the column by the user.
:meth:`~wx.SettableHeaderColumn.SetSortOrder` Sets this column as the sort key for the associated control.
:meth:`~wx.SettableHeaderColumn.SetSortable` Allow clicking the column to sort the control contents by the field in this column.
:meth:`~wx.SettableHeaderColumn.SetTitle` Set the text to display in the column header.
:meth:`~wx.SettableHeaderColumn.SetWidth` Set the column width.
:meth:`~wx.SettableHeaderColumn.ToggleFlag` Toggle the specified flag for the column.
:meth:`~wx.SettableHeaderColumn.ToggleSortOrder` Inverses the sort order.
:meth:`~wx.SettableHeaderColumn.UnsetAsSortKey` Don't use this column for sorting.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.SettableHeaderColumn.Alignment` See :meth:`~wx.SettableHeaderColumn.HeaderColumn.GetAlignment` and :meth:`~wx.SettableHeaderColumn.SetAlignment`
:attr:`~wx.SettableHeaderColumn.Bitmap` See :meth:`~wx.SettableHeaderColumn.HeaderColumn.GetBitmap` and :meth:`~wx.SettableHeaderColumn.SetBitmap`
:attr:`~wx.SettableHeaderColumn.Flags` See :meth:`~wx.SettableHeaderColumn.HeaderColumn.GetFlags` and :meth:`~wx.SettableHeaderColumn.SetFlags`
:attr:`~wx.SettableHeaderColumn.Hidden` See :meth:`~wx.SettableHeaderColumn.HeaderColumn.IsHidden` and :meth:`~wx.SettableHeaderColumn.SetHidden`
:attr:`~wx.SettableHeaderColumn.MinWidth` See :meth:`~wx.SettableHeaderColumn.HeaderColumn.GetMinWidth` and :meth:`~wx.SettableHeaderColumn.SetMinWidth`
:attr:`~wx.SettableHeaderColumn.Reorderable` See :meth:`~wx.SettableHeaderColumn.HeaderColumn.IsReorderable` and :meth:`~wx.SettableHeaderColumn.SetReorderable`
:attr:`~wx.SettableHeaderColumn.Resizeable` See :meth:`~wx.SettableHeaderColumn.HeaderColumn.IsResizeable` and :meth:`~wx.SettableHeaderColumn.SetResizeable`
:attr:`~wx.SettableHeaderColumn.Sortable` See :meth:`~wx.SettableHeaderColumn.HeaderColumn.IsSortable` and :meth:`~wx.SettableHeaderColumn.SetSortable`
:attr:`~wx.SettableHeaderColumn.Title` See :meth:`~wx.SettableHeaderColumn.HeaderColumn.GetTitle` and :meth:`~wx.SettableHeaderColumn.SetTitle`
:attr:`~wx.SettableHeaderColumn.Width` See :meth:`~wx.SettableHeaderColumn.HeaderColumn.GetWidth` and :meth:`~wx.SettableHeaderColumn.SetWidth`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.SettableHeaderColumn(HeaderColumn)
Adds methods to set the column attributes to HeaderColumn.
.. method:: ChangeFlag(self, flag, set)
Set or clear the given flag.
:param `flag`: The flag to set or clear.
:type `flag`: int
:param `set`: If ``True``, set the flag, i.e. equivalent to calling :meth:`SetFlag` , otherwise clear it, as :meth:`ClearFlag` .
:type `set`: bool
.. seealso:: :meth:`SetFlags`
.. method:: ClearFlag(self, flag)
Clear the specified flag for the column.
:param `flag`:
:type `flag`: int
.. seealso:: :meth:`SetFlags`
.. method:: SetAlignment(self, align)
Set the alignment of the column header.
:param `align`: The text alignment in horizontal direction only or ``wx.ALIGN_NOT`` to use the default alignment, The possible values here are ``wx.ALIGN_CENTRE``, ``wx.ALIGN_LEFT`` or ``wx.ALIGN_RIGHT`` with ``wx.ALIGN_CENTRE_HORIZONTAL`` being also supported as synonym for ``wx.ALIGN_CENTRE`` for consistency (but notice that :meth:`GetAlignment` never returns it).
:type `align`: wx.Alignment
.. method:: SetBitmap(self, bitmap)
Set the bitmap to be displayed in the column header.
Notice that the bitmaps displayed in different columns of the same control must all be of the same size.
:param `bitmap`:
:type `bitmap`: wx.Bitmap
.. method:: SetFlag(self, flag)
Set the specified flag for the column.
:param `flag`:
:type `flag`: int
.. seealso:: :meth:`SetFlags`
.. method:: SetFlags(self, flags)
Set the column flags.
This method allows to set all flags at once, see also generic :meth:`ChangeFlag` , :meth:`SetFlag` , :meth:`ClearFlag` and :meth:`ToggleFlag` methods below as well as specific :meth:`SetResizeable` , :meth:`SetSortable` , :meth:`SetReorderable` and :meth:`SetHidden` ones.
:param `flags`: Combination of ``wx.COL_RESIZABLE``, ``wx.COL_SORTABLE``, ``wx.COL_REORDERABLE`` and ``wx.COL_HIDDEN`` bit flags.
:type `flags`: int
.. method:: SetHidden(self, hidden)
Hide or show the column.
By default all columns are shown but some of them can be completely hidden from view by calling this function.
Equivalent to ChangeFlag(wxCOL_HIDDEN, hidden).
:param `hidden`:
:type `hidden`: bool
.. method:: SetMinWidth(self, minWidth)
Set the minimal column width.
This method can be used with resizable columns (i.e. those for which ``wx.COL_RESIZABLE`` flag is set in :meth:`GetFlags` or, alternatively, :meth:`IsResizeable` returns ``True``) to prevent the user from making them narrower than the given width.
:param `minWidth`: The minimal column width in pixels, may be 0 to remove any previously set restrictions.
:type `minWidth`: int
.. method:: SetReorderable(self, reorderable)
Allow changing the column order by dragging it.
Equivalent to ChangeFlag(wxCOL_REORDERABLE, reorderable).
:param `reorderable`:
:type `reorderable`: bool
.. method:: SetResizeable(self, resizable)
Call this to enable or disable interactive resizing of the column by the user.
By default, the columns are resizable.
Equivalent to ChangeFlag(wxCOL_RESIZABLE, resizable).
:param `resizable`:
:type `resizable`: bool
.. method:: SetSortOrder(self, ascending)
Sets this column as the sort key for the associated control.
This function indicates that this column is currently used for sorting the control and also sets the sorting direction. Notice that actual sorting is only done in the control associated with the header, this function doesn't do any sorting on its own.
Don't confuse this function with :meth:`SetSortable` which should be used to indicate that the column `may` be used for sorting while this one is used to indicate that it currently `is` used for sorting. Of course, :meth:`SetSortOrder` can be only called for sortable columns.
:param `ascending`: If ``True``, sort in ascending order, otherwise in descending order.
:type `ascending`: bool
.. method:: SetSortable(self, sortable)
Allow clicking the column to sort the control contents by the field in this column.
By default, the columns are not sortable so you need to explicitly call this function to allow sorting by the field corresponding to this column.
Equivalent to ChangeFlag(wxCOL_SORTABLE, sortable).
:param `sortable`:
:type `sortable`: bool
.. method:: SetTitle(self, title)
Set the text to display in the column header.
:param `title`:
:type `title`: string
.. method:: SetWidth(self, width)
Set the column width.
:param `width`: The column width in pixels or the special ``wx.COL_WIDTH_DEFAULT`` (meaning to use default width) or ``wx.COL_WIDTH_AUTOSIZE`` (size to fit the content) value.
:type `width`: int
.. method:: ToggleFlag(self, flag)
Toggle the specified flag for the column.
If the flag is currently set, equivalent to :meth:`ClearFlag` , otherwise :meth:`SetFlag` .
:param `flag`:
:type `flag`: int
.. seealso:: :meth:`SetFlags`
.. method:: ToggleSortOrder(self)
Inverses the sort order.
This function is typically called when the user clicks on a column used for sorting to change sort order from ascending to descending or vice versa.
.. seealso:: :meth:`SetSortOrder` , :meth:`IsSortOrderAscending`
.. method:: UnsetAsSortKey(self)
Don't use this column for sorting.
This is the reverse of :meth:`SetSortOrder` and is called to indicate that this column is not used for sorting any longer.
.. attribute:: Alignment
See :meth:`~wx.SettableHeaderColumn.HeaderColumn.GetAlignment` and :meth:`~wx.SettableHeaderColumn.SetAlignment`
.. attribute:: Bitmap
See :meth:`~wx.SettableHeaderColumn.HeaderColumn.GetBitmap` and :meth:`~wx.SettableHeaderColumn.SetBitmap`
.. attribute:: Flags
See :meth:`~wx.SettableHeaderColumn.HeaderColumn.GetFlags` and :meth:`~wx.SettableHeaderColumn.SetFlags`
.. attribute:: Hidden
See :meth:`~wx.SettableHeaderColumn.HeaderColumn.IsHidden` and :meth:`~wx.SettableHeaderColumn.SetHidden`
.. attribute:: MinWidth
See :meth:`~wx.SettableHeaderColumn.HeaderColumn.GetMinWidth` and :meth:`~wx.SettableHeaderColumn.SetMinWidth`
.. attribute:: Reorderable
See :meth:`~wx.SettableHeaderColumn.HeaderColumn.IsReorderable` and :meth:`~wx.SettableHeaderColumn.SetReorderable`
.. attribute:: Resizeable
See :meth:`~wx.SettableHeaderColumn.HeaderColumn.IsResizeable` and :meth:`~wx.SettableHeaderColumn.SetResizeable`
.. attribute:: Sortable
See :meth:`~wx.SettableHeaderColumn.HeaderColumn.IsSortable` and :meth:`~wx.SettableHeaderColumn.SetSortable`
.. attribute:: Title
See :meth:`~wx.SettableHeaderColumn.HeaderColumn.GetTitle` and :meth:`~wx.SettableHeaderColumn.SetTitle`
.. attribute:: Width
See :meth:`~wx.SettableHeaderColumn.HeaderColumn.GetWidth` and :meth:`~wx.SettableHeaderColumn.SetWidth`
|
