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
|
.. 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.grid.GridUpdateLocker:
==========================================================================================================================================
|phoenix_title| **wx.grid.GridUpdateLocker**
==========================================================================================================================================
This small class can be used to prevent :ref:`wx.grid.Grid` from redrawing during its lifetime by calling :meth:`wx.grid.Grid.BeginBatch` in its constructor and :meth:`wx.grid.Grid.EndBatch` in its destructor.
It is typically used in a function performing several operations with a grid which would otherwise result in flicker. For example:
::
def GridLocker(self):
self.grid = wx.grid.Grid(self, -1)
noUpdates = wx.grid.GridUpdateLocker(self.grid)
self.grid.AppendColumn()
# ... many other operations with self.grid ...
self.grid.AppendRow()
# destructor called, grid refreshed
Using this class is easier and safer than calling :meth:`wx.grid.Grid.BeginBatch` and :meth:`wx.grid.Grid.EndBatch` because you don't risk missing the call the latter (due to an exception for example).
|
|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>GridUpdateLocker</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.grid.GridUpdateLocker_inheritance.png" alt="Inheritance diagram of GridUpdateLocker" 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.grid.GridUpdateLocker.html" title="wx.grid.GridUpdateLocker" alt="" coords="5,5,189,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.grid.GridUpdateLocker.__init__` Creates an object preventing the updates of the specified `grid`.
:meth:`~wx.grid.GridUpdateLocker.Create` This method can be called if the object had been constructed using the default constructor.
:meth:`~wx.grid.GridUpdateLocker.__enter__`
:meth:`~wx.grid.GridUpdateLocker.__exit__`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.grid.GridUpdateLocker(object)
**Possible constructors**::
GridUpdateLocker(grid=None)
This small class can be used to prevent Grid from redrawing during
its lifetime by calling `Grid.BeginBatch()` in its constructor and
`Grid.EndBatch()` in its destructor.
.. method:: __init__(self, grid=None)
Creates an object preventing the updates of the specified `grid`.
The parameter could be ``None`` in which case nothing is done. If `grid` is non-NULL then the grid must exist for longer than this :ref:`wx.grid.GridUpdateLocker` object itself.
The default constructor could be followed by a call to :meth:`Create` to set the grid object later.
:param `grid`:
:type `grid`: wx.grid.Grid
.. method:: Create(self, grid)
This method can be called if the object had been constructed using the default constructor.
It must not be called more than once.
:param `grid`:
:type `grid`: wx.grid.Grid
.. method:: __enter__(self)
.. method:: __exit__(self, exc_type, exc_val, exc_tb)
|
