From 4586bf0fccc12328f6f876c527648f9260c406dc Mon Sep 17 00:00:00 2001
From: Michael R Sweet <michael.r.sweet@gmail.com>
Date: Tue, 9 Apr 2002 17:20:24 +0000
Subject: Tooltip fixes: ignore keyboard events, immediately disable new
 tooltips, show tooltips for box widgets.

Add docos for Fl_Widget::tooltip() methods.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@2060 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 documentation/Fl_Widget.html | 394 ++++++++++++++++++++++++++++---------------
 1 file changed, 259 insertions(+), 135 deletions(-)

(limited to 'documentation')

diff --git a/documentation/Fl_Widget.html b/documentation/Fl_Widget.html
index 7e4a55425..559e1f5fe 100644
--- a/documentation/Fl_Widget.html
+++ b/documentation/Fl_Widget.html
@@ -69,10 +69,10 @@ to call <TT>redraw()</TT> after these. </P>
 <LI><A href=#Fl_Widget.labelsize>labelsize</A></LI>
 <LI><A href=#Fl_Widget.labeltype>labeltype</A></LI>
 <LI><A href=#Fl_Widget.output>output</A></LI>
-<LI><A href=#Fl_Widget.parent>parent</A></LI>
 </UL>
 </TD><TD align=left valign=top>
 <UL>
+<LI><A href=#Fl_Widget.parent>parent</A></LI>
 <LI><A href=#Fl_Widget.position>position</A></LI>
 <LI><A href=#Fl_Widget.redraw>redraw</A></LI>
 <LI><A href=#Fl_Widget.resize>resize</A></LI>
@@ -85,6 +85,7 @@ to call <TT>redraw()</TT> after these. </P>
 </UL>
 </TD><TD align=left valign=top>
 <UL>
+<LI><A href="#Fl_Widget.tooltip">tooltip</A></LI>
 <LI><A href=#Fl_Widget.type>type</A></LI>
 <LI><A href=#Fl_Widget.user_data>user_data</A></LI>
 <LI><A href=#Fl_Widget.visible>visible</A></LI>
@@ -98,178 +99,268 @@ to call <TT>redraw()</TT> after these. </P>
 </TD></TR>
 </TABLE>
 </CENTER>
