summaryrefslogtreecommitdiff
path: root/documentation/Fl_Multi_Browser.html
diff options
context:
space:
mode:
authorMichael R Sweet <michael.r.sweet@gmail.com>1998-12-29 14:21:17 +0000
committerMichael R Sweet <michael.r.sweet@gmail.com>1998-12-29 14:21:17 +0000
commit87dd7f0d23eba5c09e71ec6efeb34c6844f5e95f (patch)
treeecd25b3fbecdd2d1c6abf106d0c94ac2b1e9926e /documentation/Fl_Multi_Browser.html
parent20adb6834b22523e9d1fecdb7bb8a117f7b6179a (diff)
Revised documentation files.
git-svn-id: file:///fltk/svn/fltk/trunk@177 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/Fl_Multi_Browser.html')
-rw-r--r--documentation/Fl_Multi_Browser.html73
1 files changed, 73 insertions, 0 deletions
diff --git a/documentation/Fl_Multi_Browser.html b/documentation/Fl_Multi_Browser.html
new file mode 100644
index 000000000..fb868c42d
--- /dev/null
+++ b/documentation/Fl_Multi_Browser.html
@@ -0,0 +1,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>