FL/Fl_Multi_Browser.H

   1 //
   2 // "$Id: Fl_Multi_Browser.H 8736 2011-05-24 20:00:56Z AlbrechtS $"
   3 //
   4 // Multi browser header file for the Fast Light Tool Kit (FLTK).
   5 //
   6 // Copyright 1998-2010 by Bill Spitzak and others.
   7 //
   8 // This library is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU Library General Public
  10 // License as published by the Free Software Foundation; either
  11 // version 2 of the License, or (at your option) any later version.
  12 //
  13 // This library is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // Library General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU Library General Public
  19 // License along with this library; if not, write to the Free Software
  20 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21 // USA.
  22 //
  23 // Please report all bugs and problems on the following page:
  24 //
  25 //     http://www.fltk.org/str.php
  26 //
  27
  28 /* \file
  29    Fl_Multi_Browser widget . */
  30
  31 #ifndef Fl_Multi_Browser_H
  32 #define Fl_Multi_Browser_H
  33
  34 #include "Fl_Browser.H"
  35
  36 /**
  37   The Fl_Multi_Browser class is a subclass of Fl_Browser
  38   which lets the user select any set of the lines.  The user interface
  39   is Macintosh style: clicking an item turns off all the others and
  40   selects that one, dragging selects all the items the mouse moves over,
  41   and shift + click toggles the items. This is different then how forms
  42   did it.  Normally the callback is done when the user releases the
  43   mouse, but you can change this with when().
  44   <P>See Fl_Browser for methods to add and remove lines from the browser.
  45 */
  46 class FL_EXPORT Fl_Multi_Browser : public Fl_Browser {
  47 public:
  48   /**
  49       Creates a new Fl_Multi_Browser widget using the given
  50     position, size, and label string. The default boxtype is FL_DOWN_BOX.
  51     The constructor specializes Fl_Browser() by setting the type to FL_MULTI_BROWSER.
  52     The destructor destroys the widget and frees all memory that has been allocated.
  53   */
  54 #if defined(FL_DLL)     // implementation in src/Fl_Browser.cxx
  55     Fl_Multi_Browser(int X,int Y,int W,int H,const char *L=0);
  56 #else
  57     Fl_Multi_Browser(int X,int Y,int W,int H,const char *L=0)
  58         : Fl_Browser(X,Y,W,H,L) {type(FL_MULTI_BROWSER);}
  59 #endif
  60 };
  61
  62 #endif
  63
  64 //
  65 // End of "$Id: Fl_Multi_Browser.H 8736 2011-05-24 20:00:56Z AlbrechtS $".
  66 //