From 0e6e2393bfc7eeaa47b8a2ebd6c2023f560d7a90 Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Fri, 28 Apr 2000 18:15:26 +0000 Subject: Typos reported by Alexander Mai Fl_Browser_ docos finished. Added Fl_Group::init_sizes() description. Added links for common widgets in chapter 3 (?) Fixed formatting problems in subclassing and FLUID chapters. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.0@1100 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl_Browser_.html | 403 ++++++++++++++++++++++++++++++++++------- 1 file changed, 334 insertions(+), 69 deletions(-) (limited to 'documentation/Fl_Browser_.html') diff --git a/documentation/Fl_Browser_.html b/documentation/Fl_Browser_.html index ad5c4ef1e..14aa12a73 100644 --- a/documentation/Fl_Browser_.html +++ b/documentation/Fl_Browser_.html @@ -1,6 +1,6 @@

class Fl_Browser_

Class Hierarchy

Fl_Browser_
~Fl_Browser_
bbox
deleting
deselect
display
displayed
draw
find_item
Fl_Browser_
~Fl_Browser_
bbox
deleting
deselect
display
displayed
draw
find_item

full_height
full_width
handle
has_scrollbar
hposition
incr_height
inserting
item_draw
full_height
full_width
handle
has_scrollbar
hposition
incr_height
inserting
item_draw

item_first
item_height
item_next
item_prev
item_quick_height
item_select
item_selected
item_width
item_first
item_height
item_next
item_prev
item_quick_height
item_select
item_selected
item_width

leftedge
new_list
position
redraw_line
redraw_lines
replacing
resize
scrollbar_left
leftedge
new_list
position
redraw_line
redraw_lines
replacing
resize
scrollbar_left

scrollbar_right
select
select_only
selection
textcolor
textfont
textsize
top
scrollbar_right
select
select_only
selection
textcolor
textfont
textsize
top

Sorry, documentation is incomplete at this time

