FLTK 1.3.9
Loading...
Searching...
No Matches
Fl_Multi_Browser Class Reference

The Fl_Multi_Browser class is a subclass of Fl_Browser which lets the user select any set of the lines. More...

#include <Fl_Multi_Browser.H>

Inheritance diagram for Fl_Multi_Browser:
Fl_Browser Fl_Browser_ Fl_Group Fl_Widget

Public Member Functions

 Fl_Multi_Browser (int X, int Y, int W, int H, const char *L=0)
 Creates a new Fl_Multi_Browser widget using the given position, size, and label string.
 
- Public Member Functions inherited from Fl_Browser
void add (const char *newtext, void *d=0)
 Adds a new line to the end of the browser.
 
void bottomline (int line)
 Scrolls the browser so the bottom item in the browser is showing the specified line.
 
void clear ()
 Removes all the lines in the browser.
 
char column_char () const
 Gets the current column separator character.
 
void column_char (char c)
 Sets the column separator to c.
 
const int * column_widths () const
 Gets the current column width array.
 
void column_widths (const int *arr)
 Sets the current array to arr.
 
void * data (int line) const
 Returns the user data() for specified line.
 
void data (int line, void *d)
 Sets the user data for specified line to d.
 
void display (int line, int val=1)
 For back compatibility.
 
int displayed (int line) const
 Returns non-zero if line has been scrolled to a position where it is being displayed.
 
 Fl_Browser (int X, int Y, int W, int H, const char *L=0)
 The constructor makes an empty browser.
 
char format_char () const
 Gets the current format code prefix character, which by default is '@'.
 
void format_char (char c)
 Sets the current format code prefix character to c.
 
void hide ()
 Hides the entire Fl_Browser widget – opposite of show().
 
void hide (int line)
 Makes line invisible, preventing selection by the user.
 
Fl_Imageicon (int line) const
 Returns the icon currently defined for line.
 
void icon (int line, Fl_Image *icon)
 Set the image icon for line to the value icon.
 
void insert (int line, const char *newtext, void *d=0)
 Insert a new entry whose label is newtext above given line, optional data d.
 
void lineposition (int line, Fl_Line_Position pos)
 Updates the browser so that line is shown at position pos.
 
int load (const char *filename)
 Clears the browser and reads the file, adding each line from the file to the browser.
 
void make_visible (int line)
 Make the item at the specified line visible().
 
void middleline (int line)
 Scrolls the browser so the middle item in the browser is showing the specified line.
 
void move (int to, int from)
 Line from is removed and reinserted at to.
 
void remove (int line)
 Remove entry for given line number, making the browser one line shorter.
 
void remove_icon (int line)
 Removes the icon for line.
 
void replace (int a, const char *b)
 For back compatibility only.
 
int select (int line, int val=1)
 Sets the selection state of the item at line to the value val.
 
int selected (int line) const
 Returns 1 if specified line is selected, 0 if not.
 
void show ()
 Shows the entire Fl_Browser widget – opposite of hide().
 
void show (int line)
 Makes line visible, and available for selection by user.
 
int size () const
 Returns how many lines are in the browser.
 
void size (int W, int H)
 
void swap (int a, int b)
 Swaps two browser lines a and b.
 
const char * text (int line) const
 Returns the label text for the specified line.
 
void text (int line, const char *newtext)
 Sets the text for the specified line to newtext.
 
Fl_Fontsize textsize () const
 Gets the default text size (in pixels) for the lines in the browser.
 
void textsize (Fl_Fontsize newSize)
 Sets the default text size (in pixels) for the lines in the browser to newSize.
 
int topline () const
 Returns the line that is currently visible at the top of the browser.
 
void topline (int line)
 Scrolls the browser so the top item in the browser is showing the specified line.
 
int value () const
 Returns the line number of the currently selected line, or 0 if none selected.
 
void value (int line)
 Sets the browser's value(), which selects the specified line.
 
int visible (int line) const
 Returns non-zero if the specified line is visible, 0 if hidden.
 
 ~Fl_Browser ()
 The destructor deletes all list items and destroys the browser.
 
- Public Member Functions inherited from Fl_Browser_
int deselect (int docallbacks=0)
 Deselects all items in the list and returns 1 if the state changed or 0 if it did not.
 
