summaryrefslogtreecommitdiff
path: root/doc/fl_help_view.html
blob: fed45e05422e43ca84fe834bdc45c4b0980939ab (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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
<!DOCTYPE html>

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

  <body>


<h2>Fl_Help_View 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_Help_View</td>
    <td>FLTK.Widgets.Groups.Help_Views</td>
  </tr>

</table>



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

  <tr>
    <td>Fl_Help_View</td>
    <td>Help_View</td>
  </tr>

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

  <tr>
    <td>int</td>
    <td>Position</td>
  </tr>

  <tr>
    <td>int</td>
    <td>Extended_Position</td>
  </tr>

  <tr>
    <td>Fl_Help_Func</td>
    <td>Link_Callback</td>
  </tr>

</table>



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

  <tr>
    <td>int</td>
    <td>Load_Help_Error</td>
  </tr>

</table>



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

  <tr>
<td><pre>
Fl_Help_View(int xx, int yy, int ww, int hh, const char *l=0);
</pre></td>
<td><pre>
function Create
       (X, Y, W, H : in Integer;
        Text       : in String := "")
    return Help_View;
</pre></td>
  </tr>

</table>



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

  <tr>
<td><pre>
void clear_selection();
</pre></td>
<td><pre>
procedure Clear_Selection
       (This : in out Help_View);
</pre></td>
  </tr>

  <tr>
<td><pre>
const char * directory() const;
</pre></td>
<td><pre>
function Current_Directory
       (This : in Help_View)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
const char * filename() const;
</pre></td>
<td><pre>
function Current_File
       (This : in Help_View)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
int find(const char *s, int p=0);
</pre></td>
<td><pre>
function Find
       (This : in Help_View;
        Item : in String;
        From : in Position := 1)
    return Extended_Position;
</pre></td>
  </tr>

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

  <tr>
<td><pre>
int leftline() const;
</pre></td>
<td><pre>
function Get_Leftline_Pixel
       (This : in Help_View)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
void leftline(int);
</pre></td>
<td><pre>
procedure Set_Leftline_Pixel
       (This  : in out Help_View;
        Value : in     Natural);
</pre></td>
  </tr>

  <tr>
<td><pre>
void link(Fl_Help_Func *fn);
</pre></td>
<td><pre>
procedure Set_Link_Callback
       (This : in out Help_View;
        Func : in     Link_Callback);
</pre></td>
  </tr>

  <tr>
<td><pre>
int load(const char *f);
</pre></td>
<td><pre>
procedure Load
       (This : in out Help_View;
        Name : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
void resize(int, int, int, int);
</pre></td>
<td><pre>
procedure Resize
       (This       : in out Help_View;
        X, Y, W, H : in     Integer);
</pre></td>
  </tr>

  <tr>
<td><pre>
int scrollbar_size() const;
</pre></td>
<td><pre>
function Get_Scrollbar_Size
       (This : in Help_View)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
void scrollbar_size(int newSize);
</pre></td>
<td><pre>
procedure Set_Scrollbar_Size
       (This  : in out Help_View;
        Value : in     Natural);
</pre></td>
  </tr>

  <tr>
<td><pre>
void select_all();
</pre></td>
<td><pre>
procedure Select_All
       (This : in out Help_View);
</pre></td>
  </tr>

  <tr>
<td><pre>
int size() const;
</pre></td>
<td><pre>
function Get_Size
       (This : in Help_View)
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
void size(int W, int H);
</pre></td>
<td><pre>
procedure Resize
       (This : in out Help_View;
        W, H : in     Integer);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Color textcolor() const;
</pre></td>
<td><pre>
function Get_Text_Color
       (This : in Help_View)
    return Color;
</pre></td>
  </tr>

  <tr>
<td><pre>
void textcolor(Fl_Color c);
</pre></td>
<td><pre>
procedure Set_Text_Color
       (This  : in out Help_View;
        Value : in     Color);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Font textfont() const;
</pre></td>
<td><pre>
function Get_Text_Font
       (This : in Help_View)
    return Font_Kind;
</pre></td>
  </tr>

  <tr>
<td><pre>
void textfont(Fl_Font f);
</pre></td>
<td><pre>
procedure Set_Text_Font
       (This : in out Help_View;
        Font : in     Font_Kind);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Fontsize textsize() const;
</pre></td>
<td><pre>
function Get_Text_Size
       (This : in Help_View)
    return Font_Size;
</pre></td>
  </tr>

  <tr>
<td><pre>
void textsize(Fl_Fontsize s);
</pre></td>
<td><pre>
procedure Set_Text_Size
       (This : in out Help_View;
        Size : in     Font_Size);
</pre></td>
  </tr>

  <tr>
<td><pre>
const char * title();
</pre></td>
<td><pre>
function Document_Title
       (This : in Help_View)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
int topline() const;
</pre></td>
<td><pre>
function Get_Topline_Pixel
       (This : in Help_View)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
void topline(const char *n);
</pre></td>
<td><pre>
procedure Set_Topline_Target
       (This  : in out Help_View;
        Value : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
void topline(int);
</pre></td>
<td><pre>
procedure Set_Topline_Pixel
       (This  : in out Help_View;
        Value : in     Natural);
</pre></td>
  </tr>

  <tr>
<td><pre>
const char * value() const;
</pre></td>
<td><pre>
function Get_Content
       (This : in Help_View)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
void value(const char *val);
</pre></td>
<td><pre>
procedure Set_Content
       (This  : in out Help_View;
        Value : in     String);
</pre></td>
  </tr>

</table>



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

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

</table>


  </body>
</html>