From dc70b69502de6769c8fe109161f984494a0c00b8 Mon Sep 17 00:00:00 2001
From: Michael R Sweet <michael.r.sweet@gmail.com>
Date: Tue, 19 Jan 1999 20:53:39 +0000
Subject: Updated documentation with changes from Bill. Added new image files
 for buttons.

git-svn-id: file:///fltk/svn/fltk/trunk@237 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 documentation/Fl_Widget.html | 60 +++++++++++++++++++++++++-------------------
 1 file changed, 34 insertions(+), 26 deletions(-)

(limited to 'documentation/Fl_Widget.html')

diff --git a/documentation/Fl_Widget.html b/documentation/Fl_Widget.html
index 708b061a5..63c534fe6 100644
--- a/documentation/Fl_Widget.html
+++ b/documentation/Fl_Widget.html
@@ -21,7 +21,7 @@
 <H3>Description</H3>
 <TT>Fl_Widget</TT> is the base class for all widgets in FLTK. You can't 
 create one of these because the constructor is not public.  However you 
-can <A href=#subclassing">subclass</A> it. 
+can <A href="#subclassing">subclass</A> it. 
 <P>All &quot;property&quot; accessing methods, such as <TT>color()</TT>, <TT>
 parent()</TT>, or <TT>argument()</TT> are implemented as trivial inline 
 functions and thus are as fast and small as accessing fields in a 
@@ -38,14 +38,15 @@ to call <TT>redraw()</TT> after these. </P>
 <LI><A href=#Fl_Widget.~Fl_Widget>~Fl_Widget</A></LI>
 <LI><A href=#Fl_Widget.activate>activate</A></LI>
 <LI><A href=#Fl_Widget.active>active</A></LI>
+<LI><A href=#Fl_Widget.active_r>active_r</A></LI>
 <LI><A href=#Fl_Widget.activevisible>activevisible</A></LI>
 <LI><A href=#Fl_Widget.align>align</A></LI>
 <LI><A href=#Fl_Widget.argument>argument</A></LI>
 <LI><A href=#Fl_Widget.box>box</A></LI>
-<LI><A href=#Fl_Widget.callback>callback</A></LI>
 </UL>
 </TD><TD align=left valign=top>
 <UL>
+<LI><A href=#Fl_Widget.callback>callback</A></LI>
 <LI><A href=#Fl_Widget.changed>changed</A></LI>
 <LI><A href=#Fl_Widget.clear_changed>clear_changed</A></LI>
 <LI><A href=#Fl_Widget.color>color</A></LI>
@@ -54,10 +55,10 @@ to call <TT>redraw()</TT> after these. </P>
 <LI><A href=#Fl_Widget.deactivate>deactivate</A></LI>
 <LI><A href=#Fl_Widget.default_callback>default_callback</A></LI>
 <LI><A href=#Fl_Widget.do_callback>do_callback</A></LI>
-<LI><A href=#Fl_Widget.h>h</A></LI>
 </UL>
 </TD><TD align=left valign=top>
 <UL>
+<LI><A href=#Fl_Widget.h>h</A></LI>
 <LI><A href=#Fl_Widget.hide>hide</A></LI>
 <LI><A href=#Fl_Widget.inside>inside</A></LI>
 <LI><A href=#Fl_Widget.label>label</A></LI>
@@ -77,12 +78,13 @@ to call <TT>redraw()</TT> after these. </P>
 <LI><A href=#Fl_Widget.show>show</A></LI>
 <LI><A href=#Fl_Widget.size>size</A></LI>
 <LI><A href=#Fl_Widget.take_focus>take_focus</A></LI>
+<LI><A href=#Fl_Widget.type>type</A></LI>
 </UL>
 </TD><TD align=left valign=top>
 <UL>
-<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>
+<LI><A href=#Fl_Widget.visible_r>visible_r</A></LI>
 <LI><A href=#Fl_Widget.w>w</A></LI>
 <LI><A href=#Fl_Widget.when>when</A></LI>
 <LI><A href=#Fl_Widget.window>window</A></LI>
@@ -115,7 +117,7 @@ Fl_Widget::resize(int,int,int,int)</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 it's own handling of resizing.  The default 
+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). 
@@ -126,7 +128,7 @@ update the display, such as scrolling from the old position).
  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 it's <I>parent</I> window (if 
+for an <TT>Fl_Window</TT>, 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>
@@ -241,27 +243,31 @@ 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=functions.html#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.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.  An 
-widget is really visible if <TT>visible()</TT> is true on it <I>and all 
-it's parents</I>.  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 
+<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>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.activate>void Fl_Widget::activate()</A>
-<BR><A name=Fl_Widget.deactivate>void Fl_Widget::deactivate()</A>
-<BR></H4>
-<TT>Fl_Widget::active()</TT> returns whether the widget is active.  An 
-inactive widget does not get any events, but it does get redrawn.  A 
-widget is active if <TT>active()</TT> is true on it <I>and all it's 
-parents</I>. Changing this value will send <TT>FL_ACTIVATE</TT> or <TT>
-FL_DEACTIVATE</TT> to the widget. <I>Do not change it if the parent is 
-not active, as this will send false <TT>FL_ACTIVATE</TT> or <TT>
-FL_DEACTIVATE</TT> events to the widget</I>. 
+<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>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>
 <H4><A name=Fl_Widget.activevisible>int Fl_Widget::activevisible() const</A>
 </H4>
@@ -273,8 +279,10 @@ FL_DEACTIVATE</TT> events to the widget</I>.
 bit field that the widget subclass can use to figure out what parts to 
 draw. 
 <H4><A name=Fl_Widget.parent>Fl_Widget *Fl_Widget::parent() const</A></H4>
- 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 Fl_Widget.contains" href="Fl_Window><tt>Fl_Window</tt></a>.  Returns <tt>NULL</tt> if none.
+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.
 
 <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
-- 
cgit v1.2.3