From 88b4e6fab6c8dae1057567a67ec31718fa9c4649 Mon Sep 17 00:00:00 2001 From: Matthias Melcher Date: Fri, 28 Dec 2007 23:01:40 +0000 Subject: STR #1726, STR #1753: documentation updates git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6008 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl_Browser.html | 7 +++-- documentation/Fl_Browser_.html | 52 ++++++++++++++++++------------------ documentation/Fl_Select_Browser.html | 8 +++--- 3 files changed, 35 insertions(+), 32 deletions(-) (limited to 'documentation') diff --git a/documentation/Fl_Browser.html b/documentation/Fl_Browser.html index c701c84c1..4ef1c7599 100644 --- a/documentation/Fl_Browser.html +++ b/documentation/Fl_Browser.html @@ -80,18 +80,19 @@ subclass of Fl_Browser_.

  • move
  • position
  • remove
    • -
  • show
    • +
  • selected
    • @@ -196,6 +197,8 @@ will always return 0.

    The second form sets the vertical scrollbar position to p.

    void Fl_Browser::remove(int n)

    Remove line n and make the browser one line shorter. +

    int Fl_Browser::selected(int n) const

    + Return 1 if line n is selected, 0 if it not selected.

    void Fl_Browser::show(int n)

    Makes line n visible for selection.

    int Fl_Browser::size() const

    diff --git a/documentation/Fl_Browser_.html b/documentation/Fl_Browser_.html index 2183d61c7..ea2c1e680 100644 --- a/documentation/Fl_Browser_.html +++ b/documentation/Fl_Browser_.html @@ -113,13 +113,13 @@ int, int, const char * = 0)

    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 +

    [protected] 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. +

    [protected] 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. @@ -140,16 +140,16 @@ callback function for the widget.

    int Fl_Browser_::displayed(void *p) const

    -

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

    [protected] 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. +

    [protected] The first form draws the list within the normal widget bounding box. -

    The second form draws the contents of the browser within the +

    [protected] The second form draws the contents of the browser within the specified bounding box. @@ -161,14 +161,14 @@ displayed at that position then NULL is returned.

    virtual int Fl_Browser_::full_height() const

    -

    This method may be provided by the subclass to indicate the full height +

    [protected] 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() const

    -

    This method may be provided by the subclass to indicate the full width +

    [protected] 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. @@ -178,7 +178,7 @@ width from the item widths.

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

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

    [protected] The second form handles an event within the specified bounding box.

    void @@ -222,52 +222,52 @@ area.

    virtual int Fl_Browser_::incr_height() const

    -

    This method may be provided to return the average height of all items, to +

    [protected] 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. +

    [protected] 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 +

    [protected] 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 +

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

    virtual int Fl_Browser_::item_height(void *p) const

    -

    This method must be provided by the subclass to return the height of the +

    [protected] 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 +

    [protected] 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 +

    [protected] 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) const

    -

    This method may be provided by the subclass to return the height of the +

    [protected] 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 @@ -277,34 +277,34 @@ 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 +

    [protected] 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 +

    [protected] 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) const

    -

    This method must be provided by the subclass to return the width of the +

    [protected] 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 +

    [protected] 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 +

    [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. @@ -319,18 +319,18 @@ area.

    Fl_Browser_::redraw_line(void *p)

    -

    This method should be called when the contents of an item have changed +

    [protected] 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. +

    [protected] 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. +

    [protected] 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. @@ -375,7 +375,7 @@ callback function for the widget.

    void *Fl_Browser_::selection() const

    -

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

    [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 @@ -412,7 +412,7 @@ browser.

    void *Fl_Browser_::top() const

    -

    Returns the item the appears at the top of the list. +

    [protected] Returns the item the appears at the top of the list. diff --git a/documentation/Fl_Select_Browser.html b/documentation/Fl_Select_Browser.html index 930463578..4f516970d 100644 --- a/documentation/Fl_Select_Browser.html +++ b/documentation/Fl_Select_Browser.html @@ -21,10 +21,10 @@

    Description

    - The Fl_Select_Browser class is a subclass of Fl_Browser - which lets the user select a single item, or no items by clicking on -the empty space. As long as the mouse button is held down the item -pointed to by it is highlighted. Normally the callback is done when the +The Fl_Select_Browser class is a subclass of Fl_Browser +which lets the user select a single item, or no items by clicking on +the empty space. As long as the mouse button is held down on an +unselected item it is highlighted. Normally the callback is done when the user presses the mouse, but you can change this with when().

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

    -- cgit v1.2.3