#include <Fl_Browser_.H>

Inheritance diagram for Fl_Browser_:

Collaboration diagram for Fl_Browser_:

Public Types
enum	{ HORIZONTAL = 1, VERTICAL = 2, BOTH = 3, ALWAYS_ON = 4, HORIZONTAL_ALWAYS = 5, VERTICAL_ALWAYS = 6, BOTH_ALWAYS = 7 }
Public Member Functions
int	handle (int event)
void	resize (int X, int Y, int W, int H)
int	select (void *item, int val=1, int docallbacks=0)
int	select_only (void *item, int docallbacks=0)
int	deselect (int docallbacks=0)
int	position () const
void	position (int pos)
int	hposition () const
void	hposition (int)
void	display (void *item)
uchar	has_scrollbar () const
void	has_scrollbar (uchar mode)
Fl_Font	textfont () const
void	textfont (Fl_Font font)
Fl_Fontsize	textsize () const
void	textsize (Fl_Fontsize size)
Fl_Color	textcolor () const
void	textcolor (Fl_Color col)
int	scrollbar_size () const
void	scrollbar_size (int size)
int	scrollbar_width () const
void	scrollbar_width (int width)
void	scrollbar_right ()
void	scrollbar_left ()
void	sort (int flags=0)
Public Attributes
Fl_Scrollbar	scrollbar
Fl_Scrollbar	hscrollbar
Protected Member Functions
virtual void *	item_first () const =0
virtual void *	item_next (void *item) const =0
virtual void *	item_prev (void *item) const =0
virtual void *	item_last () const
virtual int	item_height (void *item) const =0
virtual int	item_width (void *item) const =0
virtual int	item_quick_height (void *item) const
virtual void	item_draw (void *item, int X, int Y, int W, int H) const =0
virtual const char *	item_text (void *item) const
virtual void	item_swap (void a, void b)
virtual void *	item_at (int index) const
virtual int	full_width () const
virtual int	full_height () const
virtual int	incr_height () const
virtual void	item_select (void *item, int val=1)
virtual int	item_selected (void *item) const
void *	top () const
void *	selection () const
void	new_list ()
void	deleting (void *item)
void	replacing (void a, void b)
void	swapping (void a, void b)
void	inserting (void a, void b)
int	displayed (void *item) const
void	redraw_line (void *item)
void	redraw_lines ()
void	bbox (int &X, int &Y, int &W, int &H) const
int	leftedge () const
void *	find_item (int ypos)
void	draw ()
	Fl_Browser_ (int X, int Y, int W, int H, const char *L=0)

Detailed Description

This is the base class for browsers. To be useful it must be subclassed and several virtual functions defined. The Forms-compatible browser and the file chooser's browser are subclassed off of this.

This has been designed so that the subclass has complete control over the storage of the data, although because next() and prev() functions are used to index, it works best as a linked list or as a large block of characters in which the line breaks must be searched for.

A great deal of work has been done so that the "height" of a data object does not need to be determined until it is drawn. This is useful if actually figuring out the size of an object requires accessing image data or doing stat() on a file or doing some other slow operation.

Definition at line 67 of file Fl_Browser_.H.

Member Enumeration Documentation

anonymous enum

Values for has_scrollbar(). Anonymous enum bit flags for has_scrollbar().

bit 0: horizontal
bit 1: vertical
bit 2: 'always' (to be combined with bits 0 and 1)
bit 3-31: reserved for future use

Enumerator:

HORIZONTAL	Only show horizontal scrollbar.
VERTICAL	Only show vertical scrollbar.
BOTH	Show both scrollbars. (default)
ALWAYS_ON	Specified scrollbar(s) should 'always' be shown (to be used with HORIZONTAL/VERTICAL)
HORIZONTAL_ALWAYS	Horizontal scrollbar always on.
VERTICAL_ALWAYS	Vertical scrollbar always on.
BOTH_ALWAYS	Both scrollbars always on.

Definition at line 241 of file Fl_Browser_.H.

Constructor & Destructor Documentation

Fl_Browser_::Fl_Browser_	(	int	X,
		int	Y,
		int	W,
		int	H,
		const char *	L = `0`
	)		`[protected]`

The constructor makes an empty browser.

Parameters:

[in]	X,Y,W,H	position and size.
[in]	L	The label string, may be NULL.

Definition at line 960 of file Fl_Browser_.cxx.

References Fl_Widget::align(), BOTH, Fl_Widget::box(), Fl_Widget::callback(), Fl_Widget::color(), Fl_Group::end(), FL_ALIGN_BOTTOM, FL_BACKGROUND2_COLOR, FL_FOREGROUND_COLOR, FL_HELVETICA, FL_HORIZONTAL, FL_NO_BOX, FL_NORMAL_SIZE, FL_SELECTION_COLOR, FL_WHEN_RELEASE_ALWAYS, hscrollbar, scrollbar, Fl_Widget::type(), and Fl_Widget::when().

Member Function Documentation

void Fl_Browser_::bbox	(	int &	X,
		int &	Y,
		int &	W,
		int &	H
	)		const `[protected]`

Returns the bounding box for the interior of the list's display window, inside the scrollbars.

Parameters:

[out] X,Y,W,H The returned bounding box.
(The original contents of these parameters are overwritten)

Definition at line 77 of file Fl_Browser_.cxx.

References Fl_Widget::align(), b, Fl_Widget::box(), Fl::box_dh(), Fl::box_dw(), Fl::box_dx(), Fl::box_dy(), FL_ALIGN_LEFT, FL_ALIGN_TOP, FL_DOWN_BOX, Fl_Widget::h(), hscrollbar, scrollbar, scrollbar_size(), Fl_Widget::visible(), Fl_Widget::w(), Fl_Widget::x(), and Fl_Widget::y().

Referenced by display(), displayed(), draw(), find_item(), handle(), Widget_Browser::handle(), leftedge(), Fl_Browser::lineposition(), and resize().

void Fl_Browser_::deleting ( void * item ) [protected]

This method should be used when item is being deleted from the list. It allows the Fl_Browser_ to discard any cached data it has on the item. This method does not actually delete the item, but handles the follow up bookkeeping after the item has just been deleted.

Parameters:

[in] item The item being deleted.

Definition at line 516 of file Fl_Browser_.cxx.

References displayed(), item_next(), item_prev(), and redraw_lines().

Referenced by Fl_Browser::_remove(), Fl_Check_Browser::remove(), and Fl_Type::~Fl_Type().

int Fl_Browser_::deselect ( int docallbacks = 0 )

Deselects all items in the list and returns 1 if the state changed or 0 if it did not.

If the optional docallbacks parameter is non-zero, deselect tries to call the callback function for the widget.

Parameters:

[in] docallbacks If 1, invokes widget callback if item changed.
If 0, doesn't do callback (default).

Definition at line 656 of file Fl_Browser_.cxx.

References FL_MULTI_BROWSER, item_first(), item_next(), item_select(), redraw_line(), select(), and Fl_Widget::type().

Referenced by deselect(), Fl_Check_Browser::handle(), handle(), select_only(), template_clear(), and Fl_File_Chooser::value().

void Fl_Browser_::display ( void * item )

Displays the item, scrolling the list as necessary.

Parameters:

[in] item The item to be displayed.

See also:: display(), displayed()

Definition at line 253 of file Fl_Browser_.cxx.

References bbox(), H, item_first(), item_next(), item_prev(), item_quick_height(), and position().

Referenced by handle(), Fl_Browser::make_visible(), Fl_Type::move_before(), reveal_in_browser(), select(), and select_only().

int Fl_Browser_::displayed ( void * item ) const [protected]

Returns non-zero if item has been scrolled to a position where it is being displayed. Checks to see if the item's vertical position is within the top and bottom edges of the display window. This does NOT take into account the hide()/show() status of the widget or item.

Parameters:

[in] item The item to check

Returns:: 1 if visible, 0 if not visible.

See also:: display(), displayed()

Definition at line 236 of file Fl_Browser_.cxx.

References bbox(), H, item_height(), and item_next().

Referenced by deleting(), Fl_Browser::displayed(), Fl_Browser::hide(), inserting(), and Fl_Browser::show().

void Fl_Browser_::draw ( void ) [protected, virtual]

Draws the list within the normal widget bounding box.

Reimplemented from Fl_Group.

Definition at line 337 of file Fl_Browser_.cxx.