-<H4><A NAME="Fl_Widget.Fl_Widget">Fl_Widget::Fl_Widget(int x, int y, int w, int h, const char*
+
+<H4><A NAME="Fl_Widget.Fl_Widget">protected Fl_Widget::Fl_Widget(int x, int y, int w, int h, const char*
 label=0);</A></H4>
- This is the protected constructor for an Fl_Widget, but all derived
-widgets have a matching public constructor.  It takes a value for x(),
-y(), w(), h(), and an optional value for label().
+
+<P>Creates a widget at the given position and size. The
+<TT>Fl_Widget</TT> is a protected constructor, but all derived
+widgets have a matching public constructor. It takes a value for
+<TT>x()</TT>, <TT>y()</TT>, <TT>w()</TT>, <TT>h()</TT>, and an
+optional value for <TT>label()</TT>.
+
 <H4><A NAME="Fl_Widget.~Fl_Widget">virtual Fl_Widget::~Fl_Widget();</A></H4>
- Destroying single widgets is not very common.  It is your
-responsibility to either remove() them from any enclosing group, or to
-destroy that group <I>immediately</I> after destroying the children.
+
+<P>Destroys the widget. Destroying single widgets is not very
+common, and it is your responsibility to either
+<TT>remove()</TT> them from any enclosing group or destroy that
+group <I>immediately</I> after destroying the children. You
+almost always want to destroy the parent group instead which
+will destroy all of the child widgets and groups in that group.
+
 <H4><A NAME="Fl_Widget.type">uchar Fl_Widget::type() const;</A></H4>
- This value is used for Forms compatability and to simulate RTTI.
+
+<P>Returns the widget type value, which is used for Forms
+compatability and to simulate RTTI.
+
 <H4><A name=Fl_Widget.x>short Fl_Widget::x() const</A>
 <BR><A name=Fl_Widget.y>short Fl_Widget::y() const</A>
 <BR><A name=Fl_Widget.w>short Fl_Widget::w() const</A>
 <BR><A name=Fl_Widget.h>short Fl_Widget::h() const</A></H4>
- The position of the upper-left corner of the widget in its enclosing
-Fl_Window (<I>not</I> its parent if that is not an Fl_Window), and its
-width and height.
+
+<P>Returns the position of the upper-left corner of the widget
+in its enclosing Fl_Window (<I>not</I> its parent if that is not
+an Fl_Window), and its width and height.
+
 <H4><A name=Fl_Widget.resize>virtual void
 Fl_Widget::resize(int x, int y, int w, int h)</A>
 <BR><A name=Fl_Widget.position>void Fl_Widget::position(short x, short y)</A>
 <BR><A name=Fl_Widget.size>void Fl_Widget::size(short w, short h)</A></H4>
- Change the size or position of the widget.  This is a virtual function
-so the widget may implement its own handling of resizing.  The default
-version does <I>not</I> do redraw(), that is the parent widget's
-responsibility (this is because the parent may know a faster way to
-update the display, such as scrolling from the old position).
-<P><TT>position(x,y)</TT> is a shortcut for <TT>resize(x,y,w(),h())</TT>
-, and <TT>size(w,h)</TT> is a shortcut for <TT>resize(x(),y(),w,h)</TT>
-. </P>
+
+<P>Change the size or position of the widget. This is a virtual
+function so that the widget may implement its own handling of
+resizing. The default version does <I>not</I> call the
+<TT>redraw()</TT> method, but instead relies on the parent
+widget to do so because the parent may know a faster way to
+update the display, such as scrolling from the old position.
+
+<P><TT>position(x,y)</TT> is a shortcut for <TT>resize(x,y,w(),h())</TT>,
+and <TT>size(w,h)</TT> is a shortcut for <TT>resize(x(),y(),w,h)</TT>.</P>
+
 <H4><A name=Fl_Widget.window>Fl_Window* Fl_Widget::window() const;</A></H4>
- Return a pointer to the <A href=Fl_Window.html#Fl_Window><TT>Fl_Window</TT>
-</A> that this widget is in (it will skip any and all parent widgets
-between this and the window).  Returns <TT>NULL</TT> if none.  Note:
-for an <TT>Fl_Window</TT>, this returns its <I>parent</I> window (if
-any), not <I>this</I> window.
+
+<P>Returns a pointer to the primary <A
+href=Fl_Window.html#Fl_Window><TT>Fl_Window</TT></A> widget.
+Returns <TT>NULL</TT> if no window is associated with this
+widget.  Note: for an <TT>Fl_Window</TT> widget, this returns
+its <I>parent</I> window (if any), not <I>this</I> window.
+
 <H4><A name=Fl_Widget.box>Fl_Boxtype Fl_Widget::box() const
 <BR> void Fl_Widget::box(Fl_Boxtype)</A></H4>
- The <TT>box()</TT> identifies a routine that draws the background of
-the widget.  See <A href="common.html#boxtypes">Box Types</A> for the
-available types.  The default depends on the widget, but is usually <TT>
-FL_NO_BOX</TT> or <TT>FL_UP_BOX</TT>.
+
+<P>Gets or sets the box type for the widget, which identifies a
+routine that draws the background of the widget. See <A
+href="common.html#boxtypes">Box Types</A> for the available
+types. The default depends on the widget, but is usually
+<TT>FL_NO_BOX</TT> or <TT>FL_UP_BOX</TT>.
+
 <H4><A name=Fl_Widget.color>Fl_Color Fl_Widget::color() const
-<BR> void Fl_Widget::color(Fl_Color)</A></H4>
- This color is passed to the box routine.  Color is an index into an
-internal table of rgb colors.  For most widgets this defaults to <TT>
-FL_GRAY</TT>.  See the <A href=enumerations.html#Enumerations>
-enumeration list</A> for predefined colors.  Use <A href="Fl.html#Fl.set_color">
-<TT>Fl::set_color()</TT></A> to redefine colors.
+<BR>void Fl_Widget::color(Fl_Color)
+<BR>void Fl_Widget::color(Fl_Color, Fl_Color)</A></H4>
+
+<P>Gets or sets the background color of the widget. The color is
+passed to the box routine. The color is either an index into an
+internal table of RGB colors or an RGB color value generated
+using <TT>fl_rgb_color()</TT>. The default for most widgets is
+<TT>FL_GRAY</TT>. See the <A
+href=enumerations.html#Enumerations>enumeration list</A> for
+predefined colors. Use <A
+href="Fl.html#Fl.set_color"><TT>Fl::set_color()</TT></A> to
+redefine colors.
+
+<P>The two color form sets both the background and selection
+colors. See the description of the <A
+HREF="#Fl_Widget.selection_color"><TT>selection_color()</TT></A>
+method for more information.
+
 <H4><A name=Fl_Widget.selection_color>Fl_Color
 Fl_Widget::selection_color() const
-<BR> void Fl_Widget::selection_color(Fl_Color)</A>
-<BR> void Fl_Widget::color(Fl_Color, Fl_Color)</H4>
- For Forms compatibility a second color is defined.  This is usually
-used to color the widget when it is selected, although some widgets use
-this color for other purposes.  You can set both colors at once with <TT>
-color(a,b)</TT>.
+<BR>void Fl_Widget::selection_color(Fl_Color)</A></H4>
+
+<P>Gets or sets the selection color, which is defined for Forms
+compatibility and is usually used to color the widget when it is
+selected, although some widgets use this color for other
+purposes. You can set both colors at once with
+<TT>color(a,b)</TT>.
+
 <H4><A name=Fl_Widget.label>const char* Fl_Widget::label() const
 <BR> void Fl_Widget::label(const char*)</A></H4>
- The label is printed somewhere on the widget or next to it.  The
-string is <I>not</I> copied, the passed pointer is stored unchanged in
-the widget.
+
+<P>Get or set the current label pointer. The label is shown
+somewhere on or next to the widget. The passed pointer is stored
+unchanged in the widget (the string is <I>not</I> copied), so if
+you need to set the label to a formatted value, make sure the
+buffer is <TT>static</TT>, global, or allocated.
+
 <H4><A name=Fl_Widget.labeltype>void Fl_Widget::label(Fl_Labeltype,
 const char*)
 <BR> uchar Fl_Widget::labeltype() const
 <BR> void Fl_Widget::labeltype(Fl_Labeltype)</A></H4>
- A <A href="common.html#labeltypes"><TT>labeltype</TT></A> identifies a routine that
-draws the label of the widget.  This can be used for special effects
-such as emboss, or to use the <TT>label()</TT> pointer as another form
-of data such as a bitmap.  The value <TT>FL_NORMAL_LABEL</TT> prints
-the label as text.
+
+<P>Gets or sets the <A
+href="common.html#labeltypes"><TT>labeltype</TT></A> which
+identifies the function that draws the label of the widget. This
+is generally used for special effects such as embossing or for
+using the <TT>label()</TT> pointer as another form of data such
+as an icon. The value <TT>FL_NORMAL_LABEL</TT> prints the label
+as plain text.
+
 <H4><A name=Fl_Widget.align>Fl_Align Fl_Widget::align() const
 <BR> void Fl_Widget::align(Fl_Align)</A></H4>
- How the label is printed next to or inside the widget.  The default
-value is <TT>FL_ALIGN_CENTER</TT>, which centers the label.  The value
-can be any of these constants or'd together:
+
+<P>Gets or sets the label alignment, which controls how the
+label is displayed next to or inside the widget. The default
+value is <TT>FL_ALIGN_CENTER</TT>, which centers the label
+inside the widget. The value can be any of these constants
+bitwise-OR'd together:
+
 <UL>
-<LI><TT>FL_ALIGN_CENTER</TT></LI>
-<LI><TT>FL_ALIGN_TOP</TT></LI>
-<LI><TT>FL_ALIGN_BOTTOM</TT></LI>
-<LI><TT>FL_ALIGN_LEFT</TT></LI>
-<LI><TT>FL_ALIGN_RIGHT</TT></LI>
-<LI><TT>FL_ALIGN_INSIDE</TT></LI>
-<LI><TT>FL_ALIGN_CLIP</TT></LI>
-<LI><TT>FL_ALIGN_WRAP</TT></LI>
+	<LI><TT>FL_ALIGN_BOTTOM</TT></LI>
+	<LI><TT>FL_ALIGN_CENTER</TT></LI>
+	<LI><TT>FL_ALIGN_CLIP</TT></LI>
+	<LI><TT>FL_ALIGN_INSIDE</TT></LI>
+	<LI><TT>FL_ALIGN_LEFT</TT></LI>
+	<LI><TT>FL_ALIGN_RIGHT</TT></LI>
+	<LI><TT>FL_ALIGN_TEXT_OVER_IMAGE</TT></LI>
+	<LI><TT>FL_ALIGN_TOP</TT></LI>
+	<LI><TT>FL_ALIGN_WRAP</TT></LI>
 </UL>
+
 <H4><A name=Fl_Widget.labelcolor>Fl_Color Fl_Widget::labelcolor() const
 <BR> void Fl_Widget::labelcolor(Fl_Color)</A></H4>
- This color is passed to the labeltype routine, and is typically the
-color of the label text.  This defaults to <TT>FL_BLACK</TT>.
+
+<P>Gets or sets the label color. The default color is <TT>FL_BLACK</TT>.
+
 <H4><A name=Fl_Widget.labelfont>Fl_Font Fl_Widget::labelfont() const
 <BR> void Fl_Widget::labelfont(Fl_Font)</A></H4>
- Fonts are identified by small 8-bit indexes into a table.  See the <A href=enumerations.html#Enumerations>
-enumeration list</A> for predefined typefaces. The default value uses a
-Helvetica typeface (Arial for Microsoft&reg; Windows&reg;).  The function <A href="Fl.html#Fl.set_font">
-<TT>Fl::set_font() </TT></A> can define new typefaces.
+
+<P>Gets or sets the font to use. Fonts are identified by small
+8-bit indexes into a table.  See the <A
+href=enumerations.html#Enumerations> enumeration list</A> for
+predefined typefaces. The default value uses a Helvetica
+typeface (Arial for Microsoft&reg; Windows&reg;). The function
+<A href="Fl.html#Fl.set_font"><TT>Fl::set_font()</TT></A> can
+define new typefaces.
+
 <H4><A name=Fl_Widget.labelsize>uchar Fl_Widget::labelsize() const
-<BR> void Fl_Widget::labelsize(uchar)</A></H4>
- Fonts are further identified by a point size.  The default is 14.
-<H4><A name=Fl_Widget.callback>typedef void (Fl_Callback)(Fl_Widget*,
-void*)
-<BR> Fl_Callback* Fl_Widget::callback() const
-<BR> void Fl_Widget::callback(Fl_Callback*, void* = 0)</A></H4>
- Each widget has a single callback.  You can set it or examine it with
-these methods.
+<BR>void Fl_Widget::labelsize(uchar)</A></H4>
+
+<P>Gets or sets the font size in pixels. The default size is 14
+pixels.
+
+<H4><A name=Fl_Widget.callback>typedef void (Fl_Callback)(Fl_Widget*, void*)
+<BR>Fl_Callback* Fl_Widget::callback() const
+<BR>void Fl_Widget::callback(Fl_Callback*, void* = 0)
+<BR>void Fl_Widget::callback(void (*)(Fl_Widget*, long), long = 0)
+<BR>void Fl_Widget::callback(void (*)(Fl_Widget*))</A></H4>
+
+<P>Gets or sets the current callback function for the widget.
+Each widget has a single callback.
+
 <H4><A name=Fl_Widget.user_data>void* Fl_Widget::user_data() const
-<BR> void Fl_Widget::user_data(void*)</A></H4>
- You can also just change the <TT>void *</TT> second argument to the
-callback with the <TT>user_data</TT> methods.
-<H4><A name=Fl_Widget.argument>void Fl_Widget::callback(void
-(*)(Fl_Widget*, long), long = 0)
-<BR> long Fl_Widget::argument() const
+<BR>void Fl_Widget::user_data(void*)</A></H4>
+
+<P>Gets or sets the current user data (<TT>void *</TT>) argument
+that is passed to the callback function.
+
+<H4><A name=Fl_Widget.argument>long Fl_Widget::argument() const
 <BR> void Fl_Widget::argument(long)</A></H4>
- For convenience you can also define the callback as taking a long
-argument.  This is implemented by casting this to a <TT>Fl_Callback</TT>
- and casting the <TT>long</TT> to a <TT>void *</TT> and may not be
-portable to some machines.
-<H4>void Fl_Widget::callback(void (*)(Fl_Widget*))</H4>
- For convenience you can also define the callback as taking only one
-argument.  This is implemented by casting this to a <TT>Fl_Callback</TT>
- and may not be portable to some machines.
+
+<P>Gets or sets the current user data (<TT>long</TT>) argument
+that is passed to the callback function. 
+
+<CENTER><TABLE BORDER="1" CELLPADDING="5" CELLSPACING="0" BGCOLOR="#cccccc">
+<TR>
+	<TD><B>Note:</B>
+
+	<P>This is implemented by casting the <TT>long</TT>
+	value to a <TT>void *</TT> and may not be portable on
+	some machines.
+
+	</TD>
+</TR>
+</TABLE></CENTER>
+
 <H4><A name=Fl_Widget.do_callback>void Fl_Widget::do_callback()
 <BR> void Fl_Widget::do_callback(Fl_Widget*, void* = 0)
 <BR> void Fl_Widget::do_callback(Fl_Widget*, long)</A></H4>
- You can cause a widget to do its callback at any time, and even pass
-arbitrary arguments.
+
+<P>Causes a widget to invoke its callback function, optionally
+with arbitrary arguments.
+
 <H4><A name=Fl_Widget.changed>int Fl_Widget::changed() const</A>
 <BR><A name=Fl_Widget.set_changed>void Fl_Widget::set_changed()</A>
 <BR><A name=Fl_Widget.clear_changed>void Fl_Widget::clear_changed()</A></H4>
-<TT>Fl_Widget::changed()</TT> is a flag that is turned on when the user
-changes the value stored in the widget.  This is only used by
-subclasses of <TT>Fl_Widget</TT> that store values, but is in the base
-class so it is easier to scan all the widgets in a panel and <TT>
-do_callback()</TT> on the changed ones in response to an &quot;OK&quot; button.
+
+<P><TT>Fl_Widget::changed()</TT> is a flag that is turned on
+when the user changes the value stored in the widget.  This is
+only used by subclasses of <TT>Fl_Widget</TT> that store values,
+but is in the base class so it is easier to scan all the widgets
+in a panel and <TT> do_callback()</TT> on the changed ones in
+response to an &quot;OK&quot; button.
+
 <P>Most widgets turn this flag off when they do the callback, and when
 the program sets the stored value. </P>
+
 <H4><A name=Fl_Widget.when>Fl_When Fl_Widget::when() const
 <BR> void Fl_Widget::when(Fl_When)</A></H4>
-<TT>Fl_Widget::when()</TT> is a set of bitflags used by subclasses of <TT>
-Fl_Widget</TT> to decide when to do the callback.  If the value is zero
-then the callback is never done.  Other values are described in the
-individual widgets.  This field is in the base class so that you can
-scan a panel and <TT>do_callback()</TT> on all the ones that don't do
-their own callbacks in response to an &quot;OK&quot; button.
+
+<P><TT>Fl_Widget::when()</TT> is a set of bitflags used by
+subclasses of <TT> Fl_Widget</TT> to decide when to do the
+callback.  If the value is zero then the callback is never
+done.  Other values are described in the individual widgets. 
+This field is in the base class so that you can scan a panel and
+<TT>do_callback()</TT> on all the ones that don't do their own
+callbacks in response to an &quot;OK&quot; button.
+
 <H4><A name=Fl_Widget.default_callback>static void
 Fl_Widget::default_callback(Fl_Widget*, void*)</A></H4>
- The default callback, which puts a pointer to the widget on the queue
-returned by <A href="Fl.html#Fl.readqueue"><TT>Fl::readqueue()</TT></A>
-.  You may want to call this from your own callback.
+
+<P>The default callback, which puts a pointer to the widget on
+the queue returned by <A
+href="Fl.html#Fl.readqueue"><TT>Fl::readqueue()</TT></A>. You
+may want to call this from your own callback.
+
 <H4><A name=Fl_Widget.visible>int Fl_Widget::visible() const</A><BR>
 <A name=Fl_Widget.visible_r>int Fl_Widget::visible_r() const</A><BR>
 <A name=Fl_Widget.show>void Fl_Widget::show()</A><BR>
 <A name=Fl_Widget.hide>void Fl_Widget::hide()</A></H4>
-An invisible widget never gets redrawn and does not get events.  The
-<TT>visible()</TT> method returns true if the widget is set to be
-visible.The <TT>visible_r()</TT> method returns true if the widget and
-all of its parents are visible. A widget is only visible if
-<TT>visible()</TT> is true on it <I>and all of its parents</I>. 
+
+<P>An invisible widget never gets redrawn and does not get
+events.  The <TT>visible()</TT> method returns true if the
+widget is set to be visible.The <TT>visible_r()</TT> method
+returns true if the widget and all of its parents are visible. A
+widget is only visible if <TT>visible()</TT> is true on it
+<I>and all of its parents</I>. 
+
 <P>Changing it will send <TT>FL_SHOW</TT> or <TT>FL_HIDE</TT>
 events to the widget. <I>Do not change it if the parent is not
 visible, as this will send false <TT>FL_SHOW</TT> or <TT>FL_HIDE</TT>
  events to the widget</I>. <TT>redraw()</TT> is called if necessary on
 this or the parent.
+
 <H4><A name=Fl_Widget.active>int Fl_Widget::active() const</A><BR>
 <A name=Fl_Widget.active_r>int Fl_Widget::active_r() const</A></BR>
 <A name=Fl_Widget.activate>void Fl_Widget::activate()</A></BR>
 <A name=Fl_Widget.deactivate>void Fl_Widget::deactivate()</A></H4>
-<TT>Fl_Widget::active()</TT> returns whether the widget is active.
-<TT>Fl_Widget::active_r()</TT> returns whether the widget and all of
-its parents are active.  An inactive widget does not get any events,
-but it does get redrawn.  A widget is only active if <TT>active()</TT> is
-true on it <I>and all of its parents</I>.
+
+<P><TT>Fl_Widget::active()</TT> returns whether the widget is
+active. <TT>Fl_Widget::active_r()</TT> returns whether the
+widget and all of its parents are active.  An inactive widget
+does not get any events, but it does get redrawn. A widget is
+only active if <TT>active()</TT> is true on it <I>and all of its
+parents</I>.
+
 <P>Changing this value will send <TT>FL_ACTIVATE</TT> or <TT>
 FL_DEACTIVATE</TT> to the widget if <tt>active_r()</tt> is true.
 <P>Currently you cannot deactivate <TT>Fl_Window</TT> widgets. </P>
@@ -277,34 +368,47 @@ FL_DEACTIVATE</TT> to the widget if <tt>active_r()</tt> is true.
 <H4><A name=Fl_Widget.output>int Fl_Widget::output() const</A><BR>
 <A name=Fl_Widget.set_output>void Fl_Widget::set_output()</A></BR>
 <A name=Fl_Widget.clear_output>void Fl_Widget::clear_output()</A></H4>
-<tt>output()</tt> means the same as <tt>!active()</tt> except it does
-not change how the widget is drawn.  The widget will not receive any
-events.  This is useful for making scrollbars or buttons that work as
-displays rather than input devices.
-
-<H4><A name=Fl_Widget.takesevents>int Fl_Widget::takesevents() const</A>
-</H4>
-This is the same as <TT>(active() &amp;&amp; visible() &amp;&amp;
+
+<P><tt>output()</tt> means the same as <tt>!active()</tt> except
+it does not change how the widget is drawn. The widget will not
+receive any events. This is useful for making scrollbars or
+buttons that work as displays rather than input devices.
+
+<H4><A name=Fl_Widget.takesevents>int Fl_Widget::takesevents() const</A></H4>
+
+<P>This is the same as <TT>(active() &amp;&amp; visible() &amp;&amp;
 !output())</TT> but is faster.
+
 <H4><A name=Fl_Widget.redraw>void Fl_Widget::redraw()</A></H4>
- Mark the widget as needing its <A HREF="subclassing.html#draw"><TT>draw()</TT></A> routine called.
+
+<P>Marks the widget as needing its <A
+HREF="subclassing.html#draw"><TT>draw()</TT></A> routine called.
+
 <H4><A name=Fl_Widget.damage>uchar Fl_Widget::damage() const</A></H4>
- Non-zero if <A HREF="subclassing.html#draw"><TT>draw()</TT></A> needs to be called.  Actually this is a
-bit field that the widget subclass can use to figure out what parts to
-draw.
+
+<P>Non-zero if <A
+HREF="subclassing.html#draw"><TT>draw()</TT></A> needs to be
+called. The damage value is actually a bit field that the widget
+subclass can use to figure out what parts to draw.
+
 <H4><A name=Fl_Widget.parent>Fl_Group *Fl_Widget::parent() const</A></H4>
-Returns a pointer to the parent widget.  Usually this is a <A
+
+<P>Returns a pointer to the parent widget.  Usually this is a <A
 href=Fl_Group.html#Fl_Group> <TT>Fl_Group</TT></A> or <A
-HREF="Fl_Window.html#Fl_Window"><tt>Fl_Window</tt></a>.  Returns
-<tt>NULL</tt> if none.
+HREF="Fl_Window.html#Fl_Window"><tt>Fl_Window</tt></a>. Returns
+<tt>NULL</tt> if the widget has no parent.
 
 <h4><a name="Fl_Widget.contains">int Fl_Widget::contains(Fl_Widget* b) const</A></H4>
-Returns true if <TT>b</TT> is a child of this widget, or is equal to
-this widget.  Returns false  if <TT>b</TT> is <TT>NULL</TT>.
+
+<P>Returns 1 if <TT>b</TT> is a child of this widget, or is
+equal to this widget. Returns 0 if <TT>b</TT> is <TT>NULL</TT>.
+
 <H4><A name=Fl_Widget.inside>int Fl_Widget::inside(const Fl_Widget* a)
 const</A></H4>
- Returns true if this is a child of <TT>a</TT>, or is equal to <TT>a</TT>
-. Returns false if <TT>a</TT> is <TT>NULL</TT>.
+
+<P>Returns 1 if this widget is a child of <TT>a</TT>, or is
+equal to <TT>a</TT>. Returns 0 if <TT>a</TT> is <TT>NULL</TT>.
+
 <H4><A name=Fl_Widget.take_focus>int Fl_Widget::take_focus()</A></H4>
  Tries to make this widget be the <TT>Fl::focus()</TT> widget, by first
 sending it an <TT>FL_FOCUS</TT> event, and if it returns non-zero,
@@ -316,10 +420,30 @@ accepted the focus.
 void Fl_Widget::deimage(Fl_Image* a)<BR>
 void Fl_Widget::deimage(Fl_Image&amp; a)</H4>
 
+<P>Gets or sets the image to use as part of the widget label.
+This image is used when drawing the widget in the inactive
+state.
+
 <H4><A name="Fl_Widget.image">Fl_Image* Fl_Widget::image()</A><BR>
 void Fl_Widget::image(Fl_Image* a)<BR>
 void Fl_Widget::image(Fl_Image&amp; a)</H4>
 
-<H4><A name="Fl_Widget.handle">int Fl_Widget::handle(int)</A></H4>
+<P>Gets or sets the image to use as part of the widget label.
+This image is used when drawing the widget in the active state.
+
+<H4><A name="Fl_Widget.tooltip">const char *Fl_Widget::tooltip()<BR>
+void Fl_Widget::tooltip(const char *t)</A></H4>
+
+<P>Gets or sets a string of text to display in a popup tooltip
+window when the user hovers the mouse over the widget. The
+string is <I>not</I> copied, so make sure any formatted string
+is stored in a <TT>static</TT>, global, or allocated buffer.
+
+<H4><A name="Fl_Widget.handle">virtual int Fl_Widget::handle(int event)</A></H4>
+
+<P>Handles the specified event. You normally don't call this
+method directly, but instead let FLTK do it when the user
+interacts with the widget.
 
-</BODY></HTML>
+</BODY>
+</HTML>
-- 
cgit v1.2.3