Fl_Browser::Fl_Browser(int, int, + +
Fl_Browser::Fl_Browser(int, int, int, int, const char * = 0)
- The constructor makes an empty browser. -

Fl_Browser::~Fl_Browser(void)

void + +
The constructor makes an empty browser. + + +
Fl_Browser::~Fl_Browser(void)
+ +
The destructor deletes all list items and destroys the browser. + + +

Fl_Browser_::bbox(int &x, int &y, int &w, int &h) const

This method returns the bounding box for the interior of the list, inside +the scrollbars. + + +

Fl_Browser_::deleting(void *a)

This method should be used when an item is deleted from the list. +It allows the Fl_Browser_ to discard any cached data it has +on the item. + + +

int Fl_Browser_::deselect(int docb=0)

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

If docb is non-zero, deselect tries to call the +callback function for the widget. + + +

Fl_Browser_::display(void *p)

Displays item p, scrolling the list as necessary. + + +

int Fl_Browser_::displayed(void *p) const

This method returns non-zero if item p is currently visible in +the list. + + +

Fl_Browser_::draw() +
Fl_Browser_::draw(int x, int y, int w, int h)

The first form draws the list within the normal widget bounding box. + +

The second form draws the contents of the browser within the +specified bounding box. + + +

void *Fl_Browser_::find_item(int my)

This method returns the item under mouse at my. If no item is +displayed at that position then NULL is returned. + + +

virtual int Fl_Browser_::full_height()

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. + + +

Fl_Browser_::full_width()

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. + + +

Fl_Browser_::handle(int event) +
Fl_Browser_::handle(int event, int x, int y, int w, int h)

The first form handles an event within the normal widget bounding box. + +

The second form handles an event within the specified bounding box. + + +

void Fl_Browser_::has_scrollbar(int h)

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 h: +

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.
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. +

Fl_Color Fl_Browser_::textcolor() -const -
void Fl_Browser_::textcolor(Fl_Color color)

int Fl_Browser_::hposition() const +
Fl_Browser_::hposition(int h)

Gets or sets the horizontal scrolling position of the list. + + +

virtual int Fl_Browser_::incr_height()

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. + + +

Fl_Browser_::inserting(void a, void b)

This method should be used when an item is added to the list. +It allows the Fl_Browser_ to update its cache data as needed. + + +

virtual void Fl_Browser_::item_draw(void *p, int x, int y, int w, int h)

This method must be provided by the subclass to draw the item +p in the area indicated by x, y, w, +and h. + + +

`virtual void *Fl_Browser_::item_first() const`

+ +This method must be provided by the subclass to return the first item in +the list. + + + virtual int Fl_Browser_::item_height(void *p) + +This method must be provided by the subclass to return the height of the +item p in pixels. Allow for two additional pixels for the list +selection box. + + + virtual void *Fl_Browser_::item_next(void *p) const + +This method must be provided by the subclass to return the item in +the list after p. + + + virtual void *Fl_Browser_::item_prev(void *p) const + +This method must be provided by the subclass to return the item in +the list before p. + + + virtual int Fl_Browser_::item_quick_height(void *p) + +This method may be provided by the subclass to return the height of the +item p 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. + + + virtual void Fl_Browser_::item_select(void *p, int s=1) + +This method must be implemented by the subclass if it supports +multiple selections in the browser. The s argument specifies the +selection state for item p: 0 = off, 1 = on. + + + virtual int Fl_Browser_::item_selected(void *p) const + +This method must be implemented by the subclass if it supports +multiple selections in the browser. The method should return 1 if p +is selected and 0 otherwise. + + + virtual int Fl_Browser_::item_width(void *p) + +This method must be provided by the subclass to return the width of the +item p in pixels. Allow for two additional pixels for the list +selection box. + + + int Fl_Browser_::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. + + + Fl_Browser_::new_list() + +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. + + + int Fl_Browser_::position() const + Fl_Browser_::position(int v) const + +Gets or sets the vertical scrolling position of the list. + + + Fl_Browser_::redraw_line(void *p) + +This method should be called when the contents of an item have changed +but not changed the height of the item. + + + Fl_Browser_::redraw_lines() + +This method will cause the entire list to be redrawn. + + + Fl_Browser_::replacing(void *a, void *b) + +This method should be used when an item is replaced in the list. +It allows the Fl_Browser_ to update its cache data as needed. + + + Fl_Browser_::resize(int x, int y, int w, int h) + +Repositions and/or resizes the browser. + + + Fl_Browser_::scrollbar_left() + +This method moves the vertical scrollbar to the lefthand side of the list. + + + Fl_Browser_::scrollbar_right() + +This method moves the vertical scrollbar to the righthand side of the list. + + + int Fl_Browser_::select(void *p, int s=1, int docb=0) + +Sets the selection state of item p to s and +returns 1 if the state changed or 0 if it did not. + + If docb is non-zero, select tries to call the callback +function for the widget. + + + Fl_Browser_::select_only(void *p, int docb=0) + +Selects item p and returns 1 if the state changed or 0 if it did +not. Any other items in the list are deselected. + + If docb is non-zero, select_only tries to call the +callback function for the widget. + + + void *Fl_Browser_::selection() const + +Returns the item currently selected, or NULL if there is no selection. +For multiple selection browsers this call returns the last item that was +selected. + + + Fl_Color Fl_Browser_::textcolor() const + void Fl_Browser_::textcolor(Fl_Color color) + +The first form gets the default text color for the lines in the browser. + The second form sets the default text color to color -Fl_Font Fl_Browser_::textfont() const - void Fl_Browser_::textfont(Fl_Font font) - The first form gets the default text font for the lines in the + + +Fl_Font Fl_Browser_::textfont() const + void Fl_Browser_::textfont(Fl_Font font) + +The first form gets the default text font for the lines in the browser. + The second form sets the default text font to font -uchar Fl_Browser_::textsize() const - void Fl_Browser_::textsize(uchar size) - The first form gets the default text size for the lines in the + + +uchar Fl_Browser_::textsize() const + void Fl_Browser_::textsize(uchar size) + +The first form gets the default text size for the lines in the browser. + The second form sets the default text size to size - \ No newline at end of file + +void *Fl_Browser_::top() const + +Returns the item the appears at the top of the list. + + + + -- cgit v1.2.3

Class Hierarchy

Fl_Browser::Fl_Browser(int, int, + +Fl_Browser::Fl_Browser(int, int, int, int, const char * = 0) - The constructor makes an empty browser. -

void + +The constructor makes an empty browser. + + +Fl_Browser::~Fl_Browser(void) + +The destructor deletes all list items and destroys the browser. + + +

Fl_Browser::Fl_Browser(int, int, + +
Fl_Browser::Fl_Browser(int, int, int, int, const char * = 0)
- The constructor makes an empty browser. -

void + +
The constructor makes an empty browser. + + +
Fl_Browser::~Fl_Browser(void)
+ +
The destructor deletes all list items and destroys the browser. + + +