References Fl_Widget::active_r(), Fl_Widget::align(), ALWAYS_ON, b, bbox(), Fl_Widget::box(), Fl_Widget::clear_damage(), Fl_Widget::clear_visible(), Fl_Widget::color(), Fl_Widget::damage(), Fl_Widget::damage_resize(), Fl_Widget::draw_box(), Fl_Group::draw_child(), Fl_Widget::draw_focus(), dy, FL_ALIGN_LEFT, FL_ALIGN_TOP, FL_BORDER_FRAME, fl_color(), FL_DAMAGE_ALL, FL_DAMAGE_SCROLL, FL_DOWN_BOX, fl_inactive(), FL_NO_BOX, fl_pop_clip(), fl_push_clip(), fl_rectf(), Fl::focus(), full_height(), full_width(), Fl_Widget::h(), H, HORIZONTAL, hscrollbar, item_draw(), item_first(), item_height(), item_next(), item_quick_height(), item_selected(), item_width(), Fl_Scrollbar::linesize(), Fl_Widget::parent(), scrollbar, scrollbar_size(), Fl_Widget::selection_color(), Fl_Widget::set_visible(), top(), Fl_Group::update_child(), Fl_Scrollbar::value(), VERTICAL, Fl_Widget::visible(), Fl_Widget::w(), Fl_Widget::x(), and Fl_Widget::y().

void * Fl_Browser_::find_item ( int ypos ) [protected]

This method returns the item under mouse y position ypos. NULL is returned if no item is displayed at that position.

Parameters:

[in] ypos The y position (eg. Fl::event_y()) to find an item under.

Returns:: The item, or NULL if not found

Definition at line 589 of file Fl_Browser_.cxx.

References bbox(), H, item_height(), and item_next().

Referenced by handle(), and Widget_Browser::handle().

int Fl_Browser_::full_height ( ) const [protected, virtual]

This method may be provided by the subclass to indicate the full height of the item list, in pixels. The default implementation computes the full height from the item heights. Includes the items that are scrolled off screen.

Returns:: The height of the entire list, in pixels.

Reimplemented in Fl_Browser.

Definition at line 1069 of file Fl_Browser_.cxx.

References item_first(), item_next(), and item_quick_height().

Referenced by draw(), and handle().

int Fl_Browser_::full_width ( ) const [protected, virtual]

This method may be provided by the subclass to indicate the full width of the item list, in pixels. The default implementation computes the full width from the item widths.

Returns:: The maximum width of all the items, in pixels.

Definition at line 1082 of file Fl_Browser_.cxx.

Referenced by draw().

int Fl_Browser_::handle ( int event ) [virtual]

Handles the event within the normal widget bounding box.

Parameters:

[in] event The event to process.

Returns:: 1 if event was processed, 0 if not.

Reimplemented from Fl_Group.

Reimplemented in Fl_Check_Browser, and Widget_Browser.

Definition at line 699 of file Fl_Browser_.cxx.

References b, bbox(), Fl_Widget_Tracker::deleted(), deselect(), display(), Fl_Widget::do_callback(), Fl::event_clicks(), Fl::event_inside(), Fl::event_key(), Fl::event_state(), Fl::event_x(), Fl::event_y(), find_item(), FL_CTRL, FL_Down, FL_DRAG, FL_Enter, FL_ENTER, FL_FOCUS, FL_HOLD_BROWSER, FL_KEYBOARD, FL_KP_Enter, FL_LEAVE, FL_MULTI_BROWSER, FL_NORMAL_BROWSER, FL_PUSH, FL_RELEASE, FL_SELECT_BROWSER, FL_SHIFT, FL_UNFOCUS, FL_Up, FL_WHEN_CHANGED, FL_WHEN_ENTER_KEY, FL_WHEN_NOT_CHANGED, FL_WHEN_RELEASE, Fl_Group::focus(), full_height(), H, Fl_Group::handle(), item_first(), item_height(), item_next(), item_prev(), item_selected(), m, position(), py, Fl_Widget::redraw(), redraw_line(), select(), select_only(), Fl_Widget::set_changed(), Fl_Widget::type(), Fl::visible_focus(), Fl_Widget::w(), Fl_Widget::when(), and Fl_Widget::x().

uchar Fl_Browser_::has_scrollbar ( ) const [inline]

Returns the current scrollbar mode, see Fl_Browser_::has_scrollbar(uchar)

Definition at line 253 of file Fl_Browser_.H.

void Fl_Browser_::has_scrollbar ( uchar mode ) [inline]

