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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
.. 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.propgrid.NumericProperty:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.NumericProperty**
==========================================================================================================================================
This is an abstract class which serves as a base class for numeric properties, like :ref:`wx.propgrid.IntProperty`, :ref:`wx.propgrid.UIntProperty`, :ref:`wx.propgrid.FloatProperty`.
**Supported special attributes:**
- ``PG_ATTR_MIN``, ``PG_ATTR_MAX``: Specify acceptable value range.
- ``PG_ATTR_SPINCTRL_STEP``: How much number changes when SpinCtrl editor button is pressed (or up/down on keyboard).
- ``PG_ATTR_SPINCTRL_WRAP``: Specify if value modified with SpinCtrl editor wraps at Min/Max.
- ``PG_ATTR_SPINCTRL_MOTION``: Specify if value can also by changed with SpinCtrl editor by moving mouse when left mouse button is being pressed.
.. versionadded:: 4.1/wxWidgets-3.1.3
|
|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>NumericProperty</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.propgrid.NumericProperty_inheritance.png" alt="Inheritance diagram of NumericProperty" 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.propgrid.NumericProperty.html" title="wx.propgrid.NumericProperty" alt="" coords="5,160,219,189"/> <area shape="rect" id="node2" href="wx.propgrid.PGProperty.html" title="wx.propgrid.PGProperty" alt="" coords="24,83,200,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="69,5,155,35"/> </map>
</p>
</div>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.propgrid.FloatProperty`, :ref:`wx.propgrid.IntProperty`, :ref:`wx.propgrid.UIntProperty`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.NumericProperty.AddSpinStepValue` Returns what would be the new value of the property after adding SpinCtrl editor step to the current value.
:meth:`~wx.propgrid.NumericProperty.DoSetAttribute` Reimplement this member function to add special handling for attributes of this property.
:meth:`~wx.propgrid.NumericProperty.UseSpinMotion` Return ``True`` if value can be changed with SpinCtrl editor by moving the mouse.
:meth:`~wx.propgrid.NumericProperty.__init__` Constructor is protected because :ref:`wx.propgrid.NumericProperty` is only a base class for other numeric property classes.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.NumericProperty(PGProperty)
**Possible constructors**::
NumericProperty(label, name)
This is an abstract class which serves as a base class for numeric
properties, like IntProperty, UIntProperty, FloatProperty.
.. method:: AddSpinStepValue(self, stepScale)
Returns what would be the new value of the property after adding SpinCtrl editor step to the current value.
Current value range and wrapping (if enabled) are taken into account. This member has to be implemented in derived properties.
:param `stepScale`: SpinCtrl editor step is first multiplied by this factor and next added to the current value.
:type `stepScale`: long
:rtype: :ref:`PGVariant`
:returns:
Value which property would have after adding SpinCtrl editor step.
.. note::
Current property value is not changed.
.. method:: DoSetAttribute(self, name, value)
Reimplement this member function to add special handling for attributes of this property.
:param `name`:
:type `name`: string
:param `value`:
:type `value`: PGVariant
:rtype: `bool`
:returns:
Return ``False`` to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
.. note::
To actually set property attribute values from the application, use :meth:`wx.propgrid.PGProperty.SetAttribute` instead.
.. method:: UseSpinMotion(self)
Return ``True`` if value can be changed with SpinCtrl editor by moving the mouse.
:rtype: `bool`
.. method:: __init__(self, label, name)
Constructor is protected because :ref:`wx.propgrid.NumericProperty` is only a base class for other numeric property classes.
:param `label`:
:type `label`: string
:param `name`:
:type `name`: string
|
