mirrors
/
fltk
mirror of https://github.com/fltk/fltk
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

started changing html href calls to doxygen \ref commands 

in basics.dox, common.dox and drawing.dox, and other cleaning up



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6729 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
engelsman 2009-03-30 20:41:22 +00:00
parent 165eed565c
commit 12318a5d25
3 changed files with 153 additions and 140 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

109
documentation/src/basics.dox
View File

@ -41,7 +41,7 @@ Fl_Window *window = new Fl_Window(300,180);
\endcode
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.
adds the new box to \p window, the current grouping widget.
\code
Fl_Box *box = new Fl_Box(20,40,260,100,"Hello, World!");
@ -56,7 +56,7 @@ box->labelfont(FL_BOLD+FL_ITALIC);
box->labeltype(FL_SHADOW_LABEL);
\endcode
We tell FLTK that we will not add any more widgets to <tt>window</tt>.
We tell FLTK that we will not add any more widgets to \p window.
\code
window->end();
@ -71,32 +71,34 @@ return Fl::run();
The resulting program will display the window in Figure 2-1.
You can quit the program by closing the window or pressing the
<KBD>ESC</KBD>ape key.
<tt>ESC</tt>ape key.
\image html hello.C.gif "Figure 2-1: The Hello, World! Window"
\image latex hello.C.eps "The Hello, World! Window" width=8cm
\subsection basics_creating Creating the Widgets
The widgets are created using the C++ <tt>new</tt> operator. For
The widgets are created using the C++ \p new operator. For
most widgets the arguments to the constructor are:
\code
Fl_Widget(x, y, width, height, label)
\endcode
The <tt>x</tt> and <tt>y</tt> parameters determine where the
The \p x and \p y parameters determine where the
widget or window is placed on the screen. In FLTK the top left
corner of the window or screen is the origin (i.e. x = 0, y =
0) and the units are in pixels.
corner of the window or screen is the origin
(i.e. <tt>x = 0, y = 0</tt>)
and the units are in pixels.
The <tt>width</tt> and <tt>height</tt> parameters determine
The \p width and \p height parameters determine
the size of the widget or window in pixels. The maximum widget
size is typically governed by the underlying window system or
hardware.
<tt>label</tt> is a pointer to a character string to label
the widget with or <tt>NULL</tt>. If not specified the label
defaults to <tt>NULL</tt>. The label string must be in static
\p label is a pointer to a character string to label
the widget with or \p NULL. If not specified the label
defaults to \p NULL. The label string must be in static
storage such as a string constant because FLTK does not make a
copy of it - it just uses the pointer.
@ -105,28 +107,33 @@ copy of it - it just uses the pointer.
Widgets are commonly ordered into functional groups, which
in turn may be grouped again, creating a hierarchy of widgets.
FLTK makes it easy to fill groups by automatically adding all widgets
that are created between a <tt>myGroup->begin()</tt> and
<tt>myGroup->end()</tt>. In this example, <tt>myGroup</tt>
would be the <i>current</i> group.
that are created between a
<tt>myGroup->begin()</tt>
and
<tt>myGroup->end()</tt>.
In this example, \p myGroup would be the \e current group.
Newly created groups and their derived widgets implicitly call
<tt>begin()</tt> in the constructor, effectively adding all
subsequently created widgets to itself until <tt>end()</tt>
\p begin() in the constructor, effectively adding all
subsequently created widgets to itself until \p end()
is called.
Setting the current group to <tt>NULL</tt> will stop automatic
Setting the current group to \p NULL will stop automatic
hierarchies. New widgets can now be added manually using
<tt>Fl_Group::add(...)</tt> and <tt>Fl_Group::insert(...)</tt>.
<tt>Fl_Group::add(...)</tt>
and
<tt>Fl_Group::insert(...)</tt>.
\subsection basics_getset Get/Set Methods
<tt>box->box(FL_UP_BOX)</tt> sets the type of box the
Fl_Box draws, changing it from the default of
<tt>FL_NO_BOX</tt>, which means that no box is drawn. In our
"Hello, World!" example we use <tt>FL_UP_BOX</tt>,
<tt>box->box(FL_UP_BOX)</tt>
sets the type of box the Fl_Box draws, changing it from the default of
\p FL_NO_BOX, which means that no box is drawn. In our
"Hello, World!" example we use \p FL_UP_BOX,
which means that a raised button border will be drawn around
the widget. You can learn more about boxtypes in
<A href="common.html#boxtypes">Chapter 3</A>.
the widget. More details are available in the
\ref common_boxtypes
section.
You could examine the boxtype in by doing
<tt>box->box()</tt>. FLTK uses method name overloading to make
@ -138,11 +145,11 @@ of the form "type name() const".
Almost all of the set/get pairs are very fast, short inline
functions and thus very efficient. However, <i>the "set" methods
do not call <tt>redraw()</tt></i> - you have to call it
do not call \p redraw()</i> - you have to call it
yourself. This greatly reduces code size and execution time. The
only common exceptions are <tt>value()</tt> which calls
<tt>redraw()</tt> and <tt>label()</tt> which calls
<tt>redraw_label()</tt> if necessary.
only common exceptions are \p value() which calls
\p redraw() and \p label() which calls
\p redraw_label() if necessary.
\subsection basics_labels Labels
@ -151,24 +158,24 @@ the label is used for the label in the title bar. Our example
program calls the \p labelfont(), \p labelsize(),
and \p labeltype() methods.
The <tt>labelfont</tt> method sets the typeface and style
The \p labelfont() method sets the typeface and style
that is used for the label, which for this example we are using
<tt>FL_BOLD</tt> and <tt>FL_ITALIC</tt>. You can also specify
\p FL_BOLD and \p FL_ITALIC. You can also specify
typefaces directly.
The <tt>labelsize</tt> method sets the height of the font in pixels.
The \p labelsize() method sets the height of the font in pixels.
The <tt>labeltype</tt>
The \p labeltype()
method sets the type of label. FLTK supports normal, embossed,
and shadowed labels internally, and more types can be added as
desired.
A complete list of all label options can be found in
<A href="common.html#labels">Chapter 3</A>.
A complete list of all label options can be found in the section on
\ref common_labels.
\subsection basics_showing Showing the Window
The <tt>show()</tt> method shows the widget or window. For windows
The \p show() method shows the widget or window. For windows
you can also provide the command-line arguments to allow users to
customize the appearance, size, and position of your windows.
@ -217,14 +224,14 @@ under FLTK control are closed by the user or your program.
Under UNIX (and under Microsoft Windows when using the GNU development
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:
header files. This is usually done using the \p -I option:
\code
CC -I/usr/local/include ...
gcc -I/usr/local/include ...
\endcode
The <tt>fltk-config</tt> script included with FLTK can be
The \p fltk-config script included with FLTK can be
used to get the options that are required by your compiler:
\code
@ -248,7 +255,7 @@ classes, Fl_Help_Dialog widget, and system icon support.
The libraries are named "fltk.lib", "fltkgl.lib", "fltkforms.lib",
and "fltkimages.lib", respectively under Windows.
As before, the <tt>fltk-config</tt> script included with FLTK can be
As before, the \p fltk-config script included with FLTK can be
used to get the options that are required by your linker:
\code
@ -267,7 +274,7 @@ CC ... `fltk-config --use-images --ldflags`
CC ... `fltk-config --use-forms --use-gl --use-images --ldflags`
\endcode
Finally, you can use the <tt>fltk-config</tt> script to
Finally, you can use the \p fltk-config script to
compile a single source file as a FLTK program:
\code
@ -278,15 +285,15 @@ fltk-config --use-images --compile filename.cpp
fltk-config --use-forms --use-gl --use-images --compile filename.cpp
\endcode
Any of these will create an executable named <tt>filename</tt>.
Any of these will create an executable named \p filename.
\section basics_makefile Compiling Programs with Makefiles
The previous section described how to use <tt>fltk-config</tt> to
The previous section described how to use \p fltk-config to
build a program consisting of a single source file from the command
line, and this is very convenient for small test programs.
But <tt>fltk-config</tt> can also be used to set the compiler and
linker options as variables within a <tt>Makefile</tt> that can be
But \p fltk-config can also be used to set the compiler and
linker options as variables within a \p Makefile that can be
used to build programs out of multiple source files:
\code
@ -329,9 +336,9 @@ Controls (COMCTRL32.LIB), and WinSock2 (WS2_32.LIB) libraries to
the "Link" settings.
You can build your Microsoft Windows applications as Console or
WIN32 applications. If you want to use the standard C <tt>main()</tt>
function as the entry point, FLTK includes a <tt>WinMain()</tt>
function that will call your <tt>main()</tt> function for you.
WIN32 applications. If you want to use the standard C \p main()
function as the entry point, FLTK includes a \p WinMain()
function that will call your \p main() function for you.
<I>Note: The Visual C++ 5.0 optimizer is known to cause problems with
many programs. We only recommend using the "Favor Small Code"
@ -342,12 +349,12 @@ better and can be used with the "optimized for speed" setting.
All public symbols in FLTK start with the characters 'F' and 'L':
\li Functions are either <tt>Fl::foo()</tt> or <tt>fl_foo()</tt>.
\li Functions are either \p Fl::foo() or \p fl_foo().
\li Class and type names are capitalized: <tt>Fl_Foo</tt>.
\li Class and type names are capitalized: \p Fl_Foo.
\li <A href="enumerations.html">Constants and enumerations</A>
are uppercase: <tt>FL_FOO</tt>.
\li \ref enumerations "Constants and enumerations"
are uppercase: \p FL_FOO.
\li All header files start with <tt><FL/...></tt>.
@ -362,7 +369,7 @@ The proper way to include FLTK header files is:
\endcode
\note
Case <I>is</I> significant on many operating systems,
Case \e is significant on many operating systems,
and the C standard uses the forward slash (/) to
separate directories. <i>Do not use any of the following
include lines:</i>

183
documentation/src/common.dox
View File

@ -19,7 +19,7 @@ FLTK provides many types of buttons:
\li Fl_Repeat_Button - A push button that repeats when held.
\li Fl_Return_Button - A push button that is activated by the
\c Enter key.
\p Enter key.
\li Fl_Round_Button - A button with a radio circle.
@ -37,7 +37,7 @@ Fl_Light_Button *lbutton = new Fl_Light_Button(x, y, width, height);
Fl_Round_Button *rbutton = new Fl_Round_Button(x, y, width, height, "label");
\endcode
Each button has an associated \c type() which allows
Each button has an associated \p type() which allows
it to behave as a push button, toggle button, or radio button:
\code
@ -46,11 +46,11 @@ lbutton->type(FL_TOGGLE_BUTTON);
rbutton->type(FL_RADIO_BUTTON);
\endcode
For toggle and radio buttons, the \c value() method returns
the current button state (0 = off, 1 = on). The \c set() and
\c clear() methods can be used on toggle buttons to turn a
For toggle and radio buttons, the \p value() method returns
the current button state (0 = off, 1 = on). The \p set() and
\p clear() methods can be used on toggle buttons to turn a
toggle button on or off, respectively.
Radio buttons can be turned on with the \c setonly()
Radio buttons can be turned on with the \p setonly()
method; this will also turn off other radio buttons in the same
group.
@ -76,7 +76,7 @@ The Fl_Output and Fl_Multiline_Output
widgets allow the user to copy text from the output field but
not change it.
The \c value() method is used to get or set the
The \p value() method is used to get or set the
string that is displayed:
\code
@ -85,7 +85,7 @@ input->value("Now is the time for all good men...");
\endcode
The string is copied to the widget's own storage when you set
the \c value() of the widget.
the \p value() of the widget.
The Fl_Text_Display and Fl_Text_Editor
widgets use an associated Fl_Text_Buffer class for the
@ -113,8 +113,8 @@ strings. FLTK provides the following valuators:
\image html valuators.gif "Figure 3-2: FLTK valuator widgets"
\image latex valuators.eps "FLTK valuator widgets" width=10cm
The \c value() method gets and sets the current value
of the widget. The \c minimum() and \c maximum()
The \p value() method gets and sets the current value
of the widget. The \p minimum() and \p maximum()
methods set the range of values that are reported by the
widget.
@ -150,11 +150,11 @@ with FLTK:
\section common_sizeposition Setting the Size and Position of Widgets
The size and position of widgets is usually set when you create them.
You can access them with the \c x(), \c y(), \c w(), and \c h()
You can access them with the \p x(), \p y(), \p w(), and \p h()
methods.
You can change the size and position by using the \c position(),
\c resize(), and \c size() methods:
You can change the size and position by using the \p position(),
\p resize(), and \p size() methods:
\code
button->position(x, y);
@ -163,7 +163,7 @@ window->size(width, height);
\endcode
If you change a widget's size or position after it is
displayed you will have to call \c redraw() on the
displayed you will have to call \p redraw() on the
widget's parent.
<A NAME="colors"></A> <!-- For old HTML links only ! -->
@ -177,38 +177,39 @@ fixed contents.
There are symbols for naming some of the more common colors:
\li \c FL_BLACK
\li \c FL_RED
\li \c FL_GREEN
\li \c FL_YELLOW
\li \c FL_BLUE
\li \c FL_MAGENTA
\li \c FL_CYAN
\li \c FL_WHITE
\li \c FL_WHITE
\li \p FL_BLACK
\li \p FL_RED
\li \p FL_GREEN
\li \p FL_YELLOW
\li \p FL_BLUE
\li \p FL_MAGENTA
\li \p FL_CYAN
\li \p FL_WHITE
\li \p FL_WHITE
These symbols are the default colors for all FLTK widgets. They are
explained in more detail in the chapter
<A HREF="enumerations.html#colors">Enumerations</A>
explained in more detail under
\ref enumerations_colors in
\ref enumerations.
\li \c FL_FOREGROUND_COLOR
\li \c FL_BACKGROUND_COLOR
\li \c FL_INACTIVE_COLOR
\li \c FL_SELECTION_COLOR
\li \p FL_FOREGROUND_COLOR
\li \p FL_BACKGROUND_COLOR
\li \p FL_INACTIVE_COLOR
\li \p FL_SELECTION_COLOR
RGB colors can be set using the \c fl_rgb_color() function:
RGB colors can be set using the \p fl_rgb_color() function:
\code
Fl_Color c = fl_rgb_color(85, 170, 255);
\endcode
The widget color is set using the \c color() method:
The widget color is set using the \p color() method:
\code
button->color(FL_RED);
\endcode
Similarly, the label color is set using the \c labelcolor() method:
Similarly, the label color is set using the \p labelcolor() method:
\code
button->labelcolor(FL_WHITE);
@ -225,12 +226,12 @@ Figure 3-3 shows the standard box types included with FLTK.
\image html boxtypes.gif "Figure 3-3: FLTK box types"
\image latex boxtypes.eps "FLTK box types" width=12cm
\c FL_NO_BOX means nothing is drawn at all, so whatever is
\p FL_NO_BOX means nothing is drawn at all, so whatever is
already on the screen remains. The <tt>FL_..._FRAME</tt> types only
draw their edges, leaving the interior unchanged. The blue color in
Figure 3-3 is the area that is not drawn by the frame types.
\subsection common_boxtypes Making Your Own Boxtypes
\subsection common_custom_boxtypes Making Your Own Boxtypes
You can define your own boxtypes by making a small function that draws
the box and adding it to the table of boxtypes.
@ -272,28 +273,31 @@ void xyz_draw(int x, int y, int w, int h, Fl_Color c) {
\anchor common_fl_down
Fl_Boxtype fl_down(Fl_Boxtype b)
\par
fl_down() returns the "pressed" or "down" version of a box.
If no "down" version of a given box exists, the behavior of this function
is undefined and some random box or frame is returned.
See also: <A HREF="drawing.html#fl_frame">fl_frame drawing</A>.
See \ref drawing_fl_frame "Drawing Functions" for more details.
<A name="fl_frame"></A> <!-- For old HTML links only ! -->
\anchor common_fl_frame
Fl_Boxtype fl_frame(Fl_Boxtype b)
\par
fl_frame() returns the unfilled, frame-only version of a box.
If no frame version of a given box exists, the behavior of this function
is undefined and some random box or frame is returned.
See also: <A HREF="drawing.html#fl_frame">fl_frame drawing</A>.
See \ref drawing_fl_frame "Drawing Functions" for more details.
<A name="fl_box"></A> <!-- For old HTML links only ! -->
\anchor common_fl_box
Fl_Boxtype fl_box(Fl_Boxtype b)
\par
fl_box() returns the filled version of a frame.
If no filled version of a given frame exists, the behavior of this function
is undefined and some random box or frame is returned.
See also: <tt><A HREF="#fl_frame">fl_frame</A></tt>.
See \ref drawing_fl_frame "Drawing Functions" for more details.
\par Adding Your Box Type
@ -305,7 +309,7 @@ The Fl::set_boxtype() method adds or replaces the specified box type:
Fl::set_boxtype(XYZ_BOX, xyz_draw, 1, 1, 2, 2);
\endcode
The last 4 arguments to Fl::set_boxtype() are the
offsets for the x, y, width, and height values that should be
offsets for the \p x, \p y, \p width, and \p height values that should be
subtracted when drawing the label inside the box.
A complete box design contains four box types in this order:
@ -313,29 +317,28 @@ a filled, neutral box (<tt>UP_BOX</tt>),
a filled, depressed box (<tt>DOWN_BOX</tt>),
and the same as outlines only (<tt>UP_FRAME</tt> and <tt>DOWN_FRAME</tt>).
The function
<tt><A HREF="#fl_down">fl_down(Fl_Boxtype)</A></tt>
\ref common_fl_down "fl_down(Fl_Boxtype)"
expects the neutral design on a boxtype with a numerical
value evenly divideable by two.
<tt><A HREF="#fl_frame">fl_frame(Fl_Boxtype)</A></tt>
expects the <tt>UP_BOX</tt> design at a value divideable by four.
\ref common_fl_frame "fl_frame(Fl_Boxtype)"
expects the \p UP_BOX design at a value divideable by four.
<A NAME="labels"></A> <!-- For old HTML links only ! -->
\section common_labels Labels and Label Types
\todo correct signatures for label() and friends to produce links in common.dox
The \c label(), \c align(), \c labelfont(), \c labelsize(),
\c labeltype(), \c image(), and \c deimage() methods control the
The \p label(), \p align(), \p labelfont(), \p labelsize(),
\p labeltype(), \p image(), and \p deimage() methods control the
labeling of widgets.
\par label()
The \c label() method sets the string that is displayed
The \p label() method sets the string that is displayed
for the label. Symbols can be included with the label string by
escaping them using the "@" symbol - "@@" displays a single at
sign. Figure 3-4 shows the available symbols.
\image html symbols.gif "Figure 3-4: FLTK label symbols"
\image latex symbols.eps "FLTK label symbols" width=10cm
<!-- NEED 2in -->
@ -358,42 +361,44 @@ label string "@+92->".
\par align()
The \c align() method positions the label. The following
The \p align() method positions the label. The following
constants are defined and may be OR'd together as needed:
\li \c FL_ALIGN_CENTER - center the label in the widget.
\li \c FL_ALIGN_TOP - align the label at the top of the widget.
\li \c FL_ALIGN_BOTTOM - align the label at the bottom of the widget.
\li \c FL_ALIGN_LEFT - align the label to the left of the widget.
\li \c FL_ALIGN_RIGHT - align the label to the right of the widget.
\li \c FL_ALIGN_INSIDE - align the label inside the widget.
\li \c FL_ALIGN_CLIP - clip the label to the widget's bounding box.
\li \c FL_ALIGN_WRAP - wrap the label text as needed.
\li \c FL_TEXT_OVER_IMAGE - show the label text over the image.
\li \c FL_IMAGE_OVER_TEXT - show the label image over the text (default).
\li \p FL_ALIGN_CENTER - center the label in the widget.
\li \p FL_ALIGN_TOP - align the label at the top of the widget.
\li \p FL_ALIGN_BOTTOM - align the label at the bottom of the widget.
\li \p FL_ALIGN_LEFT - align the label to the left of the widget.
\li \p FL_ALIGN_RIGHT - align the label to the right of the widget.
\li \p FL_ALIGN_INSIDE - align the label inside the widget.
\li \p FL_ALIGN_CLIP - clip the label to the widget's bounding box.
\li \p FL_ALIGN_WRAP - wrap the label text as needed.
\li \p FL_TEXT_OVER_IMAGE - show the label text over the image.
\li \p FL_IMAGE_OVER_TEXT - show the label image over the text (default).
<A NAME="labeltypes"></A> <!-- For old HTML links only ! -->
\anchor common_labeltype
\par labeltype()
The \c labeltype() method sets the type of the label. The
The \p labeltype() method sets the type of the label. The
following standard label types are included:
\li \c FL_NORMAL_LABEL - draws the text.
\li \c FL_NO_LABEL - does nothing.
\li \c FL_SHADOW_LABEL - draws a drop shadow under the text.
\li \c FL_ENGRAVED_LABEL - draws edges as though the text is engraved.
\li \c FL_EMBOSSED_LABEL - draws edges as thought the text is raised.
\li \c FL_ICON_LABEL - draws the icon associated with the text.
\li \p FL_NORMAL_LABEL - draws the text.
\li \p FL_NO_LABEL - does nothing.
\li \p FL_SHADOW_LABEL - draws a drop shadow under the text.
\li \p FL_ENGRAVED_LABEL - draws edges as though the text is engraved.
\li \p FL_EMBOSSED_LABEL - draws edges as thought the text is raised.
\li \p FL_ICON_LABEL - draws the icon associated with the text.
\anchor common_image_deimage
\par image() and deimage()
The \c image() and \c deimage() methods set an image that
will be displayed with the widget. The \c deimage() method sets the
image that is shown when the widget is inactive, while the \c image()
The \p image() and \p deimage() methods set an image that
will be displayed with the widget. The \p deimage() method sets the
image that is shown when the widget is inactive, while the \p image()
method sets the image that is shown when the widget is active.
To make an image you use a subclass of
<A HREF="drawing.html#Fl_Image"><tt>Fl_Image</tt></A>.
\ref ssect_Fl_Image "Fl_Image".
\par Making Your Own Label Types
@ -426,8 +431,8 @@ void xyz_draw(const Fl_Label *label, int x, int y, int w, int h, Fl_Align align)
\endcode
The label should be drawn \e inside this bounding box,
even if \c FL_ALIGN_INSIDE is not enabled. The function
is not called if the label value is \c NULL.
even if \p FL_ALIGN_INSIDE is not enabled. The function
is not called if the label value is \p NULL.
The measure function is called with a pointer to a
Fl_Label structure and references to the width and
@ -440,11 +445,11 @@ void xyz_measure(const Fl_Label *label, int &w, int &h) {
\endcode
The function should measure the size of the label and set
\c w and \c h to the size it will occupy.
\p w and \p h to the size it will occupy.
\par Adding Your Label Type
The Fl::set_labeltype method creates a label type
The Fl::set_labeltype() method creates a label type
using your draw and measure functions:
\code
@ -453,13 +458,13 @@ using your draw and measure functions:
Fl::set_labeltype(XYZ_LABEL, xyz_draw, xyz_measure);
\endcode
The label type number \c n can be any integer value
starting at the constant \c FL_FREE_LABELTYPE. Once you
have added the label type you can use the \c labeltype()
The label type number \p n can be any integer value
starting at the constant \p FL_FREE_LABELTYPE. Once you
have added the label type you can use the \p labeltype()
method to select your label type.
The Fl::set_labeltype method can also be used to overload
an existing label type such as \c FL_NORMAL_LABEL.
The Fl::set_labeltype() method can also be used to overload
an existing label type such as \p FL_NORMAL_LABEL.
<A NAME="add_symbol"></A> <!-- For old HTML links only ! -->
\par Making your own symbols
@ -470,7 +475,7 @@ any label.
To create a new symbol, you implement a drawing function
<tt>void drawit(Fl_Color c)</tt> which typically uses the
<a href="drawing.html#complex">complex drawing functions</a>
functions described in \ref ssect_Complex
to generate a vector shape inside a two-by-two units sized box
around the origin. This function is then linked into the symbols
table using fl_add_symbol():
@ -479,7 +484,7 @@ table using fl_add_symbol():
int fl_add_symbol(const char *name, void (*drawit)(Fl_Color), int scalable)
\endcode
\c name is the name of the symbol without the "@"; \c scalable
\p name is the name of the symbol without the "@"; \p scalable
must be set to 1 if the symbol is generated using scalable vector drawing
functions.
@ -502,7 +507,7 @@ void xyz_callback(Fl_Widget *w, void *data) {
}
\endcode
The \c callback() method sets the callback function for a
The \p callback() method sets the callback function for a
widget. You can optionally pass a pointer to some data needed for the
callback:
@ -530,25 +535,25 @@ button->when(FL_WHEN_CHANGED | FL_WHEN_NOT_CHANGED);
<TR>
<TD><B>Note:</B>
<P>You cannot delete a widget inside a callback, as the
You cannot delete a widget inside a callback, as the
widget may still be accessed by FLTK after your callback
is completed. Instead, use the Fl::delete_widget()
method to mark your widget for deletion when it is safe
to do so.
<p><B>Hint:</B>
<B>Hint:</B>
<P>Many programmers new to FLTK or C++ try to use a
Many programmers new to FLTK or C++ try to use a
non-static class method instead of a static class method
or function for their callback. Since callbacks are done
outside a C++ class, the <tt>this</tt> pointer is not
initialized for class methods.
<P>To work around this problem, define a static method
To work around this problem, define a static method
in your class that accepts a pointer to the class, and
then have the static method call the class method(s) as
needed. The data pointer you provide to the
\c callback() method of the widget can be a
\p callback() method of the widget can be a
pointer to the instance of your class.
\code
@ -569,7 +574,7 @@ w->callback(my_static_callback, (void *)this);
\section common_shortcuts Shortcuts
Shortcuts are key sequences that activate widgets such as
buttons or menu items. The \c shortcut() method sets the
buttons or menu items. The \p shortcut() method sets the
shortcut for a widget:
\code
@ -582,9 +587,9 @@ button->shortcut(0); // no shortcut
\endcode
The shortcut value is the key event value - the ASCII value
or one of the special keys like
<a href="enumerations.html#key_values"><tt>FL_Enter</tt></a> -
combined with any modifiers like \c Shift , \c Alt , and \c Control .
or one of the special keys described in
\ref enumerations_event_key
combined with any modifiers like \p Shift , \p Alt , and \p Control.
\htmlonly

1
documentation/src/drawing.dox
View File

@ -60,6 +60,7 @@ The first box drawing function is fl_draw_box()
which draws a standard boxtype \p b in the specified color \p c .
<A NAME="fl_frame"></A> <!-- For old HTML links only ! -->
\anchor drawing_fl_frame
void fl_frame(const char *s, int x, int y, int w, int h)
\par