Sets whether the widget should have scrollbars or not (default Fl_Browser_::BOTH). By default you can scroll in both directions, and the scrollbars disappear if the data will fit in the widget. has_scrollbar() changes this based on the value of mode:

0 - No scrollbars.

Fl_Browser_::HORIZONTAL - Only a horizontal scrollbar.

Fl_Browser_::VERTICAL - Only a vertical scrollbar.

Fl_Browser_::BOTH - The default is both scrollbars.

Fl_Browser_::HORIZONTAL_ALWAYS - Horizontal scrollbar always on, vertical always off.

Fl_Browser_::VERTICAL_ALWAYS - Vertical scrollbar always on, horizontal always off.

Fl_Browser_::BOTH_ALWAYS - Both always on.

Definition at line 276 of file Fl_Browser_.H.

int Fl_Browser_::hposition ( ) const [inline]

Gets the horizontal scroll position of the list as a pixel position pos. The position returned is how many pixels of the list are scrolled off the left edge of the screen. Example: A position of '18' indicates the left 18 pixels of the list are scrolled off the left edge of the screen.

See also:: position(), hposition()

Definition at line 228 of file Fl_Browser_.H.

Referenced by Widget_Browser::handle().

void Fl_Browser_::hposition ( int pos )

Sets the horizontal scroll position of the list to pixel position pos. The position is how many pixels of the list are scrolled off the left edge of the screen. Example: A position of '18' scrolls the left 18 pixels of the list off the left edge of the screen.

Parameters:

[in] pos The horizontal position (in pixels) to scroll the browser to.

See also:: position(), hposition()

Definition at line 219 of file Fl_Browser_.cxx.

References redraw_lines().

int Fl_Browser_::incr_height ( ) const [protected, virtual]

This method may be provided to return the average height of all items to be used for scrolling. The default implementation uses the height of the first item.

Returns:: The average height of items, in pixels.

Reimplemented in Fl_Browser.

Definition at line 1058 of file Fl_Browser_.cxx.

References item_first(), and item_quick_height().

void Fl_Browser_::inserting	(	void *	a,
		void *	b
	)		`[protected]`

This method should be used when an item is in the process of being inserted into the list. It allows the Fl_Browser_ to update its cache data as needed, scheduling a redraw for the affected lines. This method does not actually insert items, but handles the follow up bookkeeping after items have been inserted.

Parameters:

[in]	a	The starting item position
[in]	b	The new item being inserted

Definition at line 578 of file Fl_Browser_.cxx.

References b, displayed(), and redraw_lines().

Referenced by Fl_Browser::insert(), and Fl_Type::move_before().

virtual void* Fl_Browser_::item_at ( int index ) const [inline, protected, virtual]

This method must be provided by the subclass to return the item for the specified index.

Parameters:

[in] index The index of the item to be returned

Returns:: The item at the specified index.

Reimplemented in Fl_Browser.

Definition at line 154 of file Fl_Browser_.H.

virtual void Fl_Browser_::item_draw	(	void *	item,
		int	X,
		int	Y,
		int	W,
		int	H
	)		const `[protected, pure virtual]`

This method must be provided by the subclass to draw the item in the area indicated by X, Y, W, H.

Implemented in Fl_Browser.

Referenced by draw().

virtual void* Fl_Browser_::item_first ( ) const [protected, pure virtual]

This method must be provided by the subclass to return the first item in the list.

See also:: item_first(), item_next(), item_last(), item_prev()

Implemented in Fl_Browser.

Referenced by deselect(), display(), draw(), full_height(), handle(), incr_height(), select_only(), and sort().

virtual int Fl_Browser_::item_height ( void * item ) const [protected, pure virtual]

This method must be provided by the subclass to return the height of item in pixels. Allow for two additional pixels for the list selection box.

Parameters:

[in] item The item whose height is returned.

Returns:: The height of the specified item in pixels.

See also:: item_height(), item_width(), item_quick_height()

Implemented in Fl_Browser.

Referenced by displayed(), draw(), find_item(), handle(), and item_quick_height().

virtual void* Fl_Browser_::item_last ( ) const [inline, protected, virtual]

This method must be provided by the subclass to return the last item in the list.

See also:: item_first(), item_next(), item_last(), item_prev()

Reimplemented in Fl_Browser.

Definition at line 112 of file Fl_Browser_.H.

