summaryrefslogtreecommitdiff
path: root/documentation/Fl_Multi_Browser.html
blob: fb868c42d905c41fb4040301cbec0ef9a8d89dd8 (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
<html>
<body>

<hr break>

<h2><a name="Fl_Multi_Browser">class Fl_Multi_Browser</a></h2>

<hr>

<h3>Class Hierarchy</h3>

<ul><pre>
<a href="#Fl_Browser">Fl_Browser</a>
   |
   +----<b>Fl_Multi_Browser</b>
</pre></ul>

<h3>Include Files</h3>

<ul><pre>
#include &lt;FL/Fl_Multi_Browser.H>
</pre></ul>

<h3>Description</h3>

The <tt>Fl_Multi_Browser</tt> class is a subclass of
<tt>Fl_Browser</tt> which lets the user select any set of the lines. 
The user interface is Macintosh style: clicking an item turns off all
the others and selects that one, dragging selects all the items the
mouse moves over, and shift + click toggles the items. This is
different then how forms did it.  Normally the callback is done when
the user releases the mouse, but you can change this with
<tt>when()</tt>.

<p>See <a href="#Fl_Browser"><tt>Fl_Browser</tt></a> for methods to add
and remove lines from the browser.

<h3>Methods</h3>

<ul>
	<li><a href="#Fl_Multi_Browser.Fl_Multi_Browser">Fl_Multi_Browser</a>
	<li><a href="#Fl_Multi_Browser.~Fl_Multi_Browser">~Fl_Multi_Browser</a>
	<li><a href="#Fl_Multi_Browser.deselect">deselect</a>
	<li><a href="#Fl_Multi_Browser.select">select</a>
	<li><a href="#Fl_Multi_Browser.value">value</a>
</ul>

<h4><a name="Fl_Multi_Browser.Fl_Multi_Browser">Fl_Multi_Browser::Fl_Multi_Browser(int x, int y, int w, int h, const char *label = 0)</a></h4>

Creates a new <tt>Fl_Multi_Browser</tt> widget using the given position, size, and
label string. The default boxtype is <tt>FL_DOWN_BOX</tt>.

<h4><a name="Fl_Multi_Browser.~Fl_Multi_Browser">virtual Fl_Multi_Browser::~Fl_Multi_Browser()</a></h4>

The destructor <i>also deletes all the items in the list</i>.

<h4><a name="Fl_Multi_Browser.deselect">int Fl_Browser::deselect()</a></h4>

Deselects all lines.

<h4><a name="Fl_Multi_Browser.select">int Fl_Browser::select(int,int=1)<br>
int Fl_Browser::selected(int) const</a></h4>

Selects one or more lines or gets the current selection state of a line.

<h4><a name="Fl_Multi_Browser.value">int Fl_Browser::value() const<br>
void Fl_Browser::value(int)</a></h4>

Selects a single line or gets the last toggled line. This returns zero
if no line has been toggled, so be aware that this can happen in a callback.

</body>
</html>