void display (void *item)
 Displays the item, scrolling the list as necessary.
 
int handle (int event)
 Handles the event within the normal widget bounding box.
 
uchar has_scrollbar () const
 Returns the current scrollbar mode, see Fl_Browser_::has_scrollbar(uchar)
 
void has_scrollbar (uchar mode)
 Sets whether the widget should have scrollbars or not (default Fl_Browser_::BOTH).
 
int hposition () const
 Gets the horizontal scroll position of the list as a pixel position pos.
 
void hposition (int)
 Sets the horizontal scroll position of the list to pixel position pos.
 
int position () const
 Gets the vertical scroll position of the list as a pixel position pos.
 
void position (int pos)
 Sets the vertical scroll position of the list to pixel position pos.
 
void resize (int X, int Y, int W, int H)
 Repositions and/or resizes the browser.
 
void scrollbar_left ()
 Moves the vertical scrollbar to the lefthand side of the list.
 
void scrollbar_right ()
 Moves the vertical scrollbar to the righthand side of the list.
 
int scrollbar_size () const
 Gets the current size of the scrollbars' troughs, in pixels.
 
void scrollbar_size (int newSize)
 Sets the pixel size of the scrollbars' troughs to newSize, in pixels.
 
int scrollbar_width () const
 This method has been deprecated, existing for backwards compatibility only.
 
void scrollbar_width (int width)
 This method has been deprecated, existing for backwards compatibility only.
 
int select (void *item, int val=1, int docallbacks=0)
 Sets the selection state of item to val, and returns 1 if the state changed or 0 if it did not.
 
int select_only (void *item, int docallbacks=0)
 Selects item and returns 1 if the state changed or 0 if it did not.
 
void sort (int flags=0)
 Sort the items in the browser based on flags.
 
Fl_Color textcolor () const
 Gets the default text color for the lines in the browser.
 
void textcolor (Fl_Color col)
 Sets the default text color for the lines in the browser to color col.
 
Fl_Font textfont () const
 Gets the default text font for the lines in the browser.
 
void textfont (Fl_Font font)
 Sets the default text font for the lines in the browser to font.
 
Fl_Fontsize textsize () const
 Gets the default text size (in pixels) for the lines in the browser.
 
void textsize (Fl_Fontsize newSize)
 Sets the default text size (in pixels) for the lines in the browser to size.
 
- Public Member Functions inherited from Fl_Group
Fl_Widget *& _ddfdesign_kludge ()
 This is for forms compatibility only.
 
void add (Fl_Widget &)
 The widget is removed from its current group (if any) and then added to the end of this group.
 
void add (Fl_Widget *o)
 See void Fl_Group::add(Fl_Widget &w)
 
void add_resizable (Fl_Widget &o)
 Adds a widget to the group and makes it the resizable widget.
 
Fl_Widget *const * array () const
 Returns a pointer to the array of children.
 
virtual Fl_Groupas_group ()
 Returns an Fl_Group pointer if this widget is an Fl_Group.
 
void begin ()
 Sets the current group so you can build the widget tree by just constructing the widgets.
 
Fl_Widgetchild (int n) const
 Returns array()[n].
 
int children () const
 Returns how many child widgets the group has.
 
void clear ()
 Deletes all child widgets from memory recursively.
 
unsigned int clip_children ()
 Returns the current clipping mode.
 
void clip_children (int c)
 Controls whether the group widget clips the drawing of child widgets to its bounding box.
 
void end ()
 Exactly the same as current(this->parent()).
 
int find (const Fl_Widget &o) const
 See int Fl_Group::find(const Fl_Widget *w) const.
 
int find (const Fl_Widget *) const
 Searches the child array for the widget and returns the index.
 
 Fl_Group (int, int, int, int, const char *=0)
 Creates a new Fl_Group widget using the given position, size, and label string.
 
void focus (Fl_Widget *W)
 
void forms_end ()
 This is for forms compatibility only.
 
int handle (int)
 Handles the specified event.
 
void init_sizes ()
 Resets the internal array of widget sizes and positions.
 
void insert (Fl_Widget &, int i)
 The widget is removed from its current group (if any) and then inserted into this group.
 