virtual void* Fl_Browser_::item_next ( void * item ) const [protected, pure virtual]

This method must be provided by the subclass to return the item in the list after item.

See also:: item_first(), item_next(), item_last(), item_prev()

Implemented in Fl_Browser.

Referenced by deleting(), deselect(), display(), displayed(), draw(), find_item(), full_height(), handle(), select_only(), and sort().

virtual void* Fl_Browser_::item_prev ( void * item ) const [protected, pure virtual]

This method must be provided by the subclass to return the item in the list before item.

See also:: item_first(), item_next(), item_last(), item_prev()

Implemented in Fl_Browser.

Referenced by deleting(), display(), handle(), and sort().

int Fl_Browser_::item_quick_height ( void * item ) const [protected, virtual]

This method may be provided by the subclass to return the height of the item, in pixels. Allow for two additional pixels for the list selection box. This method differs from item_height in that it is only called for selection and scrolling operations. The default implementation calls item_height.

Parameters:

[in] item The item whose height to return.

Returns:: The height, in pixels.

Definition at line 1048 of file Fl_Browser_.cxx.

References item_height().

Referenced by display(), draw(), full_height(), and incr_height().

void Fl_Browser_::item_select	(	void *	item,
		int	val = `1`
	)		`[protected, virtual]`

This method must be implemented by the subclass if it supports multiple selections; sets the selection state to val for the item. Sets the selection state for item, where optional val is 1 (select, the default) or 0 (de-select).

Parameters:

[in]	item	The item to be selected
[in]	val	The optional selection state; 1=select, 0=de-select. The default is to select the item (1).

Reimplemented in Fl_Browser.

Definition at line 1095 of file Fl_Browser_.cxx.

Referenced by deselect(), and select().

int Fl_Browser_::item_selected ( void * item ) const [protected, virtual]

This method must be implemented by the subclass if it supports multiple selections; returns the selection state for item. The method should return 1 if item is selected, or 0 otherwise.

Parameters:

[in] item The item to test.

Reimplemented in Fl_Browser.

Definition at line 1103 of file Fl_Browser_.cxx.

Referenced by draw(), handle(), and select().

virtual void Fl_Browser_::item_swap	(	void *	a,
		void *	b
	)		`[inline, protected, virtual]`

This optional method should be provided by the subclass to efficiently swap browser items a and b, such as for sorting.

Parameters:

[in] a,b The two items to be swapped.

Reimplemented in Fl_Browser.

Definition at line 147 of file Fl_Browser_.H.

Referenced by sort().

virtual const char* Fl_Browser_::item_text ( void * item ) const [inline, protected, virtual]

This optional method returns a string (label) that may be used for sorting.

Parameters:

[in] item The item whose label text is returned.

Returns:: The item's text label. (Can be NULL if blank)

Reimplemented in Fl_Browser.

Definition at line 141 of file Fl_Browser_.H.

Referenced by sort().

virtual int Fl_Browser_::item_width ( void * item ) const [protected, pure virtual]

This method must be provided by the subclass to return the width of the item in pixels. Allow for two additional pixels for the list selection box.

Parameters:

[in] item The item whose width is returned.

Returns:: The width of the item in pixels.

Implemented in Fl_Browser.

Referenced by draw().

int Fl_Browser_::leftedge ( ) const [protected]

This method returns the X position of the left edge of the list area after adjusting for the scrollbar and border, if any.

Returns:: The X position of the left edge of the list, in pixels.

See also:: Fl_Browser_::bbox()

Definition at line 102 of file Fl_Browser_.cxx.

References bbox(), and H.

void Fl_Browser_::new_list ( ) [protected]

This method should be called when the list data is completely replaced or cleared. It informs the Fl_Browser_ widget that any cached information it has concerning the items is invalid. This method does not clear the list, it just handles the follow up bookkeeping after the list has been cleared.

Definition at line 496 of file Fl_Browser_.cxx.

References redraw_lines().

Referenced by Fl_Check_Browser::clear(), and Fl_Browser::clear().

int Fl_Browser_::position ( ) const [inline]

Gets the vertical scroll position of the list as a pixel position pos. The position returned is how many pixels of the list are scrolled off the top edge of the screen. Example: A position of '3' indicates the top 3 pixels of the list are scrolled off the top edge of the screen.

See also:: position(), hposition()

