diff options
Diffstat (limited to 'documentation/Fl_Widget.html')
| -rw-r--r-- | documentation/Fl_Widget.html | 188 |
1 files changed, 94 insertions, 94 deletions
diff --git a/documentation/Fl_Widget.html b/documentation/Fl_Widget.html index 394b49c21..99c20db3c 100644 --- a/documentation/Fl_Widget.html +++ b/documentation/Fl_Widget.html @@ -19,15 +19,15 @@ </PRE> </UL> <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.html#subclassing">subclass</A> it. +<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.html#subclassing">subclass</A> it. <P>All "property" 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 +parent()</TT>, or <TT>argument()</TT> are implemented as trivial inline +functions and thus are as fast and small as accessing fields in a structure. Unless otherwise noted, the property setting methods such as <TT> -color(n)</TT> or <TT>label(s)</TT> are also trivial inline functions, -even if they change the widget's appearance. It is up to the user code +color(n)</TT> or <TT>label(s)</TT> are also trivial inline functions, +even if they change the widget's appearance. It is up to the user code to call <TT>redraw()</TT> after these. </P> <H3>Methods</H3> <CENTER> @@ -95,81 +95,81 @@ 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">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(). + 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(). <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. + 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. <H4><A NAME="Fl_Widget.type">uchar Fl_Widget::type() const;</A></H4> - This value is used for Forms compatability and to simulate RTTI. + This value 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. -<H4><A name=Fl_Widget.resize>virtual void + 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). + 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> <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. +</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. <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 + 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>. +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 + 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=functions.html#set_color> -<TT>Fl::set_color()</TT></A> to redefine colors. -<H4><A name=Fl_Widget.selection_color>Fl_Color +<TT>Fl::set_color()</TT></A> to redefine colors. +<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 + 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>. +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. -<H4><A name=Fl_Widget.labeltype>void Fl_Widget::label(Fl_Labeltype, + 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. +<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. + 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. <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 + 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: <UL> <LI><TT>FL_ALIGN_CENTER</TT></LI> @@ -183,67 +183,67 @@ can be any of these constants or'd together: </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>. + This color is passed to the labeltype routine, and is typically the +color of the label text. This defaults to <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 +enumeration list</A> for predefined typefaces. The default value uses a Helvetica typeface (Arial for Microsoft® Windows®). The function <A href=functions.html#set_font> -<TT>Fl::set_font() </TT></A> can define new typefaces. +<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*, + 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. + Each widget has a single callback. You can set it or examine it with +these methods. <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 + 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::argument(long)</A></H4> - For convenience you can also define the callback as taking a long + 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. + 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 + 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. + and may not be portable to some machines. <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. + You can cause a widget to do its callback at any time, and even pass +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 +<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 "OK" button. -<P>Most widgets turn this flag off when they do the callback, and when +do_callback()</TT> on the changed ones in response to an "OK" 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 "OK" button. -<H4><A name=Fl_Widget.default_callback>static void +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 "OK" 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 + 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. +. 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> @@ -252,12 +252,12 @@ 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>. +<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 +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. + 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> @@ -284,11 +284,11 @@ displays rather than input devices. This is the same as <TT>(active() && visible() && !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. + Mark 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. + 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. <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 href=Fl_Group.html#Fl_Group> <TT>Fl_Group</TT></A> or <A @@ -297,14 +297,14 @@ HREF="Fl_Window.html#Fl_Window"><tt>Fl_Window</tt></a>. Returns <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>. -<H4><A name=Fl_Widget.inside>int Fl_Widget::inside(const Fl_Widget* a) +this widget. Returns false 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>. +. Returns false 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, -setting <TT>Fl::focus()</TT> to this widget. You should use this -method to assign the focus to an widget. Returns true if the widget + 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, +setting <TT>Fl::focus()</TT> to this widget. You should use this +method to assign the focus to an widget. Returns true if the widget accepted the focus. </BODY></HTML> |