void insert (Fl_Widget &o, Fl_Widget *before)
 This does insert(w, find(before)).
 
void remove (Fl_Widget &)
 Removes a widget from the group but does not delete it.
 
void remove (Fl_Widget *o)
 Removes the widget o from the group.
 
void remove (int index)
 Removes the widget at index from the group but does not delete it.
 
Fl_Widgetresizable () const
 See void Fl_Group::resizable(Fl_Widget *box)
 
void resizable (Fl_Widget &o)
 See void Fl_Group::resizable(Fl_Widget *box)
 
void resizable (Fl_Widget *o)
 The resizable widget defines the resizing box for the group.
 
void resize (int, int, int, int)
 Resizes the Fl_Group widget and all of its children.
 
virtual ~Fl_Group ()
 The destructor also deletes all the children.
 
- Public Member Functions inherited from Fl_Widget
void _clear_fullscreen ()
 
void _set_fullscreen ()
 
void activate ()
 Activates the widget.
 
unsigned int active () const
 Returns whether the widget is active.
 
int active_r () const
 Returns whether the widget and all of its parents are active.
 
Fl_Align align () const
 Gets the label alignment.
 
void align (Fl_Align alignment)
 Sets the label alignment.
 
long argument () const
 Gets the current user data (long) argument that is passed to the callback function.
 
void argument (long v)
 Sets the current user data (long) argument that is passed to the callback function.
 
virtual class Fl_Gl_Windowas_gl_window ()
 Returns an Fl_Gl_Window pointer if this widget is an Fl_Gl_Window.
 
virtual Fl_Windowas_window ()
 Returns an Fl_Window pointer if this widget is an Fl_Window.
 
Fl_Boxtype box () const
 Gets the box type of the widget.
 
void box (Fl_Boxtype new_box)
 Sets the box type for the widget.
 
Fl_Callback_p callback () const
 Gets the current callback function for the widget.
 
void callback (Fl_Callback *cb)
 Sets the current callback function for the widget.
 
void callback (Fl_Callback *cb, void *p)
 Sets the current callback function for the widget.
 
void callback (Fl_Callback0 *cb)
 Sets the current callback function for the widget.
 
void callback (Fl_Callback1 *cb, long p=0)
 Sets the current callback function for the widget.
 
unsigned int changed () const
 Checks if the widget value changed since the last callback.
 
void clear_active ()
 Marks the widget as inactive without sending events or changing focus.
 
void clear_changed ()
 Marks the value of the widget as unchanged.
 
void clear_damage (uchar c=0)
 Clears or sets the damage flags.
 
void clear_output ()
 Sets a widget to accept input.
 
void clear_visible ()
 Hides the widget.
 
void clear_visible_focus ()
 Disables keyboard focus navigation with this widget.
 
Fl_Color color () const
 Gets the background color of the widget.
 
void color (Fl_Color bg)
 Sets the background color of the widget.
 
void color (Fl_Color bg, Fl_Color sel)
 Sets the background and selection color of the widget.
 
Fl_Color color2 () const
 For back compatibility only.
 
void color2 (unsigned a)
 For back compatibility only.
 
int contains (const Fl_Widget *w) const
 Checks if w is a child of this widget.
 
void copy_label (const char *new_label)
 Sets the current label.
 
void copy_tooltip (const char *text)
 Sets the current tooltip text.
 
uchar damage () const
 Returns non-zero if draw() needs to be called.
 
void damage (uchar c)
 Sets the damage bits for the widget.
 
void damage (uchar c, int x, int y, int w, int h)
 Sets the damage bits for an area inside the widget.
 
int damage_resize (int, int, int, int)
 Internal use only.
 
void deactivate ()
 Deactivates the widget.
 
Fl_Imagedeimage ()
 Gets the image that is used as part of the widget label.
 
const Fl_Imagedeimage () const
 
void deimage (Fl_Image &img)
 Sets the image to use as part of the widget label.
 
void deimage (Fl_Image *img)
 Sets the image to use as part of the widget label.
 
void do_callback ()
 Calls the widget callback.
 
void do_callback (Fl_Widget *o, long arg)
 Calls the widget callback.
 
void do_callback (Fl_Widget *o, void *arg=0)
 Calls the widget callback.
 
void draw_label (int, int, int, int, Fl_Align) const
 Draws the label in an arbitrary bounding box with an arbitrary alignment.
 
int h () const
 Gets the widget height.
 
Fl_Imageimage ()
 Gets the image that is used as part of the widget label.
 
const Fl_Imageimage () const
 
void image (Fl_Image &img)
 Sets the image to use as part of the widget label.
 
void image (Fl_Image *img)
 Sets the image to use as part of the widget label.
 
int inside (const Fl_Widget *wgt) const
 Checks if this widget is a child of wgt.
 
int is_label_copied () const
 Returns whether the current label was assigned with copy_label().
 
const char * label () const
 Gets the current label text.
 
void label (const char *text)
 Sets the current label pointer.
 
void label (Fl_Labeltype a, const char *b)
 Shortcut to set the label text and type in one call.
 
Fl_Color labelcolor () const
 Gets the label color.
 
void labelcolor (Fl_Color c)
 Sets the label color.
 
Fl_Font labelfont () const
 Gets the font to use.
 
void labelfont (Fl_Font f)
 Sets the font to use.
 
Fl_Fontsize labelsize () const
 Gets the font size in pixels.
 
void labelsize (Fl_Fontsize pix)
 Sets the font size in pixels.
 
Fl_Labeltype labeltype () const
 Gets the label type.
 
void labeltype (Fl_Labeltype a)
 Sets the label type.
 
void measure_label (int &ww, int &hh) const
 Sets width ww and height hh accordingly with the label size.
 
unsigned int output () const
 Returns if a widget is used for output only.
 
Fl_Groupparent () const
 Returns a pointer to the parent widget.
 
void parent (Fl_Group *p)
 Internal use only - "for hacks only".
 
void position (int X, int Y)
 Repositions the window or widget.
 
void redraw ()
 Schedules the drawing of the widget.
 
void redraw_label ()
 Schedules the drawing of the label.
 
Fl_Color selection_color () const
 Gets the selection color.
 
void selection_color (Fl_Color a)
 Sets the selection color.
 
void set_active ()
 Marks the widget as active without sending events or changing focus.
 
void set_changed ()
 Marks the value of the widget as changed.
 
void set_output ()
 Sets a widget to output only.
 
void set_visible ()
 Makes the widget visible.
 
void set_visible_focus ()
 Enables keyboard focus navigation with this widget.
 
void size (int W, int H)
 Changes the size of the widget.
 
int take_focus ()
 Gives the widget the keyboard focus.
 
unsigned int takesevents () const
 Returns if the widget is able to take events.
 
int test_shortcut ()
 Returns true if the widget's label contains the entered '&x' shortcut.
 
const char * tooltip () const
 Gets the current tooltip text.
 
void tooltip (const char *text)
 Sets the current tooltip text.
 
Fl_Windowtop_window () const
 Returns a pointer to the top-level window for the widget.
 
Fl_Windowtop_window_offset (int &xoff, int &yoff) const
 Finds the x/y offset of the current widget relative to the top-level window.
 
uchar type () const
 Gets the widget type.
 
void type (uchar t)
 Sets the widget type.
 
int use_accents_menu ()
 Returns non zero if MAC_USE_ACCENTS_MENU flag is set, 0 otherwise.
 
void * user_data () const
 Gets the user data for this widget.
 
void user_data (void *v)
 Sets the user data for this widget.
 
unsigned int visible () const
 Returns whether a widget is visible.
 
unsigned int visible_focus ()
 Checks whether this widget has a visible focus.
 
void visible_focus (int v)
 Modifies keyboard focus navigation.
 
int visible_r () const
 Returns whether a widget and all its parents are visible.
 
int w () const
 Gets the widget width.
 
Fl_When when () const
 Returns the conditions under which the callback is called.
 
void when (uchar i)
 Sets the flags used to decide when a callback is called.
 
Fl_Windowwindow () const
 Returns a pointer to the nearest parent window up the widget hierarchy.
 
int x () const
 Gets the widget position in its window.
 
int y () const
 Gets the widget position in its window.
 
virtual ~Fl_Widget ()
 Destroys the widget.
 

