mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Edited basic chapters to be more doxygen-friendly, added \image html

Browse Source 
statements.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6245 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Albrecht Schlosser 2008-09-14 21:58:12 +00:00
parent 7f544a0cf9
commit de6f468b51
3 changed files with 225 additions and 264 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

199
documentation/basics.dox
View File

@ -7,84 +7,82 @@ that use FLTK.</P>
<H2>Writing Your First FLTK Program</H2> <H2>Writing Your First FLTK Program</H2>
<P>All programs must include the file <TT>&lt;FL/Fl.H&gt;</TT>. <P>All programs must include the file <TT><FL/Fl.H></TT>.
In addition the program must include a header file for each In addition the program must include a header file for each
FLTK class it uses. Listing 1 shows a simple &quot;Hello, FLTK class it uses. Listing 1 shows a simple "Hello,
World!&quot; program that uses FLTK to display the window.</P> World!" program that uses FLTK to display the window.</P>
<UL> <P><I>Listing 1 - "hello.cxx"</I>
<P><I>Listing 1 - &quot;hello.cxx&quot;</I> \code
<PRE> #include <FL/Fl.H>
#include &lt;FL/Fl.H&gt; #include <FL/Fl_Window.H>
#include &lt;FL/Fl_Window.H&gt; #include <FL/Fl_Box.H>
#include &lt;FL/Fl_Box.H&gt;
int main(int argc, char **argv) { int main(int argc, char **argv) {
<A href="Fl_Window.html">Fl_Window</A> *window = new <A href="Fl_Window.html#Fl_Window.Fl_Window">Fl_Window</A>(300,180); Fl_Window *window = new Fl_Window(300,180);
<A href="Fl_Box.html">Fl_Box</A> *box = new <A href="Fl_Box.html#Fl_Box.Fl_Box">Fl_Box</A>(20,40,260,100,&quot;Hello, World!&quot;); Fl_Box *box = new Fl_Box(20,40,260,100,"Hello, World!");
box-&gt;<A href="Fl_Widget.html#Fl_Widget.box">box</A>(<A href="common.html#boxtypes">FL_UP_BOX</A>); box->box(FL_UP_BOX);
box-&gt;<A href="Fl_Widget.html#Fl_Widget.labelsize">labelsize</A>(36); box->labelsize(36);
box-&gt;<A href="Fl_Widget.html#Fl_Widget.labelfont">labelfont</A>(<A href="drawing.html#fonts">FL_BOLD</A>+<A href="drawing.html#fonts">FL_ITALIC</A>); box->labelfont(FL_BOLD+FL_ITALIC);
box-&gt;<A href="Fl_Widget.html#Fl_Widget.labeltype">labeltype</A>(<A href="common.html#labels">FL_SHADOW_LABEL</A>); box->labeltype(FL_SHADOW_LABEL);
window-&gt;<A href="Fl_Group.html#Fl_Group.end">end</A>(); window->end();
window-&gt;<A href="Fl_Window.html#Fl_Window.show">show</A>(argc, argv); window->show(argc, argv);
return <A href="Fl.html#Fl.run">Fl::run</A>(); return Fl::run();
} }
</PRE></UL> \endcode
<!-- NEED 2in --> <!-- NEED 2in -->
<P>After including the required header files, the program then creates a <P>After including the required header files, the program then creates a
window. All following widgets will automatically be children of this window.</P> window. All following widgets will automatically be children of this window.</P>
<UL><PRE> \code
Fl_Window *window = new <A href="Fl_Window.html#Fl_Window">Fl_Window</A>(300,180); Fl_Window *window = new Fl_Window(300,180);
</PRE></UL> \endcode
<P>Then we create a box with the &quot;Hello, World!&quot; string in it. FLTK automatically adds <P>Then we create a box with the "Hello, World!" string in it. FLTK automatically adds
the new box to <tt>window</tt>, the current grouping widget.</P> the new box to <tt>window</tt>, the current grouping widget.</P>
<UL><PRE> \code
Fl_Box *box = new <A href="Fl_Box.html#Fl_Box">Fl_Box</A>(20,40,260,100,&quot;Hello, World!&quot;); Fl_Box *box = new Fl_Box(20,40,260,100,"Hello, World!");
</PRE></UL> \endcode
<P>Next, we set the type of box and the size, font, and style of the label:</P> <P>Next, we set the type of box and the size, font, and style of the label:</P>
<UL><PRE> \code
box-&gt;<A href="Fl_Widget.html#Fl_Widget.box">box</A>(FL_UP_BOX); box->box(FL_UP_BOX);
box-&gt;<A href=Fl_Widget.html#Fl_Widget.labelsize>labelsize</A>(36); box->labelsize(36);
box-&gt;<A href=Fl_Widget.html#Fl_Widget.labelfont>labelfont</A>(FL_BOLD+FL_ITALIC); box->labelfont(FL_BOLD+FL_ITALIC);
box-&gt;<A href=Fl_Widget.html#Fl_Widget.labeltype>labeltype</A>(FL_SHADOW_LABEL); box->labeltype(FL_SHADOW_LABEL);
</PRE></UL> \endcode
<P>We tell FLTK that we will not add any more widgets to <tt>window</tt>.</P> <P>We tell FLTK that we will not add any more widgets to <tt>window</tt>.</P>
<UL><PRE> \code
window-&gt;<A href=Fl_Group.html#Fl_Group.end>end</A>(); window->end();
</PRE></UL> \endcode
<P>Finally, we show the window and enter the FLTK event loop:</P> <P>Finally, we show the window and enter the FLTK event loop:</P>
<UL><PRE> \code
window-&gt;<A href=Fl_Window.html#Fl_Window.show>show</A>(argc, argv); window->show(argc, argv);
return <A href="Fl.html#Fl.run">Fl::run</A>(); return Fl::run();
</PRE></UL> \endcode
<P>The resulting program will display the window in Figure 2-1. <P>The resulting program will display the window in Figure 2-1.
You can quit the program by closing the window or pressing the You can quit the program by closing the window or pressing the
<KBD>ESC</KBD>ape key.</P> <KBD>ESC</KBD>ape key.</P>
<P ALIGN="CENTER"><IMG src="hello.C.gif" alt="Hello, World! Window"><BR> \image html hello.C.gif "Figure 2-1: The Hello, World! Window"
<I>Figure 2-1: The Hello, World! Window</I></P>
<H3>Creating the Widgets</H3> <H3>Creating the Widgets</H3>
<P>The widgets are created using the C++ <TT>new</TT> operator. For <P>The widgets are created using the C++ <TT>new</TT> operator. For
most widgets the arguments to the constructor are:</P> most widgets the arguments to the constructor are:</P>
<UL><PRE> \code
Fl_Widget(x, y, width, height, label) Fl_Widget(x, y, width, height, label)
</PRE></UL> \endcode
<P>The <TT>x</TT> and <TT>y</TT> parameters determine where the <P>The <TT>x</TT> and <TT>y</TT> parameters determine where the
widget or window is placed on the screen. In FLTK the top left widget or window is placed on the screen. In FLTK the top left
@ -107,8 +105,8 @@ copy of it - it just uses the pointer.</P>
<P>Widgets are commonly ordered into functional groups, which <P>Widgets are commonly ordered into functional groups, which
in turn may be grouped again, creating a hierarchy of widgets. in turn may be grouped again, creating a hierarchy of widgets.
FLTK makes it easy to fill groups by automatically adding all widgets FLTK makes it easy to fill groups by automatically adding all widgets
that are created between a <tt>myGroup-&gt;begin()</tt> and that are created between a <tt>myGroup->begin()</tt> and
<tt>myGroup-&gt;end()</tt>. In this example, <tt>myGroup</tt> <tt>myGroup->end()</tt>. In this example, <tt>myGroup</tt>
would be the <i>current</i> group.</P> would be the <i>current</i> group.</P>
<P>Newly created groups and their derived widgets implicitly call <P>Newly created groups and their derived widgets implicitly call
@ -122,19 +120,19 @@ hierarchies. New widgets can now be added manually using
<H3>Get/Set Methods</H3> <H3>Get/Set Methods</H3>
<P><tt>box-&gt;box(FL_UP_BOX)</tt> sets the type of box the <P><tt>box->box(FL_UP_BOX)</tt> sets the type of box the
Fl_Box draws, changing it from the default of Fl_Box draws, changing it from the default of
<tt>FL_NO_BOX</tt>, which means that no box is drawn. In our <tt>FL_NO_BOX</tt>, which means that no box is drawn. In our
&quot;Hello, World!&quot; example we use <TT>FL_UP_BOX</TT>, "Hello, World!" example we use <TT>FL_UP_BOX</TT>,
which means that a raised button border will be drawn around which means that a raised button border will be drawn around
the widget. You can learn more about boxtypes in the widget. You can learn more about boxtypes in
<A href="common.html#boxtypes">Chapter 3</A>.</P> <A href="common.html#boxtypes">Chapter 3</A>.</P>
<P>You could examine the boxtype in by doing <P>You could examine the boxtype in by doing
<tt>box-&gt;box()</tt>. FLTK uses method name overloading to make <tt>box->box()</tt>. FLTK uses method name overloading to make
short names for get/set methods. A "set" method is always of short names for get/set methods. A "set" method is always of
the form "void&nbsp;name(type)", and a "get" method is always the form "void name(type)", and a "get" method is always
of the form "type&nbsp;name()&nbsp;const".</P> of the form "type name() const".</P>
<H3>Redrawing After Changing Attributes</H3> <H3>Redrawing After Changing Attributes</H3>
@ -148,6 +146,11 @@ only common exceptions are <tt>value()</tt> which calls
<H3>Labels</H3> <H3>Labels</H3>
<P>All widgets support labels. In the case of window widgets,
the label is used for the label in the title bar. Our example
program calls the <TT>labelfont()</TT>,<TT> labelsize</TT>,
and <TT>labeltype()</TT> methods.</P>
<P>All widgets support labels. In the case of window widgets, <P>All widgets support labels. In the case of window widgets,
the label is used for the label in the title bar. Our example the label is used for the label in the title bar. Our example
program calls the <A href=Fl_Widget.html#Fl_Widget.labelfont> program calls the <A href=Fl_Widget.html#Fl_Widget.labelfont>
@ -203,17 +206,16 @@ write, or when an error condition occurs on a file. They are
most often used to monitor network connections (sockets) for most often used to monitor network connections (sockets) for
data-driven displays.</P> data-driven displays.</P>
<P>FLTK applications must periodically check <P>FLTK applications must periodically check (Fl::check())
(<TT>Fl::check()</TT>) or wait (<TT>Fl::wait()</TT>) for events or wait (Fl::wait()) for events or use the Fl::run()
or use the <A href="Fl.html#Fl.run"><TT>Fl::run()</TT></A>
method to enter a standard event processing loop. Calling method to enter a standard event processing loop. Calling
<TT>Fl::run()</TT> is equivalent to the following code:</P> Fl::run() is equivalent to the following code:</P>
<UL><PRE> \code
while (Fl::wait()); while (Fl::wait());
</PRE></UL> \endcode
<P><TT>Fl::run()</TT> does not return until all of the windows <P>Fl::run() does not return until all of the windows
under FLTK control are closed by the user or your program.</P> under FLTK control are closed by the user or your program.</P>
<H2>Compiling Programs with Standard Compilers</H2> <H2>Compiling Programs with Standard Compilers</H2>
@ -222,71 +224,64 @@ under FLTK control are closed by the user or your program.</P>
tools) you will probably need to tell the compiler where to find the tools) you will probably need to tell the compiler where to find the
header files. This is usually done using the <TT>-I</TT> option:</P> header files. This is usually done using the <TT>-I</TT> option:</P>
<UL><PRE> \code
CC -I/usr/local/include ... CC -I/usr/local/include ...
gcc -I/usr/local/include ... gcc -I/usr/local/include ...
</PRE></UL> \endcode
<P>The <TT>fltk-config</TT> script included with FLTK can be <P>The <TT>fltk-config</TT> script included with FLTK can be
used to get the options that are required by your compiler:</P> used to get the options that are required by your compiler:</P>
<UL><PRE> \code
CC `fltk-config --cxxflags` ... CC `fltk-config --cxxflags` ...
</PRE></UL> \endcode
<P>Similarly, when linking your application you will need to tell the <P>Similarly, when linking your application you will need to tell the
compiler to use the FLTK library:</P> compiler to use the FLTK library:</P>
<UL><PRE> \code
CC ... -L/usr/local/lib -lfltk -lXext -lX11 -lm CC ... -L/usr/local/lib -lfltk -lXext -lX11 -lm
gcc ... -L/usr/local/lib -lfltk -lXext -lX11 -lm gcc ... -L/usr/local/lib -lfltk -lXext -lX11 -lm
</PRE></UL> \endcode
<P>Aside from the "fltk" library, there is also a "fltk_forms" <P>Aside from the "fltk" library, there is also a "fltk_forms"
library for the XForms compatibility classes, "fltk_gl" for the library for the XForms compatibility classes, "fltk_gl" for the
OpenGL and GLUT classes, and "fltk_images" for the image file OpenGL and GLUT classes, and "fltk_images" for the image file
classes, <A classes, Fl_Help_Dialog widget, and system icon support.
HREF="Fl_Help_Dialog.html#Fl_Help_Dialog"><CODE>Fl_Help_Dialog</CODE></A>
widget, and system icon support.
<CENTER><TABLE WIDTH="80%" BORDER="1" CELLPADDING="10" BGCOLOR="#cccccc"> \note
<TR> The libraries are named "fltk.lib", "fltkgl.lib", "fltkforms.lib",
<TD><B>Note:</B>
<P>The libraries are named "fltk.lib", "fltkgl.lib", "fltkforms.lib",
and "fltkimages.lib", respectively under Windows. and "fltkimages.lib", respectively under Windows.
</TD>
</TR>
</TABLE></CENTER>
<P>As before, the <TT>fltk-config</TT> script included with FLTK can be <P>As before, the <TT>fltk-config</TT> script included with FLTK can be
used to get the options that are required by your linker:</P> used to get the options that are required by your linker:</P>
<UL><PRE> \code
CC ... `fltk-config --ldflags` CC ... `fltk-config --ldflags`
</PRE></UL> \endcode
<!-- NEED 2in --> <!-- NEED 2in -->
<P>The forms, GL, and images libraries are included with the "--use-foo" <P>The forms, GL, and images libraries are included with the "--use-foo"
options, as follows: options, as follows:
<UL><PRE> \code
CC ... `fltk-config --use-forms --ldflags` CC ... `fltk-config --use-forms --ldflags`
CC ... `fltk-config --use-gl --ldflags` CC ... `fltk-config --use-gl --ldflags`
CC ... `fltk-config --use-images --ldflags` CC ... `fltk-config --use-images --ldflags`
CC ... `fltk-config --use-forms --use-gl --use-images --ldflags` CC ... `fltk-config --use-forms --use-gl --use-images --ldflags`
</PRE></UL> \endcode
<P>Finally, you can use the <TT>fltk-config</TT> script to <P>Finally, you can use the <TT>fltk-config</TT> script to
compile a single source file as a FLTK program: compile a single source file as a FLTK program:
<UL><PRE> \code
fltk-config --compile filename.cpp fltk-config --compile filename.cpp
fltk-config --use-forms --compile filename.cpp fltk-config --use-forms --compile filename.cpp
fltk-config --use-gl --compile filename.cpp fltk-config --use-gl --compile filename.cpp
fltk-config --use-images --compile filename.cpp fltk-config --use-images --compile filename.cpp
fltk-config --use-forms --use-gl --use-images --compile filename.cpp fltk-config --use-forms --use-gl --use-images --compile filename.cpp
</PRE></UL> \endcode
<P>Any of these will create an executable named <TT>filename</TT>. <P>Any of these will create an executable named <TT>filename</TT>.
@ -294,11 +289,10 @@ fltk-config --use-forms --use-gl --use-images --compile filename.cpp
<P>In Visual C++ you will need to tell the compiler where to <P>In Visual C++ you will need to tell the compiler where to
find the FLTK header files. This can be done by selecting find the FLTK header files. This can be done by selecting
&quot;Settings&quot; from the &quot;Project&quot; menu and then "Settings" from the "Project" menu and then changing the
changing the &quot;Preprocessor&quot; settings under the "Preprocessor" settings under the "C/C++" tab. You will also
&quot;C/C++&quot; tab. You will also need to add the FLTK and need to add the FLTK and WinSock2 (WS2_32.LIB) libraries to
WinSock (WSOCK32.LIB) libraries to the &quot;Link&quot; the "Link" settings.</P>
settings.</P>
<P>You can build your Microsoft Windows applications as Console or <P>You can build your Microsoft Windows applications as Console or
WIN32 applications. If you want to use the standard C <TT>main()</TT> WIN32 applications. If you want to use the standard C <TT>main()</TT>
@ -306,7 +300,7 @@ function as the entry point, FLTK includes a <TT>WinMain()</TT>
function that will call your <TT>main()</TT> function for you.</P> function that will call your <TT>main()</TT> function for you.</P>
<P><I>Note: The Visual C++ 5.0 optimizer is known to cause problems with <P><I>Note: The Visual C++ 5.0 optimizer is known to cause problems with
many programs. We only recommend using the &quot;Favor Small Code&quot; many programs. We only recommend using the "Favor Small Code"
optimization setting.</I> The Visual C++ 6.0 optimizer seems to be much optimization setting.</I> The Visual C++ 6.0 optimizer seems to be much
better and can be used with the "optimized for speed" setting.</P> better and can be used with the "optimized for speed" setting.</P>
@ -325,7 +319,7 @@ better and can be used with the "optimized for speed" setting.</P>
<LI><A href="enumerations.html">Constants and <LI><A href="enumerations.html">Constants and
enumerations</A> are uppercase: <TT>FL_FOO</TT>.</LI> enumerations</A> are uppercase: <TT>FL_FOO</TT>.</LI>
<LI>All header files start with <TT>&lt;FL/...&gt;</TT>. <LI>All header files start with <TT><FL/...></TT>.
</LI> </LI>
</UL> </UL>
@ -336,27 +330,20 @@ better and can be used with the "optimized for speed" setting.</P>
<P>The proper way to include FLTK header files is:</P> <P>The proper way to include FLTK header files is:</P>
<UL><PRE> \code
#include &lt;FL/Fl_xyz.H&gt; #include <FL/Fl_xyz.H>
</PRE></UL> \endcode
<CENTER><TABLE BORDER="1" CELLPADDING="10" BGCOLOR="#cccccc"> \note
<TR> Case <I>is</I> significant on many operating systems,
<TD><B>Note:</B>
<P>Case <I>is</I> significant on many operating systems,
and the C standard uses the forward slash (/) to and the C standard uses the forward slash (/) to
separate directories. <i>Do not use any of the following separate directories. <i>Do not use any of the following
include lines:</i></P> include lines:</i>
<UL><PRE> \code
#include &lt;FL\Fl_xyz.H&gt; #include <FL\Fl_xyz.H>
#include &lt;fl/fl_xyz.h&gt; #include <fl/fl_xyz.h>
#include &lt;Fl/fl_xyz.h&gt; #include <Fl/fl_xyz.h>
</PRE></UL> \endcode
</TD>
</TR>
</TABLE></CENTER>
*/ */

