File: wx.Window.ChildrenRepositioningGuard.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (102 lines) | stat: -rw-r--r-- 3,543 bytes parent folder | download
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
.. 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.Window.ChildrenRepositioningGuard:

==========================================================================================================================================
|phoenix_title|  **wx.Window.ChildrenRepositioningGuard**
==========================================================================================================================================

Helper for ensuring :meth:`~wx.Window.ChildrenRepositioningGuard.EndRepositioningChildren`  is called correctly.          

This class wraps the calls to :meth:`~wx.Window.ChildrenRepositioningGuard.BeginRepositioningChildren`  and :meth:`~wx.Window.ChildrenRepositioningGuard.EndRepositioningChildren`  by performing the former in its constructor and the latter in its destructor if, and only if, the first call returned ``True``. This is the simplest way to call these methods and if this class is created as a local variable, it also ensures that :meth:`~wx.Window.ChildrenRepositioningGuard.EndRepositioningChildren`  is correctly called (or not) on scope exit, so its use instead of calling these methods manually is highly recommended. 

         



.. versionadded:: 2.9.5 
     







|

|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>ChildrenRepositioningGuard</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.Window.ChildrenRepositioningGuard_inheritance.png" alt="Inheritance diagram of ChildrenRepositioningGuard" 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.Window.ChildrenRepositioningGuard.html" title="wx.Window.ChildrenRepositioningGuard" alt="" coords="5,5,272,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.Window.ChildrenRepositioningGuard.__init__`                           Constructor calls :meth:`wx.Window.BeginRepositioningChildren` .
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.Window.ChildrenRepositioningGuard(object)

   **Possible constructors**::

       ChildrenRepositioningGuard(win)
       
   
   Helper for ensuring EndRepositioningChildren() is called correctly.



   .. method:: __init__(self, win)

      Constructor calls :meth:`wx.Window.BeginRepositioningChildren` .                  




      :param `win`: The window to call :meth:`BeginRepositioningChildren`   on. If it is ``None``, nothing is done.   
      :type `win`: wx.Window