summaryrefslogtreecommitdiff
path: root/doc/fl_button.html
blob: c95ebb4493e1a7fdf68804f3c24bc017e3fbf9df (plain)
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Fl_Button Binding Map</title>
    <link href="map.css" rel="stylesheet">
  </head>

  <body>


<h2>Fl_Button Binding Map</h2>


<a href="index.html">Back to Index</a>


<table class="package">
  <tr><th colspan="2">Package name</th></tr>

  <tr>
    <td>Fl_Button</td>
    <td>FLTK.Widgets.Buttons</td>
  </tr>
</table>



<table class="type">
  <tr><th colspan="2">Types</th></tr>

  <tr>
    <td>Fl_Button</td>
    <td>Button</td>
  </tr>

  <tr>
    <td>&nbsp;</td>
    <td>Button_Reference</td>
  </tr>

  <tr>
    <td>int</td>
    <td>State</td>
  </tr>

</table>



<table class="function">
  <tr><th colspan="2">Static Protected Attributes</th></tr>

  <tr>
<td><pre>
static Fl_Widget_Tracker * key_release_tracker = 0;
</pre></td>
<td>Intentionally left unbound.</td>
  </tr>

</table>



<table class="function">
  <tr><th colspan="2">Constructors</th></tr>

  <tr>
<td><pre>
Fl_Button(int X, int Y, int W, int H, const char *L=0);
</pre></td>
<td><pre>
function Create
       (X, Y, W, H : in Integer;
        Text       : in String := "")
    return Button;
</pre></td>
  </tr>

</table>



<table class="function">
  <tr><th colspan="2">Functions and Procedures</th></tr>

  <tr>
<td><pre>
int clear();
</pre></td>
<td>See value / Set_State.</td>
  </tr>

  <tr>
<td><pre>
Fl_Boxtype down_box() const;
</pre></td>
<td><pre>
function Get_Down_Box
       (This : in Button)
    return Box_Kind;
</pre></td>
  </tr>

  <tr>
<td><pre>
void down_box(Fl_Boxtype b);
</pre></td>
<td><pre>
procedure Set_Down_Box
       (This : in out Button;
        To   : in     Box_Kind);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Color down_color() const;
</pre></td>
<td>See selection_color / Get_Selection_Color from Fl_Widget.</td>
  </tr>

  <tr>
<td><pre>
void down_color(unsigned c);
</pre></td>
<td>See selection_color / Set_Selection_Color from Fl_Widget.</td>
  </tr>

  <tr>
<td><pre>
virtual int handle(int);
</pre></td>
<td><pre>
function Handle
       (This  : in out Button;
        Event : in     Event_Kind)
    return Event_Outcome;
</pre></td>
  </tr>

  <tr>
<td><pre>
int set();
</pre></td>
<td>See value / Set_State.</td>
  </tr>

  <tr>
<td><pre>
void setonly();
</pre></td>
<td><pre>
procedure Set_Only
       (This : in out Button);
</pre></td>
  </tr>

  <tr>
<td><pre>
int shortcut() const;
</pre></td>
<td><pre>
function Get_Shortcut
       (This : in Button)
    return Shortcut_Key;
</pre></td>
  </tr>

  <tr>
<td><pre>
void shortcut(int s);
</pre></td>
<td><pre>
procedure Set_Shortcut
       (This : in out Button;
        Key  : in     Shortcut_Key);
</pre></td>
  </tr>

  <tr>
<td><pre>
void shortcut(const char *s);
</pre></td>
<td>See shortcut / Set_Shortcut.</td>
  </tr>

  <tr>
<td><pre>
int value(int v);
</pre></td>
<td><pre>
procedure Set_State
       (This : in out Button;
        St   : in     State);
</pre></td>
  </tr>

  <tr>
<td><pre>
char value() const;
</pre></td>
<td><pre>
function Get_State
       (This : in Button)
    return State;
</pre></td>
  </tr>

</table>



<table class="function">
  <tr><th colspan="2">Static Protected Functions and Procedures</th></tr>

  <tr>
<td><pre>
static void key_release_timeout(void *);
</pre></td>
<td>Intentionally left unbound.</td>
  </tr>

</table>



<table class="function">
  <tr><th colspan="2">Protected Functions and Procedures</th></tr>

  <tr>
<td><pre>
virtual void draw();
</pre></td>
<td><pre>
procedure Draw
       (This : in out Button);
</pre></td>
  </tr>

  <tr>
<td><pre>
void simulate_key_action();
</pre></td>
<td><pre>
procedure Simulate_Key_Action
       (This : in out Button);
</pre></td>
  </tr>

</table>


  </body>
</html>