284
documentation/common.dox
View File

@ -11,61 +11,49 @@ attributes.</P>
<P>FLTK provides many types of buttons:</P> <P>FLTK provides many types of buttons:</P>
<UL> <UL>
<LI>Fl_Button - A standard push button.</LI>
<LI><A HREF="Fl_Button.html"><TT>Fl_Button</TT></A> - A <LI>Fl_Check_Button - A button with a check box.</LI>
standard push button.</LI>
<LI><A HREF="Fl_Check_Button.html"><TT>Fl_Check_Button</TT></A> - <LI>Fl_Light_Button - A push button with a light.</LI>
A button with a check box.</LI>
<LI><A HREF="Fl_Light_Button.html"><TT>Fl_Light_Button</TT></A> - <LI>Fl_Repeat_Button - A push button that repeats
A push button with a light.</LI> when held.</LI>
<LI><A HREF="Fl_Repeat_Button.html"><TT>Fl_Repeat_Button</TT></A> - <LI>Fl_Return_Button - A push button that is activated
A push button that repeats when held.</LI> by the <KBD>Enter</KBD> key.</LI>
<LI><A HREF="Fl_Return_Button.html"><TT>Fl_Return_Button</TT></A> - <LI>Fl_Round_Button - A button with a radio circle.</LI>
A push button that is activated by the <KBD>Enter</KBD> key.</LI>
<LI><A HREF="Fl_Round_Button.html"><TT>Fl_Round_Button</TT></A> -
A button with a radio circle.</LI>
</UL> </UL>
<P ALIGN="CENTER"><IMG SRC="buttons.gif" ALT="FLTK Buttons"><BR> \image html buttons.gif "Figure 3-1: FLTK Button Widgets"
Figure 3-1: FLTK Button Widgets</P>
<P>All of these buttons just need the corresponding <P>All of these buttons just need the corresponding
<TT>&lt;FL/Fl_xyz_Button.H&gt;</TT> header file. The constructor <TT><FL/Fl_xyz_Button.H></TT> header file. The constructor
takes the bounding box of the button and optionally a label takes the bounding box of the button and optionally a label
string:</P> string:</P>
<UL><PRE> \code
Fl_Button *button = new Fl_Button(x, y, width, height, &quot;label&quot;); Fl_Button *button = new Fl_Button(x, y, width, height, "label");
Fl_Light_Button *lbutton = new Fl_Light_Button(x, y, width, height); Fl_Light_Button *lbutton = new Fl_Light_Button(x, y, width, height);
Fl_Round_Button *rbutton = new Fl_Round_Button(x, y, width, height, &quot;label&quot;); Fl_Round_Button *rbutton = new Fl_Round_Button(x, y, width, height, "label");
</PRE></UL> \endcode
<P>Each button has an associated <P>Each button has an associated <TT>type()</TT> which allows
<A href="Fl_Button.html#Fl_Button.type"><TT>type()</TT></A> it to behave as a push button, toggle button, or radio button:</P>
which allows it to behave as a push button, toggle button, or
radio button:</P>
<UL><PRE> \code
button-&gt;type(FL_NORMAL_BUTTON); button->type(FL_NORMAL_BUTTON);
lbutton-&gt;type(FL_TOGGLE_BUTTON); lbutton->type(FL_TOGGLE_BUTTON);
rbutton-&gt;type(FL_RADIO_BUTTON); rbutton->type(FL_RADIO_BUTTON);
</PRE></UL> \endcode
<P>For toggle and radio buttons, the <P>For toggle and radio buttons, the value() method returns
<A href="Fl_Button.html#Fl_Button.value"><TT>value()</TT></A> the current button state (0 = off, 1 = on). The set() and
method returns the current button state (0 = off, 1 = on). The clear() methods can be used on toggle buttons to turn a
<A href="Fl_Button.html#Fl_Button.set"><TT>set()</TT></A> and toggle button on or off, respectively.
<A href="Fl_Button.html#Fl_Button.clear"><TT>clear()</TT></A> Radio buttons can be turned on with the setonly()
methods can be used on toggle buttons to turn a toggle button
on or off, respectively. Radio buttons can be turned on with
the
<A href="Fl_Button.html#Fl_Button.setonly"><TT>setonly()</TT></A>
method; this will also turn off other radio buttons in the same method; this will also turn off other radio buttons in the same
group.</P> group.</P>
@ -74,41 +62,32 @@ group.</P>
<P>FLTK provides several text widgets for displaying and receiving text:</P> <P>FLTK provides several text widgets for displaying and receiving text:</P>
<UL> <UL>
<LI>Fl_Input - A one-line text input field.</LI>
<LI><A HREF="Fl_Input.html"><TT>Fl_Input</TT></A> - A <LI>Fl_Output - A one-line text output field.</LI>
one-line text input field.</LI>
<LI><A HREF="Fl_Output.html"><TT>Fl_Output</TT></A> - A <LI>Fl_Multiline_Input - A multi-line text input field.</LI>
one-line text output field.</LI>
<LI><A HREF="Fl_Multiline_Input.html"><TT>Fl_Multiline_Input</TT></A> <LI>Fl_Multiline_Output - A multi-line text output field.</LI>
- A multi-line text input field. </LI>
<LI><A HREF="Fl_Multiline_Output.html"><TT>Fl_Multiline_Output</TT></A> <LI>Fl_Text_Display - A multi-line text display widget.</LI>
- A multi-line text output field.</LI>
<LI><A HREF="Fl_Text_Display.html"><TT>Fl_Text_Display</TT></A> <LI>Fl_Text_Editor - A multi-line text editing widget.</LI>
- A multi-line text display widget.</LI>
<LI><A HREF="Fl_Text_Editor.html"><TT>Fl_Text_Editor</TT></A> -
A multi-line text editing widget. </LI>
<LI><A HREF="Fl_Help_View.html"><TT>Fl_Help_View</TT></A> - A
HTML text display widget.</LI>
<LI>Fl_Help_View - A HTML text display widget.</LI>
</UL> </UL>
<P>The <TT>Fl_Output</TT> and <TT>Fl_Multiline_Output</TT> <P>The <TT>Fl_Output</TT> and <TT>Fl_Multiline_Output</TT>
widgets allow the user to copy text from the output field but widgets allow the user to copy text from the output field but
not change it.</P> not change it.</P>
<P>The <A href="Fl_Input.html#Fl_Input.value"><TT>value()</TT></A> <P>The <TT>value()</TT> method is used to get or set the
method is used to get or set the string that is displayed:</P> string that is displayed:</P>
<UL><PRE> \code
Fl_Input *input = new Fl_Input(x, y, width, height, &quot;label&quot;); Fl_Input *input = new Fl_Input(x, y, width, height, "label");
input-&gt;value(&quot;Now is the time for all good men...&quot;); input->value("Now is the time for all good men...");
</PRE></UL> \endcode
<P>The string is copied to the widget's own storage when you set <P>The string is copied to the widget's own storage when you set
the <tt>value()</tt> of the widget.</P> the <tt>value()</tt> of the widget.</P>
@ -126,28 +105,25 @@ strings. FLTK provides the following valuators:</P>
<UL> <UL>
<LI><A HREF="Fl_Counter.html"><TT>Fl_Counter</TT></A> - A widget with arrow buttons that shows the <LI>Fl_Counter - A widget with arrow buttons that shows the
current value. </LI> current value.</LI>
<LI><A HREF="Fl_Dial.html"><TT>Fl_Dial</TT></A> - A round knob. </LI> <LI>Fl_Dial - A round knob.</LI>
<LI><A HREF="Fl_Roller.html"><TT>Fl_Roller</TT></A> - An SGI-like dolly widget. </LI> <LI>Fl_Roller - An SGI-like dolly widget.</LI>
<LI><A HREF="Fl_Scrollbar.html"><TT>Fl_Scrollbar</TT></A> - A standard scrollbar widget. </LI> <LI>Fl_Scrollbar - A standard scrollbar widget.</LI>
<LI><A HREF="Fl_Slider.html"><TT>Fl_Slider</TT></A> - A scrollbar with a knob. </LI> <LI>Fl_Slider - A scrollbar with a knob.</LI>
<LI><A HREF="Fl_Value_Slider.html"><TT>Fl_Value_Slider</TT></A> - A slider that shows the current value. </LI> <LI>Fl_Value_Slider - A slider that shows the current value.</LI>
</UL> </UL>
<P ALIGN="CENTER"><IMG SRC="valuators.gif" ALT="FLTK Valuators"><BR> \image html valuators.gif "Figure 3-2: FLTK valuator widgets"
<I>Figure 3-2: FLTK valuator widgets</I></P>
<P>The <A href="Fl_Valuator.html#Fl_Valuator.value"><TT>value()</TT></A> <P>The <TT>value()</TT> method gets and sets the current value
method gets and sets the current value of the widget. The of the widget. The <TT>minimum()</TT> and <TT>maximum()</TT>
<A href="Fl_Valuator.html#Fl_Valuator.minimum"><TT>minimum()</TT></A>
and <A href="Fl_Valuator.html#Fl_Valuator.maximum"><TT>maximum()</TT></A>
methods set the range of values that are reported by the methods set the range of values that are reported by the
widget.</P> widget.</P>
@ -156,29 +132,31 @@ widget.</P>
<H2>Groups</H2> <H2>Groups</H2>
<P>The <TT>Fl_Group</TT> widget class is used as a general <P>The <TT>Fl_Group</TT> widget class is used as a general
purpose &quot;container&quot; widget. Besides grouping radio purpose "container" widget. Besides grouping radio
buttons, the groups are used to encapsulate windows, tabs, and buttons, the groups are used to encapsulate windows, tabs, and
scrolled windows. The following group classes are available scrolled windows. The following group classes are available
with FLTK:</P> with FLTK:</P>
<UL> <UL>
<LI><A HREF="Fl_Double_Window.html"><TT>Fl_Double_Window</TT></A> - A double-buffered window on the screen. </LI> <LI>Fl_Double_Window - A double-buffered window on the screen.</LI>
<LI><A HREF="Fl_Gl_Window.html"><TT>Fl_Gl_Window</TT></A> - An OpenGL window on the screen. </LI> <LI>Fl_Gl_Window - An OpenGL window on the screen.</LI>
<LI><A HREF="Fl_Group.html"><TT>Fl_Group</TT></A> - The base container class; can be used to group <LI>Fl_Group - The base container class; can be used to group
any widgets together. </LI> any widgets together.</LI>
<LI><A HREF="Fl_Pack.html"><TT>Fl_Pack</TT></A> - A collection of widgets that are packed into the group area.</LI> <LI>Fl_Pack - A collection of widgets that are packed into the group area.</LI>
<LI><A HREF="Fl_Scroll.html"><TT>Fl_Scroll</TT></A> - A scrolled window area. </LI> <LI>Fl_Scroll - A scrolled window area.</LI>
<LI><A HREF="Fl_Tabs.html"><TT>Fl_Tabs</TT></A> - Displays child widgets as tabs. </LI> <LI>Fl_Tabs - Displays child widgets as tabs.</LI>
<LI><A HREF="Fl_Tile.html"><TT>Fl_Tile</TT></A> - A tiled window area.</LI> <LI>Fl_Tile - A tiled window area.</LI>
<LI><A HREF="Fl_Window.html"><TT>Fl_Window</TT></A> - A window on the screen. </LI> <LI>Fl_Window - A window on the screen.</LI>
<LI>Fl_Wizard - Displays one group of widgets at a time.</LI>
</UL> </UL>
@ -192,11 +170,11 @@ create them. You can access them with the <tt>x()</tt>,
<TT>position()</TT>, <TT> resize()</TT>, and <TT>size()</TT> <TT>position()</TT>, <TT> resize()</TT>, and <TT>size()</TT>
methods:</P> methods:</P>
<UL><PRE> \code
button-&gt;position(x, y); button->position(x, y);
group-&gt;resize(x, y, width, height); group->resize(x, y, width, height);
window-&gt;size(width, height); window->size(width, height);
</PRE></UL> \endcode
<P>If you change a widget's size or position after it is <P>If you change a widget's size or position after it is
displayed you will have to call <tt>redraw()</tt> on the displayed you will have to call <tt>redraw()</tt> on the
@ -228,6 +206,8 @@ fixed contents.</P>
<LI><TT>FL_CYAN</TT></LI> <LI><TT>FL_CYAN</TT></LI>
<LI><TT>FL_WHITE</TT></LI> <LI><TT>FL_WHITE</TT></LI>
<LI>FL_WHITE</LI>
</UL> </UL>
<P>These symbols are the default colors for all FLTK widgets. They are <P>These symbols are the default colors for all FLTK widgets. They are
@ -244,35 +224,34 @@ explained in more detail in the chapter
<LI><TT>FL_SELECTION_COLOR</TT> </LI> <LI><TT>FL_SELECTION_COLOR</TT> </LI>
</UL> </UL>
<P>RGB colors can be set using the <A HREF="functions.html#fl_rgb_color"><TT>fl_rgb_color()</TT></A> <P>RGB colors can be set using the <TT>fl_rgb_color()</TT>
function:</P> function:</P>
<UL><PRE> \code
Fl_Color c = fl_rgb_color(85, 170, 255); Fl_Color c = fl_rgb_color(85, 170, 255);
</PRE></UL> \endcode
<P>The widget color is set using the <TT>color()</TT> method:</P> <P>The widget color is set using the <TT>color()</TT> method:</P>
<UL><PRE> \code
button-&gt;color(FL_RED); button->color(FL_RED);
</PRE></UL> \endcode
<P>Similarly, the label color is set using the <TT>labelcolor()</TT> <P>Similarly, the label color is set using the <TT>labelcolor()</TT>
method:</P> method:</P>
<UL><PRE> \code
button-&gt;labelcolor(FL_WHITE); button->labelcolor(FL_WHITE);
</PRE></UL> \endcode
<H2><A NAME="boxtypes">Box Types</A></H2> <H2><A NAME="boxtypes">Box Types</A></H2>
<P>The type <TT>Fl_Boxtype</TT> stored and returned in <P>The type <TT>Fl_Boxtype</TT> stored and returned in
<A href="Fl_Widget.html#Fl_Widget.box"><TT>Fl_Widget::box()</TT></A> <A href="Fl_Widget.html#Fl_Widget.box"><TT>Fl_Widget::box()</TT></A>
is an enumeration defined in <A href="enumerations.html#Enumerations"><TT>&lt;Enumerations.H&gt;</TT></A>. is an enumeration defined in <A href="enumerations.html#Enumerations"><TT><Enumerations.H></TT></A>.
Figure 3-3 shows the standard box types included with FLTK.</P> Figure 3-3 shows the standard box types included with FLTK.</P>
<P ALIGN="CENTER"><IMG src="boxtypes.gif" ALT="FLTK Box Types"><BR> \image html boxtypes.gif "Figure 3-3: FLTK box types"
<I>Figure 3-3: FLTK box types</I></P>
<P><TT>FL_NO_BOX</TT> means nothing is drawn at all, so whatever is <P><TT>FL_NO_BOX</TT> means nothing is drawn at all, so whatever is
already on the screen remains. The <TT>FL_..._FRAME</TT> types only already on the screen remains. The <TT>FL_..._FRAME</TT> types only
@ -297,25 +276,25 @@ the box and adding it to the table of boxtypes.</P>
<P>The drawing function is passed the bounding box and background color <P>The drawing function is passed the bounding box and background color
for the widget:</P> for the widget:</P>
<UL><PRE> \code
void xyz_draw(int x, int y, int w, int h, Fl_Color c) { void xyz_draw(int x, int y, int w, int h, Fl_Color c) {
... ...
} }
</PRE></UL> \endcode
<!-- NEED 3in --> <!-- NEED 3in -->
<P>A simple drawing function might fill a rectangle with the <P>A simple drawing function might fill a rectangle with the
given color and then draw a black outline:</P> given color and then draw a black outline:</P>
<UL><PRE> \code
void xyz_draw(int x, int y, int w, int h, Fl_Color c) { void xyz_draw(int x, int y, int w, int h, Fl_Color c) {
fl_color(c); fl_color(c);
fl_rectf(x, y, w, h); fl_rectf(x, y, w, h);
fl_color(FL_BLACK); fl_color(FL_BLACK);
fl_rect(x, y, w, h); fl_rect(x, y, w, h);
} }
</PRE></UL> \endcode
<H4><A name="fl_down">Fl_Boxtype fl_down(Fl_Boxtype)</A></H4> <H4><A name="fl_down">Fl_Boxtype fl_down(Fl_Boxtype)</A></H4>
@ -343,11 +322,11 @@ See also: <TT><A HREF="#fl_frame">fl_frame</A></TT>.
<P>The <TT>Fl::set_boxtype()</TT> method adds or replaces the <P>The <TT>Fl::set_boxtype()</TT> method adds or replaces the
specified box type:</P> specified box type:</P>
<UL><PRE> \code
#define XYZ_BOX FL_FREE_BOXTYPE #define XYZ_BOX FL_FREE_BOXTYPE
Fl::set_boxtype(XYZ_BOX, xyz_draw, 1, 1, 2, 2); Fl::set_boxtype(XYZ_BOX, xyz_draw, 1, 1, 2, 2);
</PRE></UL> \endcode
<P>The last 4 arguments to <TT>Fl::set_boxtype()</TT> are the <P>The last 4 arguments to <TT>Fl::set_boxtype()</TT> are the
offsets for the x, y, width, and height values that should be offsets for the x, y, width, and height values that should be
@ -376,13 +355,12 @@ for the label. Symbols can be included with the label string by
escaping them using the "@" symbol - "@@" displays a single at escaping them using the "@" symbol - "@@" displays a single at
sign. Figure 3-4 shows the available symbols.</P> sign. Figure 3-4 shows the available symbols.</P>
<P ALIGN="CENTER"><A name="symbols"><IMG src="symbols.gif" ALT="FLTK Symbols"><BR> \image html symbols.gif "Figure 3-4: FLTK label symbols"
<I>Figure 3-4: FLTK label symbols</I></A></P>
<!-- NEED 2in --> <!-- NEED 2in -->
<P>The @ sign may also be followed by the following optional <P>The @ sign may also be followed by the following optional
&quot;formatting&quot; characters, in this order:</P> "formatting" characters, in this order:</P>
<UL> <UL>
@ -402,7 +380,7 @@ sign. Figure 3-4 shows the available symbols.</P>
</UL> </UL>
<P>Thus, to show a very large arrow pointing downward you would use the <P>Thus, to show a very large arrow pointing downward you would use the
label string "@+92-&gt;". label string "@+92->".
<H3>align()</H3> <H3>align()</H3>
@ -495,11 +473,11 @@ function is called with a pointer to a <TT>Fl_Label</TT>
structure containing the label information, the bounding box for structure containing the label information, the bounding box for
the label, and the label alignment:</P> the label, and the label alignment:</P>
<UL><PRE> \code
void xyz_draw(const Fl_Label *label, int x, int y, int w, int h, Fl_Align align) { void xyz_draw(const Fl_Label *label, int x, int y, int w, int h, Fl_Align align) {
... ...
} }
</PRE></UL> \endcode
<P>The label should be drawn <I>inside</I> this bounding box, <P>The label should be drawn <I>inside</I> this bounding box,
even if <TT>FL_ALIGN_INSIDE</TT> is not enabled. The function even if <TT>FL_ALIGN_INSIDE</TT> is not enabled. The function
@ -509,11 +487,11 @@ is not called if the label value is <TT>NULL</TT>.</P>
<TT>Fl_Label</TT> structure and references to the width and <TT>Fl_Label</TT> structure and references to the width and
height:</P> height:</P>
<UL><PRE> \code
void xyz_measure(const Fl_Label *label, int &amp;w, int &amp;h) { void xyz_measure(const Fl_Label *label, int &w, int &h) {
... ...
} }
</PRE></UL> \endcode
<P>The function should measure the size of the label and set <P>The function should measure the size of the label and set
<TT>w</TT> and <TT>h</TT> to the size it will occupy.</P> <TT>w</TT> and <TT>h</TT> to the size it will occupy.</P>
@ -523,11 +501,11 @@ void xyz_measure(const Fl_Label *label, int &amp;w, int &amp;h) {
<P>The <TT>Fl::set_labeltype</TT> method creates a label type <P>The <TT>Fl::set_labeltype</TT> method creates a label type
using your draw and measure functions:</P> using your draw and measure functions:</P>
<UL><PRE> \code
#define XYZ_LABEL FL_FREE_LABELTYPE #define XYZ_LABEL FL_FREE_LABELTYPE
Fl::set_labeltype(XYZ_LABEL, xyz_draw, xyz_measure); Fl::set_labeltype(XYZ_LABEL, xyz_draw, xyz_measure);
</PRE></UL> \endcode
<P>The label type number <TT>n</TT> can be any integer value <P>The label type number <TT>n</TT> can be any integer value
starting at the constant <TT>FL_FREE_LABELTYPE</TT>. Once you starting at the constant <TT>FL_FREE_LABELTYPE</TT>. Once you
@ -550,19 +528,19 @@ to generate a vector shape inside a two-by-two units sized box
around the origin. This function is then linked into the symbols around the origin. This function is then linked into the symbols
table using <tt>fl_add_symbol</tt>:</P> table using <tt>fl_add_symbol</tt>:</P>
<UL><PRE> \code
<A NAME="fl_add_symbol">int fl_add_symbol(const char *name, void (*drawit)(Fl_Color), int scalable)</A> int fl_add_symbol(const char *name, void (*drawit)(Fl_Color), int scalable)
</PRE></UL> \endcode
<P><i>name</i> is the name of the symbol without the "@"; <i>scalable</I> <P><i>name</i> is the name of the symbol without the "@"; <i>scalable</I>
must be set to 1 if the symbol is generated using scalable vector drawing must be set to 1 if the symbol is generated using scalable vector drawing
functions.</P> functions.</P>
<UL><PRE> \code
<A NAME="fl_draw_symbol">int fl_draw_symbol(const char *name,int x,int y,int w,int h,Fl_Color col)</A> int fl_draw_symbol(const char *name,int x,int y,int w,int h,Fl_Color col)
</PRE></UL> \endcode
<P>This function draw a named symbol fitting the given rectangle. <P>This function draws a named symbol fitting the given rectangle.
<H2>Callbacks</H2> <H2>Callbacks</H2>
@ -571,36 +549,35 @@ widget changes. A callback function is sent a <TT>Fl_Widget</TT>
pointer of the widget that changed and a pointer to data that pointer of the widget that changed and a pointer to data that
you provide:</P> you provide:</P>
<UL><PRE> \code
void xyz_callback(Fl_Widget *w, void *data) { void xyz_callback(Fl_Widget *w, void *data) {
... ...
} }
</PRE></UL> \endcode
<P>The <TT>callback()</TT> method sets the callback function for a <P>The <TT>callback()</TT> method sets the callback function for a
widget. You can optionally pass a pointer to some data needed for the widget. You can optionally pass a pointer to some data needed for the
callback:</P> callback:</P>
<UL><PRE> \code
int xyz_data; int xyz_data;
button-&gt;callback(xyz_callback, &amp;xyz_data); button->callback(xyz_callback, &xyz_data);
</PRE></UL> \endcode
<P>Normally callbacks are performed only when the value of the <P>Normally callbacks are performed only when the value of the
widget changes. You can change this using the widget changes. You can change this using the Fl_Widget::when()
<A href="Fl_Widget.html#Fl_Widget.when"><TT>when()</TT></A>
method:</P> method:</P>
<UL><PRE> \code
button-&gt;when(FL_WHEN_NEVER); button->when(FL_WHEN_NEVER);
button-&gt;when(FL_WHEN_CHANGED); button->when(FL_WHEN_CHANGED);
button-&gt;when(FL_WHEN_RELEASE); button->when(FL_WHEN_RELEASE);
button-&gt;when(FL_WHEN_RELEASE_ALWAYS); button->when(FL_WHEN_RELEASE_ALWAYS);
button-&gt;when(FL_WHEN_ENTER_KEY); button->when(FL_WHEN_ENTER_KEY);
button-&gt;when(FL_WHEN_ENTER_KEY_ALWAYS); button->when(FL_WHEN_ENTER_KEY_ALWAYS);
button-&gt;when(FL_WHEN_CHANGED | FL_WHEN_NOT_CHANGED); button->when(FL_WHEN_CHANGED | FL_WHEN_NOT_CHANGED);
</PRE></UL> \endcode
<CENTER><TABLE WIDTH="80%" BORDER="1" CELLPADDING="5" CELLSPACING="0" BGCOLOR="#cccccc"> <CENTER><TABLE WIDTH="80%" BORDER="1" CELLPADDING="5" CELLSPACING="0" BGCOLOR="#cccccc">
<TR> <TR>
@ -608,8 +585,7 @@ button-&gt;when(FL_WHEN_CHANGED | FL_WHEN_NOT_CHANGED);
<P>You cannot delete a widget inside a callback, as the <P>You cannot delete a widget inside a callback, as the
widget may still be accessed by FLTK after your callback widget may still be accessed by FLTK after your callback
is completed. Instead, use the <a is completed. Instead, use the Fl::delete_widget()
href='Fl.html#Fl.delete_widget'><tt>Fl::delete_widget()</tt></a>
method to mark your widget for deletion when it is safe method to mark your widget for deletion when it is safe
to do so.</p> to do so.</p>
@ -628,17 +604,17 @@ button-&gt;when(FL_WHEN_CHANGED | FL_WHEN_NOT_CHANGED);
<TT>callback()</TT> method of the widget can be a <TT>callback()</TT> method of the widget can be a
pointer to the instance of your class.</P> pointer to the instance of your class.</P>
<PRE> \code
class Foo { class Foo {
void my_callback(Fl_Widget *w); void my_callback(Fl_Widget *w);
static void my_static_callback(Fl_Widget *w, void *f) { ((Foo *)f)-&gt;my_callback(w); } static void my_static_callback(Fl_Widget *w, void *f) { ((Foo *)f)->my_callback(w); }
... ...
} }
... ...
w-&gt;callback(my_static_callback, (void *)this); w->callback(my_static_callback, (void *)this);
</PRE> \endcode
</TD> </TD>
</TR> </TR>
</TABLE></CENTER> </TABLE></CENTER>
@ -649,14 +625,14 @@ w-&gt;callback(my_static_callback, (void *)this);
buttons or menu items. The <TT>shortcut()</TT> method sets the buttons or menu items. The <TT>shortcut()</TT> method sets the
shortcut for a widget:</P> shortcut for a widget:</P>
<UL><PRE> \code
button-&gt;shortcut(FL_Enter); button->shortcut(FL_Enter);
button-&gt;shortcut(FL_SHIFT + 'b'); button->shortcut(FL_SHIFT + 'b');
button-&gt;shortcut(FL_CTRL + 'b'); button->shortcut(FL_CTRL + 'b');
button-&gt;shortcut(FL_ALT + 'b'); button->shortcut(FL_ALT + 'b');
button-&gt;shortcut(FL_CTRL + FL_ALT + 'b'); button->shortcut(FL_CTRL + FL_ALT + 'b');
button-&gt;shortcut(0); // no shortcut button->shortcut(0); // no shortcut
</PRE></UL> \endcode
<P>The shortcut value is the key event value - the ASCII value <P>The shortcut value is the key event value - the ASCII value
or one of the special keys like or one of the special keys like

6
documentation/editor.dox
View File

@ -150,8 +150,7 @@ custom window. To keep things simple we will have a
the &quot;replace next &quot; button is a the &quot;replace next &quot; button is a
<TT>Fl_Return_Button</TT> widget:</P> <TT>Fl_Return_Button</TT> widget:</P>
<P ALIGN="CENTER"><IMG src="editor-replace.gif" ALT="The search and replace dialog."><BR> \image html editor-replace.gif "Figure 4-1: The search and replace dialog"
<I>Figure 4-1: The search and replace dialog.</I></P>
<UL><PRE> <UL><PRE>
Fl_Window *replace_dlg = new Fl_Window(300, 105, &quot;Replace&quot;); Fl_Window *replace_dlg = new Fl_Window(300, 105, &quot;Replace&quot;);
@ -618,8 +617,7 @@ or <TT>c++</TT> on your system.
The final editor window should look like the image in Figure 4-2. The final editor window should look like the image in Figure 4-2.
<P ALIGN="CENTER"><IMG src="editor.gif" ALT="The completed editor window."><BR> \image html editor.gif "Figure 4-2: The completed editor window"
<I>Figure 4-2: The completed editor window</I></P>
<H2>Advanced Features</H2> <H2>Advanced Features</H2>