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
|
.. 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.DCTextBgColourChanger:
==========================================================================================================================================
|phoenix_title| **wx.DCTextBgColourChanger**
==========================================================================================================================================
:ref:`wx.DCTextBgColourChanger` is a small helper class for setting a background text colour on a :ref:`wx.DC` and unsetting it automatically in the destructor, restoring the previous one.
.. versionadded:: 4.1/wxWidgets-3.1.3
.. seealso:: :meth:`wx.DC.SetTextBackground` , :ref:`wx.DCFontChanger`, :ref:`wx.DCPenChanger`, :ref:`wx.DCBrushChanger`, :ref:`wx.DCClipper`, :ref:`wx.DCTextColourChanger`, :ref:`DCBgModeChanger`
|
|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>DCTextBgColourChanger</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.DCTextBgColourChanger_inheritance.png" alt="Inheritance diagram of DCTextBgColourChanger" 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.DCTextBgColourChanger.html" title="wx.DCTextBgColourChanger" alt="" coords="5,5,209,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.DCTextBgColourChanger.__init__` Trivial constructor not changing anything.
:meth:`~wx.DCTextBgColourChanger.Set` Set the background colour to use.
:meth:`~wx.DCTextBgColourChanger.__enter__`
:meth:`~wx.DCTextBgColourChanger.__exit__`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.DCTextBgColourChanger(object)
**Possible constructors**::
DCTextBgColourChanger(dc)
DCTextBgColourChanger(dc, col)
DCTextBgColourChanger is a small helper class for setting a
background text colour on a DC and unsetting it automatically in the
destructor, restoring the previous one.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, dc)`
Trivial constructor not changing anything.
This constructor is useful if you don't know beforehand if the colour needs to be changed or not. It simply creates the object which won't do anything in its destructor unless :meth:`Set` is called – in which case it would reset the previous colour.
:param `dc`:
:type `dc`: wx.DC
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, dc, col)`
Sets `col` on the given `dc`, storing the old one.
:param `dc`: The DC where the colour must be temporary set.
:type `dc`: wx.DC
:param `col`: The text background colour to set.
:type `col`: wx.Colour
:html:`<hr class="overloadsep" /><br />`
.. method:: Set(self, col)
Set the background colour to use.
This method is meant to be called once only and only on the objects created with the constructor overload not taking :ref:`wx.Colour` argument and has the same effect as the other constructor, i.e. sets the background colour to the given `col` and ensures that the old value is restored when this object is destroyed.
:param `col`:
:type `col`: wx.Colour
.. method:: __enter__(self)
.. method:: __exit__(self, exc_type, exc_val, exc_tb)
|
