Author: matt
Date: 2007-12-28 15:01:40 -0800 (Fri, 28 Dec 2007)
New Revision: 6008
Log:
STR #1726, STR #1753: documentation updates
Modified:
branches/branch-1.1/CHANGES
branches/branch-1.1/documentation/Fl_Browser.html
branches/branch-1.1/documentation/Fl_Browser_.html
branches/branch-1.1/documentation/Fl_Select_Browser.html
Modified: branches/branch-1.1/CHANGES
===================================================================
--- branches/branch-1.1/CHANGES 2007-12-27 11:02:27 UTC (rev 6007)
+++ branches/branch-1.1/CHANGES 2007-12-28 23:01:40 UTC (rev 6008)
@@ -4,7 +4,7 @@
STR #1457, STR #1458, STR #1460, STR #1481, STR #1578,
STR #1639, STR #1645, STR #1644, STR #1792, STR #1793,
STR #1742, STR #1777, STR #1794, STR #1827, STR #1843,
- STR #1796, STR #1815)
+ STR #1796, STR #1815, STR #1726, STR #1753)
- Fixed 16 bit PNM image support (STR #1847)
- Fixed exposure event on zero size windows (STR #1824)
- Fixed overlay offset for OS X Quartz (STR #1729)
Modified: branches/branch-1.1/documentation/Fl_Browser.html
===================================================================
--- branches/branch-1.1/documentation/Fl_Browser.html 2007-12-27 11:02:27 UTC
(rev 6007)
+++ branches/branch-1.1/documentation/Fl_Browser.html 2007-12-28 23:01:40 UTC
(rev 6008)
@@ -80,18 +80,19 @@
<LI><A href=#Fl_Browser.move>move</A></LI>
<LI><A href=#Fl_Browser.position>position</A></LI>
<LI><A href=#Fl_Browser.remove>remove</A></LI>
-<LI><A href=#Fl_Browser.show>show</A></LI>
+<LI><A href=#Fl_Browser.selected>selected</A></LI>
</UL>
</TD><TD align=left valign=top>
<UL>
+<LI><A href=#Fl_Browser.show>show</A></LI>
<LI><A href=#Fl_Browser.size>size</A></LI>
<LI><A href=#Fl_Browser.swap>swap</A></LI>
<LI><A href=#Fl_Browser.text>text</A></LI>
-<LI><A href=#Fl_Browser.topline>topline</A></LI>
</UL>
</TD>
<TD align=left valign=top>
<UL>
+<LI><A href=#Fl_Browser.topline>topline</A></LI>
<LI><A href=#Fl_Browser.visible>visible</A></LI>
</UL>
</TD></TR>
@@ -196,6 +197,8 @@
<P>The second form sets the vertical scrollbar position to <TT>p</TT>. </P>
<H4><A name=Fl_Browser.remove>void Fl_Browser::remove(int n)</A></H4>
Remove line <TT>n</TT> and make the browser one line shorter.
+<H4><A name=Fl_Browser.selected>int Fl_Browser::selected(int n) const</A></H4>
+ Return 1 if line <TT>n</TT> is selected, 0 if it not selected.
<H4><A name=Fl_Browser.show>void Fl_Browser::show(int n)</A></H4>
Makes line <TT>n</TT> visible for selection.
<H4><A name=Fl_Browser.size>int Fl_Browser::size() const</A></H4>
Modified: branches/branch-1.1/documentation/Fl_Browser_.html
===================================================================
--- branches/branch-1.1/documentation/Fl_Browser_.html 2007-12-27 11:02:27 UTC
(rev 6007)
+++ branches/branch-1.1/documentation/Fl_Browser_.html 2007-12-28 23:01:40 UTC
(rev 6008)
@@ -113,13 +113,13 @@
<H4><A NAME="Fl_Browser_.bbox">Fl_Browser_::bbox(int &x, int &y, int
&w, int &h) const</A></H4>
-<P>This method returns the bounding box for the interior of the list, inside
+<P><tt>[protected]</tt> This method returns the bounding box for the interior
of the list, inside
the scrollbars.
<H4><A NAME="Fl_Browser_.deleting">Fl_Browser_::deleting(void *a)</A></H4>
-<P>This method should be used when an item is deleted from the list.
+<P><tt>[protected]</tt> This method should be used when an item is deleted
from the list.
It allows the <TT>Fl_Browser_</TT> to discard any cached data it has
on the item.
@@ -140,16 +140,16 @@
<H4><A NAME="Fl_Browser_.displayed">int Fl_Browser_::displayed(void *p)
const</A></H4>
-<P>This method returns non-zero if item <TT>p</TT> is currently visible in
+<P><tt>[protected]</tt> This method returns non-zero if item <TT>p</TT> is
currently visible in
the list.
<H4><A NAME="Fl_Browser_.draw">Fl_Browser_::draw()
<BR>Fl_Browser_::draw(int x, int y, int w, int h)</A></H4>
-<P>The first form draws the list within the normal widget bounding box.
+<P><tt>[protected]</tt> The first form draws the list within the normal widget
bounding box.
-<P>The second form draws the contents of the browser within the
+<P><tt>[protected]</tt> The second form draws the contents of the browser
within the
specified bounding box.
@@ -161,14 +161,14 @@
<H4><A NAME="Fl_Browser_.full_height">virtual int Fl_Browser_::full_height()
const</A></H4>
-<P>This method may be provided by the subclass to indicate the full height
+<P><tt>[protected]</tt> 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.
<H4><A NAME="Fl_Browser_.full_width">Fl_Browser_::full_width() const</A></H4>
-<P>This method may be provided by the subclass to indicate the full width
+<P><tt>[protected]</tt> 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 @@
<P>The first form handles an event within the normal widget bounding box.
-<P>The second form handles an event within the specified bounding box.
+<P><tt>[protected]</tt> The second form handles an event within the specified
bounding box.
<H4><A name="Fl_Browser_.has_scrollbar">void
@@ -222,52 +222,52 @@
<H4><A NAME="Fl_Browser_.incr_height">virtual int Fl_Browser_::incr_height()
const</A></H4>
-<P>This method may be provided to return the average height of all items, to
+<P><tt>[protected]</tt> 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.
<H4><A NAME="Fl_Browser_.inserting">Fl_Browser_::inserting(void *a, void
*b)</A></H4>
-<P>This method should be used when an item is added to the list.
+<P><tt>[protected]</tt> This method should be used when an item is added to
the list.
It allows the <TT>Fl_Browser_</TT> to update its cache data as needed.
<H4><A NAME="Fl_Browser_.item_draw">virtual void Fl_Browser_::item_draw(void
*p, int x, int y, int w, int h)</A></H4>
-<P>This method must be provided by the subclass to draw the item
+<P><tt>[protected]</tt> This method must be provided by the subclass to draw
the item
<TT>p</TT> in the area indicated by <TT>x</TT>, <TT>y</TT>, <TT>w</TT>,
and <TT>h</TT>.
<H4><A NAME="Fl_Browser_.item_first">virtual void *Fl_Browser_::item_first()
const</A></H4>
-<P>This method must be provided by the subclass to return the first item in
+<P><tt>[protected]</tt> This method must be provided by the subclass to return
the first item in
the list.
<H4><A NAME="Fl_Browser_.item_height">virtual int
Fl_Browser_::item_height(void *p) const</A></H4>
-<P>This method must be provided by the subclass to return the height of the
+<P><tt>[protected]</tt> This method must be provided by the subclass to return
the height of the
item <TT>p</TT> in pixels. Allow for two additional pixels for the list
selection box.
<H4><A NAME="Fl_Browser_.item_next">virtual void *Fl_Browser_::item_next(void
*p) const</A></H4>
-<P>This method must be provided by the subclass to return the item in
+<P><tt>[protected]</tt> This method must be provided by the subclass to return
the item in
the list after <TT>p</TT>.
<H4><A NAME="Fl_Browser_.item_prev">virtual void *Fl_Browser_::item_prev(void
*p) const</A></H4>
-<P>This method must be provided by the subclass to return the item in
+<P><tt>[protected]</tt> This method must be provided by the subclass to return
the item in
the list before <TT>p</TT>.
<H4><A NAME="Fl_Browser_.item_quick_height">virtual int
Fl_Browser_::item_quick_height(void *p) const</A></H4>
-<P>This method may be provided by the subclass to return the height of the
+<P><tt>[protected]</tt> This method may be provided by the subclass to return
the height of the
item <TT>p</TT> in pixels. Allow for two additional pixels for the list
selection box. This method differs from
<A HREF="#Fl_Browser_.item_height"><TT>item_height</TT></A> in that it is only
@@ -277,34 +277,34 @@
<H4><A NAME="Fl_Browser_.item_select">virtual void
Fl_Browser_::item_select(void *p, int s=1)</A></H4>
-<P>This method must be implemented by the subclass if it supports
+<P><tt>[protected]</tt> This method must be implemented by the subclass if it
supports
multiple selections in the browser. The <TT>s</TT> argument specifies the
selection state for item <TT>p</TT>: 0 = off, 1 = on.
<H4><A NAME="Fl_Browser_.item_selected">virtual int
Fl_Browser_::item_selected(void *p) const</A></H4>
-<P>This method must be implemented by the subclass if it supports
+<P><tt>[protected]</tt> This method must be implemented by the subclass if it
supports
multiple selections in the browser. The method should return 1 if <TT>p</TT>
is selected and 0 otherwise.
<H4><A NAME="Fl_Browser_.item_width">virtual int Fl_Browser_::item_width(void
*p) const</A></H4>
-<P>This method must be provided by the subclass to return the width of the
+<P><tt>[protected]</tt> This method must be provided by the subclass to return
the width of the
item <TT>p</TT> in pixels. Allow for two additional pixels for the list
selection box.
<H4><A NAME="Fl_Browser_.leftedge">int Fl_Browser_::leftedge() const</A></H4>
-<P>This method returns the X position of the left edge of the list area
+<P><tt>[protected]</tt> This method returns the X position of the left edge of
the list area
after adjusting for the scrollbar and border, if any.
<H4><A NAME="Fl_Browser_.new_list">Fl_Browser_::new_list()</A></H4>
-<P>This method should be called when the list data is completely replaced
+<P><tt>[protected]</tt> This method should be called when the list data is
completely replaced
or cleared. It informs the <TT>Fl_Browser_</TT> widget that any cached
information it has concerning the items is invalid.
@@ -319,18 +319,18 @@
<H4><A NAME="Fl_Browser_.redraw_line">Fl_Browser_::redraw_line(void
*p)</A></H4>
-<P>This method should be called when the contents of an item have changed
+<P><tt>[protected]</tt> This method should be called when the contents of an
item have changed
but not changed the height of the item.
<H4><A NAME="Fl_Browser_.redraw_lines">Fl_Browser_::redraw_lines()</A></H4>
-<P>This method will cause the entire list to be redrawn.
+<P><tt>[protected]</tt> This method will cause the entire list to be redrawn.
<H4><A NAME="Fl_Browser_.replacing">Fl_Browser_::replacing(void *a, void
*b)</A></H4>
-<P>This method should be used when an item is replaced in the list.
+<P><tt>[protected]</tt> This method should be used when an item is replaced in
the list.
It allows the <TT>Fl_Browser_</TT> to update its cache data as needed.
@@ -375,7 +375,7 @@
<H4><A NAME="Fl_Browser_.selection">void *Fl_Browser_::selection()
const</A></H4>
-<P>Returns the item currently selected, or NULL if there is no selection.
+<P><tt>[protected]</tt> Returns the item currently selected, or NULL if there
is no selection.
<P>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 @@
<H4><A NAME="Fl_Browser_.top">void *Fl_Browser_::top() const</A></H4>
-<P>Returns the item the appears at the top of the list.
+<P><tt>[protected]</tt> Returns the item the appears at the top of the list.
</BODY>
Modified: branches/branch-1.1/documentation/Fl_Select_Browser.html
===================================================================
--- branches/branch-1.1/documentation/Fl_Select_Browser.html 2007-12-27
11:02:27 UTC (rev 6007)
+++ branches/branch-1.1/documentation/Fl_Select_Browser.html 2007-12-28
23:01:40 UTC (rev 6008)
@@ -21,10 +21,10 @@
</PRE>
</UL>
<H3>Description</H3>
- The <TT>Fl_Select_Browser</TT> class is a subclass of <TT>Fl_Browser</TT>
- 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 <TT>Fl_Select_Browser</TT> class is a subclass of <TT>Fl_Browser</TT>
+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 <TT>when()</TT>.
<P>See <A href=Fl_Browser.html#Fl_Browser><TT>Fl_Browser</TT></A> for
methods to add and remove lines from the browser. </P>
_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit
