1wxSpinButton(3)            Erlang Module Definition            wxSpinButton(3)
2
3
4

NAME

6       wxSpinButton - Functions for wxSpinButton class
7

DESCRIPTION

9       A wxSpinButton has two small up and down (or left and right) arrow but‐
10       tons.
11
12       It is often used next to a text control for increment and  decrementing
13       a  value.  Portable  programs  should  try to use wxSpinCtrl instead as
14       wxSpinButton is not implemented for all platforms but wxSpinCtrl is  as
15       it degenerates to a simple wxTextCtrl on such platforms.
16
17       Note:  the  range supported by this control (and wxSpinCtrl) depends on
18       the platform but is at least -0x8000 to 0x7fff.  Under  GTK  and  Win32
19       with  sufficiently  new  version of comctrl32.dll (at least 4.71 is re‐
20       quired, 5.80 is recommended) the full 32 bit range is supported.
21
22       Styles
23
24       This class supports the following styles:
25
26       See: wxSpinCtrl
27
28       This class is derived (and can use functions) from: wxControl  wxWindow
29       wxEvtHandler
30
31       wxWidgets docs: wxSpinButton
32

EVENTS

34       Event types emitted from this class: spin, spin_up, spin_down
35

DATA TYPES

37       wxSpinButton() = wx:wx_object()
38

EXPORTS

40       new() -> wxSpinButton()
41
42              Default constructor.
43
44       new(Parent) -> wxSpinButton()
45
46              Types:
47
48                 Parent = wxWindow:wxWindow()
49
50       new(Parent, Options :: [Option]) -> wxSpinButton()
51
52              Types:
53
54                 Parent = wxWindow:wxWindow()
55                 Option =
56                     {id, integer()} |
57                     {pos, {X :: integer(), Y :: integer()}} |
58                     {size, {W :: integer(), H :: integer()}} |
59                     {style, integer()}
60
61              Constructor, creating and showing a spin button.
62
63              See: create/3
64
65       destroy(This :: wxSpinButton()) -> ok
66
67              Destructor, destroys the spin button control.
68
69       create(This, Parent) -> boolean()
70
71              Types:
72
73                 This = wxSpinButton()
74                 Parent = wxWindow:wxWindow()
75
76       create(This, Parent, Options :: [Option]) -> boolean()
77
78              Types:
79
80                 This = wxSpinButton()
81                 Parent = wxWindow:wxWindow()
82                 Option =
83                     {id, integer()} |
84                     {pos, {X :: integer(), Y :: integer()}} |
85                     {size, {W :: integer(), H :: integer()}} |
86                     {style, integer()}
87
88              Scrollbar  creation function called by the spin button construc‐
89              tor.
90
91              See new/2 for details.
92
93       getMax(This) -> integer()
94
95              Types:
96
97                 This = wxSpinButton()
98
99              Returns the maximum permissible value.
100
101              See: setRange/3
102
103       getMin(This) -> integer()
104
105              Types:
106
107                 This = wxSpinButton()
108
109              Returns the minimum permissible value.
110
111              See: setRange/3
112
113       getValue(This) -> integer()
114
115              Types:
116
117                 This = wxSpinButton()
118
119              Returns the current spin button value.
120
121              See: setValue/2
122
123       setRange(This, Min, Max) -> ok
124
125              Types:
126
127                 This = wxSpinButton()
128                 Min = Max = integer()
129
130              Sets the range of the spin button.
131
132              In portable code, min should be less than or equal  to  max.  In
133              wxMSW it is possible to specify minimum greater than maximum and
134              the native control supports the same range as if they  were  re‐
135              versed,  but  swaps  the  meaning of up and down arrows, however
136              this dubious feature is not supported on other platforms.
137
138              See: getMin/1, getMax/1
139
140       setValue(This, Value) -> ok
141
142              Types:
143
144                 This = wxSpinButton()
145                 Value = integer()
146
147              Sets the value of the spin button.
148
149
150
151wxWidgets team.                     wx 2.1                     wxSpinButton(3)