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
|
.. 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.IdManager:
==========================================================================================================================================
|phoenix_title| **wx.IdManager**
==========================================================================================================================================
:ref:`wx.IdManager` is responsible for allocating and releasing window IDs.
It is used by :meth:`wx.Window.NewControlId` and :meth:`wx.Window.UnreserveControlId` , and can also be used be used directly.
.. seealso:: :meth:`wx.Window.NewControlId` , :meth:`wx.Window.UnreserveControlId` , :ref:`Window IDs <window ids>`
|
|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>IdManager</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.IdManager_inheritance.png" alt="Inheritance diagram of IdManager" 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.IdManager.html" title="wx.IdManager" alt="" coords="5,5,115,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.IdManager.ReserveId` Called directly by :meth:`wx.Window.NewControlId` , this function will create a new ``ID`` or range of IDs.
:meth:`~wx.IdManager.UnreserveId` Called directly by :meth:`wx.Window.UnreserveControlId` , this function will unreserve an ``ID`` or range of IDs that is currently reserved.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.IdManager(object)
IdManager is responsible for allocating and releasing window IDs.
.. staticmethod:: ReserveId(count=1)
Called directly by :meth:`wx.Window.NewControlId` , this function will create a new ``ID`` or range of IDs.
The IDs will be reserved until assigned to a WindowIDRef() or unreserved with UnreserveControlId(). Only ``ID`` values that are not assigned to a WindowIDRef() need to be unreserved.
:param `count`: The number of sequential IDs to reserve.
:type `count`: int
:rtype: :ref:`wx.WindowID`
:returns:
The value of the first ``ID`` in the sequence, or ``wx.ID_NONE``.
.. staticmethod:: UnreserveId(id, count=1)
Called directly by :meth:`wx.Window.UnreserveControlId` , this function will unreserve an ``ID`` or range of IDs that is currently reserved.
This should only be called for IDs returned by ReserveControlId() that have NOT been assigned to a WindowIDRef (see :ref:`Window IDs <window ids>`).
:param `id`: The first of the range of IDs to unreserve.
:type `id`: wx.WindowID
:param `count`: The number of sequential IDs to unreserve.
:type `count`: int
:returns:
The value of the first ``ID`` in the sequence, or ``wx.ID_NONE``.
|