Definition at line 219 of file Fl_Browser_.H.

Referenced by display(), handle(), and Fl_Browser::lineposition().

void Fl_Browser_::position ( int pos )

Sets the vertical scroll position of the list to pixel position pos. The position is how many pixels of the list are scrolled off the top edge of the screen. Example: A position of '3' scrolls the top three pixels of the list off the top edge of the screen.

Parameters:

[in] pos The vertical position (in pixels) to scroll the browser to.

See also:: position(), hposition()

Definition at line 204 of file Fl_Browser_.cxx.

References redraw_lines().

void Fl_Browser_::redraw_line ( void * item ) [protected]

This method should be called when the contents of item has changed, but not its height.

Parameters:

[in] item The item that needs to be redrawn.

See also:: redraw_lines(), redraw_line()

Definition at line 134 of file Fl_Browser_.cxx.

References Fl_Widget::damage(), FL_DAMAGE_EXPOSE, and FL_DAMAGE_SCROLL.

Referenced by deselect(), handle(), Widget_Browser::handle(), Fl_Browser::icon(), Fl_Browser::insert(), replacing(), select(), swapping(), and Fl_Browser::text().

void Fl_Browser_::redraw_lines ( ) [inline, protected]

This method will cause the entire list to be redrawn.

See also:: redraw_lines(), redraw_line()

Definition at line 187 of file Fl_Browser_.H.

References FL_DAMAGE_SCROLL.

Referenced by deleting(), hposition(), inserting(), new_list(), and position().

void Fl_Browser_::replacing	(	void *	a,
		void *	b
	)		`[protected]`

This method should be used when item a is being replaced by item b. It allows the Fl_Browser_ to update its cache data as needed, schedules a redraw for the item being changed, and tries to maintain the selection. This method does not actually replace the item, but handles the follow up bookkeeping after the item has just been replaced.

Parameters:

[in]	a	Item being replaced
[in]	b	Item to replace 'a'

Definition at line 544 of file Fl_Browser_.cxx.

References b, and redraw_line().

Referenced by Fl_Browser::icon(), and Fl_Browser::text().

void Fl_Browser_::resize	(	int	X,
		int	Y,
		int	W,
		int	H
	)		`[virtual]`

Repositions and/or resizes the browser.

Parameters:

[in] X,Y,W,H The new position and size for the browser, in pixels.

Reimplemented from Fl_Group.

Definition at line 114 of file Fl_Browser_.cxx.

References Fl_Widget::align(), bbox(), FL_ALIGN_LEFT, FL_ALIGN_TOP, H, hscrollbar, Fl_Widget::resize(), scrollbar, and scrollbar_size().

Referenced by Fl_File_Chooser::preview().

void Fl_Browser_::scrollbar_left ( ) [inline]

Moves the vertical scrollbar to the lefthand side of the list. For back compatibility.

Definition at line 370 of file Fl_Browser_.H.

References Fl_Widget::align(), and FL_ALIGN_LEFT.

void Fl_Browser_::scrollbar_right ( ) [inline]

Moves the vertical scrollbar to the righthand side of the list. For back compatibility.

Definition at line 365 of file Fl_Browser_.H.

References Fl_Widget::align(), and FL_ALIGN_RIGHT.

int Fl_Browser_::scrollbar_size ( ) const [inline]

Gets the current size of the scrollbars' troughs, in pixels.

If this value is zero (default), this widget will use the Fl::scrollbar_size() value as the scrollbar's width.

Returns:: Scrollbar size in pixels, or 0 if the global Fl::scrollsize() is being used.

See also:: Fl::scrollbar_size(int)

Definition at line 315 of file Fl_Browser_.H.

Referenced by bbox(), draw(), and resize().

void Fl_Browser_::scrollbar_size ( int size ) [inline]

Sets the pixel size of the scrollbars' troughs to the size, in pixels.

Normally you should not need this method, and should use Fl::scrollbar_size(int) instead to manage the size of ALL your widgets' scrollbars. This ensures your application has a consistent UI, is the default behavior, and is normally what you want.

Only use THIS method if you really need to override the global scrollbar size. The need for this should be rare.

Setting size to the special value of 0 causes the widget to track the global Fl::scrollbar_size(), which is the default.

Parameters:

[in] size Sets the scrollbar size in pixels.
If 0 (default), scrollbar size tracks the global Fl::scrollbar_size()