Additional Inherited Members

- Public Types inherited from Fl_Browser
enum  Fl_Line_Position { TOP , BOTTOM , MIDDLE }
 For internal use only?
 
- Public Types inherited from Fl_Browser_
enum  {
  HORIZONTAL = 1 , VERTICAL = 2 , BOTH = 3 , ALWAYS_ON = 4 ,
  HORIZONTAL_ALWAYS = 5 , VERTICAL_ALWAYS = 6 , BOTH_ALWAYS = 7
}
 Values for has_scrollbar(). More...
 
- Static Public Member Functions inherited from Fl_Group
static Fl_Groupcurrent ()
 Returns the currently active group.
 
static void current (Fl_Group *g)
 Sets the current group.
 
- Static Public Member Functions inherited from Fl_Widget
static void default_callback (Fl_Widget *cb, void *d)
 The default callback for all widgets that don't set a callback.
 
static unsigned int label_shortcut (const char *t)
 Returns the Unicode value of the '&x' shortcut in a given text.
 
static int test_shortcut (const char *, const bool require_alt=false)
 Returns true if the given text t contains the entered '&x' shortcut.
 
- Public Attributes inherited from Fl_Browser_
Fl_Scrollbar hscrollbar
 Horizontal scrollbar.
 
Fl_Scrollbar scrollbar
 Vertical scrollbar.
 
- Protected Types inherited from Fl_Widget
enum  {
  INACTIVE = 1<<0 , INVISIBLE = 1<<1 , OUTPUT = 1<<2 , NOBORDER = 1<<3 ,
  FORCE_POSITION = 1<<4 , NON_MODAL = 1<<5 , SHORTCUT_LABEL = 1<<6 , CHANGED = 1<<7 ,
  OVERRIDE = 1<<8 , VISIBLE_FOCUS = 1<<9 , COPIED_LABEL = 1<<10 , CLIP_CHILDREN = 1<<11 ,
  MENU_WINDOW = 1<<12 , TOOLTIP_WINDOW = 1<<13 , MODAL = 1<<14 , NO_OVERLAY = 1<<15 ,
  GROUP_RELATIVE = 1<<16 , COPIED_TOOLTIP = 1<<17 , FULLSCREEN = 1<<18 , MAC_USE_ACCENTS_MENU = 1<<19 ,
  USERFLAG3 = 1<<29 , USERFLAG2 = 1<<30 , USERFLAG1 = 1<<31
}
 flags possible values enumeration. More...
 
- Protected Member Functions inherited from Fl_Browser
FL_BLINE * _remove (int line)
 Removes the item at the specified line.
 
FL_BLINE * find_line (int line) const
 Returns the item for specified line.
 
int full_height () const
 The height of the entire list of all visible() items in pixels.
 
int incr_height () const
 The default 'average' item height (including inter-item spacing) in pixels.
 
void insert (int line, FL_BLINE *item)
 Insert specified item above line.
 
void * item_at (int line) const
 Return the item at specified line.
 
void item_draw (void *item, int X, int Y, int W, int H) const
 Draws item at the position specified by X Y W H.
 
void * item_first () const
 Returns the very first item in the list.
 
int item_height (void *item) const
 Returns height of item in pixels.
 
void * item_last () const
 Returns the very last item in the list.
 
void * item_next (void *item) const
 Returns the next item after item.
 
void * item_prev (void *item) const
 Returns the previous item before item.
 
void item_select (void *item, int val)
 Change the selection state of item to the value val.
 
int item_selected (void *item) const
 See if item is selected.
 
void item_swap (void *a, void *b)
 Swap the items a and b.
 
const char * item_text (void *item) const
 Returns the label text for item.
 
int item_width (void *item) const
 Returns width of item in pixels.
 
int lineno (void *item) const
 Returns line number corresponding to item, or zero if not found.
 
void swap (FL_BLINE *a, FL_BLINE *b)
 Swap the two items a and b.
 
- Protected Member Functions inherited from Fl_Browser_
void bbox (int &X, int &Y, int &W, int &H) const
 Returns the bounding box for the interior of the list's display window, inside the scrollbars.
 
void deleting (void *item)
 This method should be used when item is being deleted from the list.
 
