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
|
.. 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
.. currentmodule:: wx.lib.agw.ultimatelistctrl
.. highlight:: python
.. _wx.lib.agw.ultimatelistctrl.UltimateListHeaderData:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.ultimatelistctrl.UltimateListHeaderData**
==========================================================================================================================================
A simple class which holds information about :class:`UltimateListItem` visual
attributes for the header/footer items (client rectangles, positions, etc...).
|
|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>UltimateListHeaderData</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.lib.agw.ultimatelistctrl.UltimateListHeaderData_inheritance.png" alt="Inheritance diagram of UltimateListHeaderData" 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.lib.agw.ultimatelistctrl.UltimateListHeaderData.html" title="wx.lib.agw.ultimatelistctrl.UltimateListHeaderData" alt="" coords="5,5,344,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.__init__` Default class constructor.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.Check` Checks/unchecks a header item.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.CheckFooter` Checks/unchecks a footer item.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.GetCustomRenderer` Returns the custom renderer associated with this item (if any).
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.GetFont` Returns the header/footer item font.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.GetFooterFormat` Returns the footer item format.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.GetFooterImage` Returns a Python list with the zero-based indexes of the images associated
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.GetFooterKind` Returns the footer item kind.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.GetFormat` Returns the header item format.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.GetImage` Returns a Python list with the zero-based indexes of the images associated
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.GetItem` Returns information about the item.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.GetKind` Returns the header item kind.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.GetState` Returns a bit field representing the state of the item.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.GetText` Returns the header/footer item text.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.GetToolTip` Returns the header/footer item tooltip.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.GetWidth` Returns the header/footer item width, in pixels.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.HasFooterImage` Returns ``True`` if the footer item has at least one image associated
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.HasImage` Returns ``True`` if the header item has at least one image associated
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.HasText` Returns ``True`` if the currently set text colour is valid.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.Init` Initializes the header/footer item.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.IsChecked` Returns whether the header item is checked or not.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.IsFooterChecked` Returns whether the footer item is checked or not.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.IsHit` Returns ``True`` if the input position is inside the item client rectangle.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.SetCustomRenderer` Associate a custom renderer to this item.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.SetFont` Sets a new font for the header item.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.SetFooterFont` Sets a new font for the footer item.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.SetFooterFormat` Sets the footer item format.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.SetFooterKind` Sets the footer item kind.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.SetFormat` Sets the header item format.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.SetHeight` Sets the header/footer item height, in pixels.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.SetItem` Sets information about the header/footer item.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.SetKind` Sets the header item kind.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.SetPosition` Sets the header/footer item position.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.SetState` Sets the item state flags.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.SetText` Sets the header/footer item text.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.SetToolTip` Sets the header/footer item tooltip.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListHeaderData.SetWidth` Sets the header/footer item width, in pixels.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: UltimateListHeaderData(object)
A simple class which holds information about :class:`UltimateListItem` visual
attributes for the header/footer items (client rectangles, positions, etc...).
.. method:: __init__(self, item=None)
Default class constructor.
:param `item`: another instance of :class:`UltimateListHeaderData`.
.. method:: Check(self, checked=True)
Checks/unchecks a header item.
:param `checked`: ``True`` to check an item, ``False`` to uncheck it.
:note: This method is meaningful only for check and radio header items.
.. method:: CheckFooter(self, check=True)
Checks/unchecks a footer item.
:param `checked`: ``True`` to check an item, ``False`` to uncheck it.
:note: This method is meaningful only for check and radio footer items.
.. method:: GetCustomRenderer(self)
Returns the custom renderer associated with this item (if any).
.. method:: GetFont(self)
Returns the header/footer item font.
.. method:: GetFooterFormat(self)
Returns the footer item format.
.. method:: GetFooterImage(self)
Returns a Python list with the zero-based indexes of the images associated
with the footer item into the image list.
.. method:: GetFooterKind(self)
Returns the footer item kind.
:see: :meth:`~UltimateListHeaderData.SetKind` for a list of valid item kinds.
.. method:: GetFormat(self)
Returns the header item format.
.. method:: GetImage(self)
Returns a Python list with the zero-based indexes of the images associated
with the header item into the image list.
.. method:: GetItem(self, item)
Returns information about the item.
:param `item`: an instance of :class:`UltimateListHeaderData`.
.. method:: GetKind(self)
Returns the header item kind.
:see: :meth:`~UltimateListHeaderData.SetKind` for a list of valid item kinds.
.. method:: GetState(self)
Returns a bit field representing the state of the item.
:see: :meth:`~UltimateListHeaderData.SetState` for a list of valid item states.
.. method:: GetText(self)
Returns the header/footer item text.
.. method:: GetToolTip(self)
Returns the header/footer item tooltip.
.. method:: GetWidth(self)
Returns the header/footer item width, in pixels.
.. method:: HasFooterImage(self)
Returns ``True`` if the footer item has at least one image associated
with it.
.. method:: HasImage(self)
Returns ``True`` if the header item has at least one image associated
with it.
.. method:: HasText(self)
Returns ``True`` if the currently set text colour is valid.
.. method:: Init(self)
Initializes the header/footer item.
.. method:: IsChecked(self)
Returns whether the header item is checked or not.
.. method:: IsFooterChecked(self)
Returns whether the footer item is checked or not.
.. method:: IsHit(self, x, y)
Returns ``True`` if the input position is inside the item client rectangle.
:param `x`: the `x` mouse position;
:param `y`: the `y` mouse position.
.. method:: SetCustomRenderer(self, renderer)
Associate a custom renderer to this item.
:param `renderer`: a class able to correctly render the item.
:note: the renderer class **must** implement the methods `DrawHeaderButton`
and `GetForegroundColor`.
.. method:: SetFont(self, font)
Sets a new font for the header item.
:param `font`: an instance of :class:`wx.Font`.
.. method:: SetFooterFont(self, font)
Sets a new font for the footer item.
:param `font`: an instance of :class:`wx.Font`.
.. method:: SetFooterFormat(self, format)
Sets the footer item format.
:param `format`: the footer item format.
.. method:: SetFooterKind(self, kind)
Sets the footer item kind.
:param `kind`: the footer item kind.
:see: :meth:`~UltimateListHeaderData.SetKind` for a list of valid item kinds.
.. method:: SetFormat(self, format)
Sets the header item format.
:param `format`: the header item format.
.. method:: SetHeight(self, h)
Sets the header/footer item height, in pixels.
:param `h`: an integer value representing the header/footer height.
.. method:: SetItem(self, item)
Sets information about the header/footer item.
:param `info`: an instance of :class:`UltimateListHeaderData`.
.. method:: SetKind(self, kind)
Sets the header item kind.
:param `kind`: may be one of the following integers:
=============== ==========================
Item Kind Description
=============== ==========================
0 A normal item
1 A checkbox-like item
2 A radiobutton-type item
=============== ==========================
.. method:: SetPosition(self, x, y)
Sets the header/footer item position.
:param `x`: the item `x` position;
:param `y`: the item `y` position.
.. method:: SetState(self, flag)
Sets the item state flags.
:param `state`: any combination of the following bits:
============================ ========= ==============================
State Bits Hex Value Description
============================ ========= ==============================
``ULC_STATE_DONTCARE`` 0x0 Don't care what the state is
``ULC_STATE_DROPHILITED`` 0x1 The item is highlighted to receive a drop event
``ULC_STATE_FOCUSED`` 0x2 The item has the focus
``ULC_STATE_SELECTED`` 0x4 The item is selected
``ULC_STATE_CUT`` 0x8 The item is in the cut state
``ULC_STATE_DISABLED`` 0x10 The item is disabled
``ULC_STATE_FILTERED`` 0x20 The item has been filtered
``ULC_STATE_INUSE`` 0x40 The item is in use
``ULC_STATE_PICKED`` 0x80 The item has been picked
``ULC_STATE_SOURCE`` 0x100 The item is a drag and drop source
============================ ========= ==============================
.. method:: SetText(self, text)
Sets the header/footer item text.
:param `text`: the new header/footer text.
.. method:: SetToolTip(self, tip)
Sets the header/footer item tooltip.
:param `tip`: the new header/footer tooltip.
.. method:: SetWidth(self, w)
Sets the header/footer item width, in pixels.
:param `w`: an integer value representing the header/footer width.
|
