| FLTK 1.3.11
    | 
The Fl_Check_Browser widget displays a scrolling list of text lines that may be selected and/or checked by the user. More...
#include <Fl_Check_Browser.H>
 
  
| Public Member Functions | |
| int | add (char *s) | 
| Add a new unchecked line to the end of the browser. | |
| int | add (char *s, int b) | 
| Add a new line to the end of the browser. | |
| int | add (const char *s) | 
| See int Fl_Check_Browser::add(char *s) | |
| int | add (const char *s, int b) | 
| See int Fl_Check_Browser::add(char *s) | |
| void | check_all () | 
| Sets all the items checked. | |
| void | check_none () | 
| Sets all the items unchecked. | |
| int | checked (int item) const | 
| Gets the current status of item item. | |
| void | checked (int item, int b) | 
| Sets the check status of item item to b. | |
| void | clear () | 
| Remove every item from the browser. | |
| Fl_Check_Browser (int x, int y, int w, int h, const char *l=0) | |
| The constructor makes an empty browser. | |
| int | nchecked () const | 
| Returns how many items are currently checked. | |
| int | nitems () const | 
| Returns how many lines are in the browser. | |
| int | remove (int item) | 
| Remove line n and make the browser one line shorter. | |
| void | set_checked (int item) | 
| Equivalent to Fl_Check_Browser::checked(item, 1). | |
| char * | text (int item) const | 
| Return a pointer to an internal buffer holding item item's text. | |
| int | value () const | 
| Returns the index of the currently selected item. | |
| ~Fl_Check_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. | |
| 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 itemtoval, and returns 1 if the state changed or 0 if it did not. | |
| int | select_only (void *item, int docallbacks=0) | 
| Selects itemand 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_Group * | as_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_Widget * | child (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 ofrom the group. | |
| void | remove (int index) | 
| Removes the widget at indexfrom the group but does not delete it. | |
| Fl_Widget * | resizable () 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_Window * | as_gl_window () | 
| Returns an Fl_Gl_Window pointer if this widget is an Fl_Gl_Window. | |
| virtual Fl_Window * | as_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_Image * | deimage () | 
| Gets the image that is used as part of the widget label. | |
| const Fl_Image * | deimage () 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. | |
| virtual void | hide () | 
| Makes a widget invisible. | |
| Fl_Image * | image () | 
| Gets the image that is used as part of the widget label. | |
| const Fl_Image * | image () 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_Group * | parent () 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. | |
| virtual void | show () | 
| Makes a widget visible. | |
| 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_Window * | top_window () const | 
| Returns a pointer to the top-level window for the widget. | |
| Fl_Window * | top_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_Window * | window () 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. | |
| Protected Member Functions | |
| int | handle (int) | 
| Handles the eventwithin the normal widget bounding box. | |
|  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 itemis being deleted from the list. | |
| int | displayed (void *item) const | 
| Returns non-zero if itemhas 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_height () const | 
| This method may be provided by the subclass to indicate the full height of the item list, in pixels. | |
| virtual int | full_width () const | 
| This method may be provided by the subclass to indicate the full width of the item list, in pixels. | |
| virtual int | incr_height () const | 
| This method may be provided to return the average height of all items to be used for scrolling. | |
| 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 void * | item_at (int index) const | 
| This method must be provided by the subclass to return the item for the specified index. | |
| virtual void * | item_last () const | 
| This method must be provided by the subclass to return the last item in 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. | |
| virtual void | item_swap (void *a, void *b) | 
| This optional method should be provided by the subclass to efficiently swap browser items aandb, such as for sorting. | |
| virtual const char * | item_text (void *item) const | 
| This optional method returns a string (label) that may be used for sorting. | |
| 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 itemhas 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 ais being replaced by itemb. | |
| 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 aandbare 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. | |
| Additional Inherited Members | |
|  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_Group * | current () | 
| 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 tcontains 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... | |
The Fl_Check_Browser widget displays a scrolling list of text lines that may be selected and/or checked by the user.
| int Fl_Check_Browser::add | ( | char * | s | ) | 
| int Fl_Check_Browser::add | ( | char * | s, | 
| int | b ) | 
Add a new line to the end of the browser.
The text is copied using the strdup() function. It may also be NULL to make a blank line. It can set the item checked if b is not 0. 
| 
 | protectedvirtual | 
Handles the event within the normal widget bounding box. 
| [in] | event | The event to process. | 
Reimplemented from Fl_Browser_.
| 
 | inline | 
Returns how many lines are in the browser.
The last line number is equal to this.
| int Fl_Check_Browser::remove | ( | int | item | ) | 
Remove line n and make the browser one line shorter.
Returns the number of lines left in the browser.