See also:: Fl::scrollbar_size()

Definition at line 337 of file Fl_Browser_.H.

References size.

void Fl_Browser_::scrollbar_width ( int width ) [inline]

This method has been deprecated, existing for backwards compatibility only. Use scrollbar_size(int) instead. This method sets the global Fl::scrollbar_size(), and forces this instance of the widget to use it.

Todo:: This method should eventually be removed in 1.4+

Definition at line 357 of file Fl_Browser_.H.

References Fl::scrollbar_size().

int Fl_Browser_::scrollbar_width ( ) const [inline]

This method has been deprecated, existing for backwards compatibility only. Use scrollbar_size() instead. This method always returns the global value Fl::scrollbar_size().

Returns:: Always returns the global value Fl::scrollbar_size().

Todo:: This method should eventually be removed in 1.4+

Definition at line 347 of file Fl_Browser_.H.

References Fl::scrollbar_size().

int Fl_Browser_::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.

If docallbacks is non-zero, select tries to call the callback function for the widget.

Parameters:

[in]	item	The item whose selection state is to be changed
[in]	val	The new selection state (1=select, 0=de-select)
[in]	docallbacks	If 1, invokes widget callback if item changed. If 0, doesn't do callback (default).

Returns:: 1 if state was changed, 0 if not.

Definition at line 614 of file Fl_Browser_.cxx.

References display(), Fl_Widget::do_callback(), FL_MULTI_BROWSER, item_select(), item_selected(), redraw_line(), Fl_Widget::set_changed(), and Fl_Widget::type().

Referenced by deselect(), handle(), select(), select_all_cb(), select_none_cb(), select_only(), and Fl_Browser::value().

int Fl_Browser_::select_only	(	void *	item,
		int	docallbacks = `0`
	)

Selects item and returns 1 if the state changed or 0 if it did not. Any other items in the list are deselected.

Parameters:

[in]	item	The `item` to select.
[in]	docallbacks	If 1, invokes widget callback if item changed. If 0, doesn't do callback (default).

Definition at line 678 of file Fl_Browser_.cxx.

References Fl_Widget_Tracker::deleted(), deselect(), display(), FL_MULTI_BROWSER, item_first(), item_next(), select(), and Fl_Widget::type().

Referenced by handle(), and select_only().

void* Fl_Browser_::selection ( ) const [inline, protected]

Returns the item currently selected, or NULL if there is no selection.

For multiple selection browsers this call returns the currently focused item, even if it is not selected. To find all selected items, call Fl_Multi_Browser::selected() for every item in question.

Definition at line 175 of file Fl_Browser_.H.

Referenced by Widget_Browser::callback(), Fl_Check_Browser::value(), and Fl_Browser::value().

void Fl_Browser_::sort ( int flags = 0 )

Sort the items in the browser based on flags. item_swap(void*, void*) and item_text(void*) must be implemented for this call.

Parameters:

[in] flags FL_SORT_ASCENDING -- sort in ascending order
FL_SORT_DESCENDING -- sort in descending order
Values other than the above will cause undefined behavior
Other flags may appear in the future.

Todo:: Add a flag to ignore case

Definition at line 998 of file Fl_Browser_.cxx.

References b, FL_SORT_DESCENDING, i, item_first(), item_next(), item_prev(), item_swap(), item_text(), and tb.

void Fl_Browser_::swapping	(	void *	a,
		void *	b
	)		`[protected]`

This method should be used when two items a and b are being swapped. It allows the Fl_Browser_ to update its cache data as needed, schedules a redraw for the two items, and tries to maintain the current selection. This method does not actually swap items, but handles the follow up bookkeeping after items have been swapped.

Parameters:

[in] a,b Items being swapped.

Definition at line 559 of file Fl_Browser_.cxx.

References b, and redraw_line().

Referenced by Fl_Browser::swap().

void Fl_Browser_::textcolor ( Fl_Color col ) [inline]

Sets the default text color for the lines in the browser to color col.

Definition at line 304 of file Fl_Browser_.H.

Fl_Color Fl_Browser_::textcolor ( ) const [inline]

Gets the default text color for the lines in the browser.

Definition at line 300 of file Fl_Browser_.H.

Referenced by Fl_Browser::item_draw(), and Fl_File_Chooser::textcolor().