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
|
.. 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.customtreectrl
.. highlight:: python
.. _wx.lib.agw.customtreectrl.TreeItemAttr:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.customtreectrl.TreeItemAttr**
==========================================================================================================================================
Creates the item attributes (text colour, background colour and font).
:note: This class is inspired by the wxWidgets generic implementation of :class:`TreeItemAttr`.
|
|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>TreeItemAttr</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.customtreectrl.TreeItemAttr_inheritance.png" alt="Inheritance diagram of TreeItemAttr" 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.lib.agw.customtreectrl.TreeItemAttr.html" title="wx.lib.agw.customtreectrl.TreeItemAttr" alt="" coords="5,5,280,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.customtreectrl.TreeItemAttr.__init__` Default class constructor.
:meth:`~wx.lib.agw.customtreectrl.TreeItemAttr.GetBackgroundColour` Returns the attribute background colour.
:meth:`~wx.lib.agw.customtreectrl.TreeItemAttr.GetBorderColour` Returns the attribute border colour.
:meth:`~wx.lib.agw.customtreectrl.TreeItemAttr.GetFont` Returns the attribute font.
:meth:`~wx.lib.agw.customtreectrl.TreeItemAttr.GetTextColour` Returns the attribute text colour.
:meth:`~wx.lib.agw.customtreectrl.TreeItemAttr.HasBackgroundColour` Returns whether the attribute has background colour.
:meth:`~wx.lib.agw.customtreectrl.TreeItemAttr.HasBorderColour` Returns whether the attribute has border colour.
:meth:`~wx.lib.agw.customtreectrl.TreeItemAttr.HasFont` Returns whether the attribute has font.
:meth:`~wx.lib.agw.customtreectrl.TreeItemAttr.HasTextColour` Returns whether the attribute has text colour.
:meth:`~wx.lib.agw.customtreectrl.TreeItemAttr.SetBackgroundColour` Sets the item background colour attribute.
:meth:`~wx.lib.agw.customtreectrl.TreeItemAttr.SetBorderColour` Sets the item border colour attribute.
:meth:`~wx.lib.agw.customtreectrl.TreeItemAttr.SetFont` Sets the item font attribute.
:meth:`~wx.lib.agw.customtreectrl.TreeItemAttr.SetTextColour` Sets the text colour attribute.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: TreeItemAttr(object)
Creates the item attributes (text colour, background colour and font).
:note: This class is inspired by the wxWidgets generic implementation of :class:`TreeItemAttr`.
.. method:: __init__(self, colText=wx.NullColour, colBack=wx.NullColour, colBorder=wx.NullColour,font=wx.NullFont)
Default class constructor.
For internal use: do not call it in your code!
:param `colText`: the text colour, an instance of :class:`wx.Colour`;
:param `colBack`: the tree item background colour, an instance of :class:`wx.Colour`;
:param `colBorder`: the tree item border colour, an instance of :class:`wx.Colour`;
:param `font`: the tree item font, an instance of :class:`wx.Font`.
.. method:: GetBackgroundColour(self)
Returns the attribute background colour.
:return: An instance of :class:`wx.Colour`.
.. method:: GetBorderColour(self)
Returns the attribute border colour.
:return: An instance of :class:`wx.Colour`.
.. versionadded:: 0.9.6
.. method:: GetFont(self)
Returns the attribute font.
:return: An instance of :class:`wx.Font`.
.. method:: GetTextColour(self)
Returns the attribute text colour.
:return: An instance of :class:`wx.Colour`.
.. method:: HasBackgroundColour(self)
Returns whether the attribute has background colour.
:return: ``True`` if the background colour attribute has been set, ``False`` otherwise.
.. method:: HasBorderColour(self)
Returns whether the attribute has border colour.
:return: ``True`` if the border colour attribute has been set, ``False`` otherwise.
.. versionadded:: 0.9.6
.. method:: HasFont(self)
Returns whether the attribute has font.
:return: ``True`` if the font attribute has been set, ``False`` otherwise.
.. method:: HasTextColour(self)
Returns whether the attribute has text colour.
:return: ``True`` if the text colour attribute has been set, ``False`` otherwise.
.. method:: SetBackgroundColour(self, colBack)
Sets the item background colour attribute.
:param `colBack`: an instance of :class:`wx.Colour`.
.. method:: SetBorderColour(self, colBorder)
Sets the item border colour attribute.
:param `colBack`: an instance of :class:`wx.Colour`.
.. versionadded:: 0.9.6
.. method:: SetFont(self, font)
Sets the item font attribute.
:param `font`: an instance of :class:`wx.Font`.
.. method:: SetTextColour(self, colText)
Sets the text colour attribute.
:param `colText`: an instance of :class:`wx.Colour`.
|