int displayed (void *item) const
 Returns non-zero if item has been scrolled to a position where it is being displayed.
 
void draw ()
 Draws the list within the normal widget bounding box.
 
void * find_item (int ypos)
 This method returns the item under mouse y position ypos.
 
 Fl_Browser_ (int X, int Y, int W, int H, const char *L=0)
 The constructor makes an empty browser.
 
virtual int full_width () const
 This method may be provided by the subclass to indicate the full width of the item list, in pixels.
 
void inserting (void *a, void *b)
 This method should be used when an item is in the process of being inserted into the list.
 
virtual int item_quick_height (void *item) const
 This method may be provided by the subclass to return the height of the item, in pixels.
 
int leftedge () const
 This method returns the X position of the left edge of the list area after adjusting for the scrollbar and border, if any.
 
void new_list ()
 This method should be called when the list data is completely replaced or cleared.
 
void redraw_line (void *item)
 This method should be called when the contents of item has changed, but not its height.
 
void redraw_lines ()
 This method will cause the entire list to be redrawn.
 
void replacing (void *a, void *b)
 This method should be used when item a is being replaced by item b.
 
void * selection () const
 Returns the item currently selected, or NULL if there is no selection.
 
void swapping (void *a, void *b)
 This method should be used when two items a and b are being swapped.
 
void * top () const
 Returns the item that appears at the top of the list.
 
- Protected Member Functions inherited from Fl_Group
void draw ()
 Draws the widget.
 
void draw_child (Fl_Widget &widget) const
 Forces a child to redraw.
 
void draw_children ()
 Draws all children of the group.
 
void draw_outside_label (const Fl_Widget &widget) const
 Parents normally call this to draw outside labels of child widgets.
 
int * sizes ()
 Returns the internal array of widget sizes and positions.
 
void update_child (Fl_Widget &widget) const
 Draws a child only if it needs it.
 
- Protected Member Functions inherited from Fl_Widget
void clear_flag (unsigned int c)
 Clears a flag in the flags mask.
 
void draw_backdrop () const
 If FL_ALIGN_IMAGE_BACKDROP is set, the image or deimage will be drawn.
 
void draw_box () const
 Draws the widget box according its box style.
 
void draw_box (Fl_Boxtype t, Fl_Color c) const
 Draws a box of type t, of color c at the widget's position and size.
 
void draw_box (Fl_Boxtype t, int x, int y, int w, int h, Fl_Color c) const
 Draws a box of type t, of color c at the position X,Y and size W,H.
 
void draw_focus ()
 draws a focus rectangle around the widget
 
void draw_focus (Fl_Boxtype t, int x, int y, int w, int h) const
 Draws a focus box for the widget at the given position and size.
 
void draw_label () const
 Draws the widget's label at the defined label position.
 
void draw_label (int, int, int, int) const
 Draws the label in an arbitrary bounding box.
 
 Fl_Widget (int x, int y, int w, int h, const char *label=0L)
 Creates a widget at the given position and size.
 
unsigned int flags () const
 Gets the widget flags mask.
 
void h (int v)
 Internal use only.
 
void set_flag (unsigned int c)
 Sets a flag in the flags mask.
 
void w (int v)
 Internal use only.
 
void x (int v)
 Internal use only.
 
void y (int v)
 Internal use only.
 

Detailed Description

The Fl_Multi_Browser class is a subclass of Fl_Browser 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 ctrl + click (Cmd+click on the Mac OS platform) toggles the items.
Shift + click extends the selection until the clicked item. This is different from how forms did it.
Normally the callback is done when the user releases the mouse, but you can change this with when().

See Fl_Browser for methods to add and remove lines from the browser.

Constructor & Destructor Documentation

◆ Fl_Multi_Browser()

Fl_Multi_Browser::Fl_Multi_Browser ( int  X,
int  Y,
int  W,
int  H,
const char *  L = 0 
)

Creates a new Fl_Multi_Browser widget using the given position, size, and label string.

The default boxtype is FL_DOWN_BOX. The constructor specializes Fl_Browser() by setting the type to FL_MULTI_BROWSER. The destructor destroys the widget and frees all memory that has been allocated.


The documentation for this class was generated from the following files: