From 7f105bfa47e0f8a24f019f87c76bae387fbe0c1b Mon Sep 17 00:00:00 2001 From: engelsman Date: Fri, 10 Oct 2008 17:10:28 +0000 Subject: converted more html to plain old doxygen in basics.dox and common.dox git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6404 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/basics.dox | 249 ++++++++++++------------ documentation/common.dox | 498 ++++++++++++++++++++++------------------------- 2 files changed, 355 insertions(+), 392 deletions(-) diff --git a/documentation/basics.dox b/documentation/basics.dox index 3fb1366f7..d9bfc4aad 100644 --- a/documentation/basics.dox +++ b/documentation/basics.dox @@ -2,17 +2,17 @@ \page basics 2 - FLTK Basics -

This chapter teaches you the basics of compiling programs -that use FLTK.

+This chapter teaches you the basics of compiling programs +that use FLTK. -

Writing Your First FLTK Program

+\section basics_writing Writing Your First FLTK Program -

All programs must include the file . +All programs must include the file . In addition the program must include a header file for each FLTK class it uses. Listing 1 shows a simple "Hello, -World!" program that uses FLTK to display the window.

+World!" program that uses FLTK to display the window. -

Listing 1 - "hello.cxx" +\par Listing 1 - "hello.cxx" \code #include #include @@ -33,21 +33,21 @@ int main(int argc, char **argv) { -

After including the required header files, the program then creates a -window. All following widgets will automatically be children of this window.

+After including the required header files, the program then creates a +window. All following widgets will automatically be children of this window. \code 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 window, the current grouping widget.

+Then we create a box with the "Hello, World!" string in it. FLTK automatically +adds the new box to window, the current grouping widget. \code Fl_Box *box = new Fl_Box(20,40,260,100,"Hello, World!"); \endcode -

Next, we set the type of box and the size, font, and style of the label:

+Next, we set the type of box and the size, font, and style of the label: \code box->box(FL_UP_BOX); @@ -56,205 +56,209 @@ box->labelfont(FL_BOLD+FL_ITALIC); box->labeltype(FL_SHADOW_LABEL); \endcode -

We tell FLTK that we will not add any more widgets to window.

+We tell FLTK that we will not add any more widgets to window. \code window->end(); \endcode -

Finally, we show the window and enter the FLTK event loop:

+Finally, we show the window and enter the FLTK event loop: \code window->show(argc, argv); return Fl::run(); \endcode -

The resulting program will display the window in Figure 2-1. +The resulting program will display the window in Figure 2-1. You can quit the program by closing the window or pressing the -ESCape key.

+ESCape key. \image html hello.C.gif "Figure 2-1: The Hello, World! Window" -

Creating the Widgets

+\subsection basics_creating Creating the Widgets -

The widgets are created using the C++ new operator. For -most widgets the arguments to the constructor are:

+The widgets are created using the C++ new operator. For +most widgets the arguments to the constructor are: \code Fl_Widget(x, y, width, height, label) \endcode -

The x and y parameters determine where the +The x and 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.

+0) and the units are in pixels. -

The width and height parameters determine +The width and 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.

+hardware. -

label is a pointer to a character string to label +label is a pointer to a character string to label the widget with or NULL. If not specified the label defaults to 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.

+copy of it - it just uses the pointer. -

Creating Widget hierarchies

+\subsection basics_hierarchies Creating Widget hierarchies -

Widgets are commonly ordered into functional groups, which +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 myGroup->begin() and myGroup->end(). In this example, myGroup -would be the current group.

+would be the current group. -

Newly created groups and their derived widgets implicitly call +Newly created groups and their derived widgets implicitly call begin() in the constructor, effectively adding all subsequently created widgets to itself until end() -is called.

+is called. -

Setting the current group to NULL will stop automatic +Setting the current group to NULL will stop automatic hierarchies. New widgets can now be added manually using -Fl_Group::add(...) and Fl_Group::insert(...).

+Fl_Group::add(...) and Fl_Group::insert(...). -

Get/Set Methods

+\subsection basics_getset Get/Set Methods -

box->box(FL_UP_BOX) sets the type of box the +box->box(FL_UP_BOX) sets the type of box the Fl_Box draws, changing it from the default of FL_NO_BOX, which means that no box is drawn. In our -"Hello, World!" example we use FL_UP_BOX, +"Hello, World!" example we use FL_UP_BOX, which means that a raised button border will be drawn around the widget. You can learn more about boxtypes in -Chapter 3.

+Chapter 3. -

You could examine the boxtype in by doing +You could examine the boxtype in by doing box->box(). FLTK uses method name overloading to make short names for get/set methods. A "set" method is always of the form "void name(type)", and a "get" method is always -of the form "type name() const".

+of the form "type name() const". -

Redrawing After Changing Attributes

+\subsection basics_redrawing Redrawing After Changing Attributes -

Almost all of the set/get pairs are very fast, short inline +Almost all of the set/get pairs are very fast, short inline functions and thus very efficient. However, the "set" methods -do not call redraw() - you have to call it +do not call redraw() - you have to call it yourself. This greatly reduces code size and execution time. The only common exceptions are value() which calls -redraw() and label() which calls -redraw_label() if necessary.

+redraw() and label() which calls +redraw_label() if necessary. -

Labels

+\subsection basics_labels Labels -

All widgets support labels. In the case of window widgets, +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 labelfont(), labelsize, -and labeltype() methods.

+program calls the labelfont(), labelsize, +and labeltype() methods. -

All widgets support labels. In the case of window widgets, +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 -labelfont, - labelsize, -and labeltype -methods.

- -

The labelfont method sets the typeface and style +program calls the +labelfont, + labelsize, +and +labeltype +methods. + +The labelfont method sets the typeface and style that is used for the label, which for this example we are using -FL_BOLD and FL_ITALIC. You can also specify -typefaces directly.

The labelsize method sets -the height of the font in pixels.

The labeltype +FL_BOLD and FL_ITALIC. You can also specify +typefaces directly. + +The labelsize method sets the height of the font in pixels. + +The labeltype method sets the type of label. FLTK supports normal, embossed, and shadowed labels internally, and more types can be added as -desired.

+desired. -

A complete list of all label options can be found in -Chapter 3.

+A complete list of all label options can be found in +Chapter 3. -

Showing the Window

+\subsection basics_showing Showing the Window -

The show() method shows the widget or window. For windows +The 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.

+customize the appearance, size, and position of your windows. -

The Main Event Loop

+\subsection basics_eventloop The Main Event Loop -

All FLTK applications (and most GUI applications in general) +All FLTK applications (and most GUI applications in general) are based on a simple event processing model. User actions such as mouse movement, button clicks, and keyboard activity generate events that are sent to an application. The application may then ignore the events or respond to the user, typically by redrawing a button in the "down" position, adding the text to an input -field, and so forth.

+field, and so forth. -

FLTK also supports idle, timer, and file pseudo-events that +FLTK also supports idle, timer, and file pseudo-events that cause a function to be called when they occur. Idle functions are called when no user input is present and no timers or files need to be handled - in short, when the application is not doing anything. Idle callbacks are often used to update a 3D display -or do other background processing.

+or do other background processing. -

Timer functions are called after a specific amount of time +Timer functions are called after a specific amount of time has expired. They can be used to pop up a progress dialog after a certain amount of time or do other things that need to happen at more-or-less regular intervals. FLTK timers are not 100% accurate, so they should not be used to measure time intervals, -for example.

+for example. -

File functions are called when data is ready to read or +File functions are called when data is ready to read or write, or when an error condition occurs on a file. They are most often used to monitor network connections (sockets) for -data-driven displays.

+data-driven displays. -

FLTK applications must periodically check (Fl::check()) +FLTK applications must periodically check (Fl::check()) or wait (Fl::wait()) for events or use the Fl::run() method to enter a standard event processing loop. Calling -Fl::run() is equivalent to the following code:

+Fl::run() is equivalent to the following code: \code while (Fl::wait()); \endcode -

Fl::run() does not return until all of the windows -under FLTK control are closed by the user or your program.

+Fl::run() does not return until all of the windows +under FLTK control are closed by the user or your program. -

Compiling Programs with Standard Compilers

+\section basics_standard_compiler Compiling Programs with Standard Compilers -

Under UNIX (and under Microsoft Windows when using the GNU development +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 -I option:

+header files. This is usually done using the -I option: \code CC -I/usr/local/include ... gcc -I/usr/local/include ... \endcode -

The fltk-config script included with FLTK can be -used to get the options that are required by your compiler:

+The fltk-config script included with FLTK can be +used to get the options that are required by your compiler: \code CC `fltk-config --cxxflags` ... \endcode -

Similarly, when linking your application you will need to tell the -compiler to use the FLTK library:

+Similarly, when linking your application you will need to tell the +compiler to use the FLTK library: \code CC ... -L/usr/local/lib -lfltk -lXext -lX11 -lm gcc ... -L/usr/local/lib -lfltk -lXext -lX11 -lm \endcode -

Aside from the "fltk" library, there is also a "fltk_forms" +Aside from the "fltk" library, there is also a "fltk_forms" library for the XForms compatibility classes, "fltk_gl" for the OpenGL and GLUT classes, and "fltk_images" for the image file classes, Fl_Help_Dialog widget, and system icon support. \note - The libraries are named "fltk.lib", "fltkgl.lib", "fltkforms.lib", - and "fltkimages.lib", respectively under Windows. +The libraries are named "fltk.lib", "fltkgl.lib", "fltkforms.lib", +and "fltkimages.lib", respectively under Windows. -

As before, the fltk-config script included with FLTK can be -used to get the options that are required by your linker:

+As before, the fltk-config script included with FLTK can be +used to get the options that are required by your linker: \code CC ... `fltk-config --ldflags` @@ -262,7 +266,7 @@ CC ... `fltk-config --ldflags` -

The forms, GL, and images libraries are included with the "--use-foo" +The forms, GL, and images libraries are included with the "--use-foo" options, as follows: \code @@ -272,7 +276,7 @@ CC ... `fltk-config --use-images --ldflags` CC ... `fltk-config --use-forms --use-gl --use-images --ldflags` \endcode -

Finally, you can use the fltk-config script to +Finally, you can use the fltk-config script to compile a single source file as a FLTK program: \code @@ -283,68 +287,61 @@ 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 filename. +Any of these will create an executable named filename. -

Compiling Programs with Microsoft Visual C++

+\section basics_visual_cpp Compiling Programs with Microsoft Visual C++ -

In Visual C++ you will need to tell the compiler where to +In Visual C++ you will need to tell the compiler where to find the FLTK header files. This can be done by selecting "Settings" from the "Project" menu and then changing the "Preprocessor" settings under the "C/C++" tab. You will also need to add the FLTK and WinSock2 (WS2_32.LIB) libraries to -the "Link" settings.

+the "Link" settings. -

You can build your Microsoft Windows applications as Console or -WIN32 applications. If you want to use the standard C main() -function as the entry point, FLTK includes a WinMain() -function that will call your main() function for you.

+You can build your Microsoft Windows applications as Console or +WIN32 applications. If you want to use the standard C main() +function as the entry point, FLTK includes a WinMain() +function that will call your main() function for you. -

Note: The Visual C++ 5.0 optimizer is known to cause problems with +Note: The Visual C++ 5.0 optimizer is known to cause problems with many programs. We only recommend using the "Favor Small Code" optimization setting. The Visual C++ 6.0 optimizer seems to be much -better and can be used with the "optimized for speed" setting.

- -

Naming

+better and can be used with the "optimized for speed" setting. -

All public symbols in FLTK start with the characters 'F' and 'L':

+\section basics_naming Naming - +\li All header files start with . -

Header Files

+\section basics_headerfiles Header Files -

The proper way to include FLTK header files is:

+The proper way to include FLTK header files is: \code #include \endcode \note - Case is significant on many operating systems, - and the C standard uses the forward slash (/) to - separate directories. Do not use any of the following - include lines: - - \code - #include - #include - #include - \endcode +Case is significant on many operating systems, +and the C standard uses the forward slash (/) to +separate directories. Do not use any of the following +include lines: + +\code +#include +#include +#include +\endcode
[Index]    diff --git a/documentation/common.dox b/documentation/common.dox index 62dbebe73..eeceae4cf 100644 --- a/documentation/common.dox +++ b/documentation/common.dox @@ -2,37 +2,33 @@ \page common 3 - Common Widgets and Attributes -

This chapter describes many of the widgets that are provided +This chapter describes many of the widgets that are provided with FLTK and covers how to query and set the standard -attributes.

+attributes. -

Buttons

+\section common_buttons Buttons -

FLTK provides many types of buttons:

+FLTK provides many types of buttons: -
    -
  • Fl_Button - A standard push button.
    • +\li Fl_Button - A standard push button. -
  • Fl_Check_Button - A button with a check box.
    • +\li Fl_Check_Button - A button with a check box. -
  • Fl_Light_Button - A push button with a light.
    • +\li Fl_Light_Button - A push button with a light. -
  • Fl_Repeat_Button - A push button that repeats - when held.
    • +\li Fl_Repeat_Button - A push button that repeats when held. -
  • Fl_Return_Button - A push button that is activated - by the Enter key.
    • +\li Fl_Return_Button - A push button that is activated by the + Enter key. -
  • Fl_Round_Button - A button with a radio circle.
    • - -
+\li Fl_Round_Button - A button with a radio circle. \image html buttons.gif "Figure 3-1: FLTK Button Widgets" -

All of these buttons just need the corresponding - header file. The constructor +All of these buttons just need the corresponding + header file. The constructor takes the bounding box of the button and optionally a label -string:

+string: \code Fl_Button *button = new Fl_Button(x, y, width, height, "label"); @@ -40,8 +36,8 @@ 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 type() which allows -it to behave as a push button, toggle button, or radio button:

+Each button has an associated type() which allows +it to behave as a push button, toggle button, or radio button: \code button->type(FL_NORMAL_BUTTON); @@ -49,126 +45,115 @@ lbutton->type(FL_TOGGLE_BUTTON); rbutton->type(FL_RADIO_BUTTON); \endcode -

For toggle and radio buttons, the value() method returns +For toggle and radio buttons, the value() method returns the current button state (0 = off, 1 = on). The set() and 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 setonly() method; this will also turn off other radio buttons in the same -group.

+group. -

Text

+\section common_text Text -

FLTK provides several text widgets for displaying and receiving text:

+FLTK provides several text widgets for displaying and receiving text: -
    -
  • Fl_Input - A one-line text input field.
    • +\li Fl_Input - A one-line text input field. -
  • Fl_Output - A one-line text output field.
    • +\li Fl_Output - A one-line text output field. -
  • Fl_Multiline_Input - A multi-line text input field.
    • +\li Fl_Multiline_Input - A multi-line text input field. -
  • Fl_Multiline_Output - A multi-line text output field.
    • +\li Fl_Multiline_Output - A multi-line text output field. -
  • Fl_Text_Display - A multi-line text display widget.
    • +\li Fl_Text_Display - A multi-line text display widget. -
  • Fl_Text_Editor - A multi-line text editing widget.
    • +\li Fl_Text_Editor - A multi-line text editing widget. -
  • Fl_Help_View - A HTML text display widget.
    • -
+\li Fl_Help_View - A HTML text display widget. -

The Fl_Output and Fl_Multiline_Output +The Fl_Output and Fl_Multiline_Output widgets allow the user to copy text from the output field but -not change it.

+not change it. -

The value() method is used to get or set the -string that is displayed:

+The value() method is used to get or set the +string that is displayed: \code Fl_Input *input = new Fl_Input(x, y, width, height, "label"); 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 value() of the widget.

+The string is copied to the widget's own storage when you set +the value() of the widget. -

The Fl_Text_Display and Fl_Text_Editor -widgets use an associated Fl_Text_Buffer class for the -value, instead of a simple string.

+The Fl_Text_Display and Fl_Text_Editor +widgets use an associated Fl_Text_Buffer class for the +value, instead of a simple string. -

Valuators

- -

Unlike text widgets, valuators keep track of numbers instead of -strings. FLTK provides the following valuators:

- -
    +\section common_valuators Valuators -
  • Fl_Counter - A widget with arrow buttons that shows the - current value.
    • +Unlike text widgets, valuators keep track of numbers instead of +strings. FLTK provides the following valuators: -
  • Fl_Dial - A round knob.
    • +\li Fl_Counter - A widget with arrow buttons that shows the current value. -
  • Fl_Roller - An SGI-like dolly widget.
    • +\li Fl_Dial - A round knob. -
  • Fl_Scrollbar - A standard scrollbar widget.
    • +\li Fl_Roller - An SGI-like dolly widget. -
  • Fl_Slider - A scrollbar with a knob.
    • +\li Fl_Scrollbar - A standard scrollbar widget. -
  • Fl_Value_Slider - A slider that shows the current value.
    • +\li Fl_Slider - A scrollbar with a knob. -
+\li Fl_Value_Slider - A slider that shows the current value. \image html valuators.gif "Figure 3-2: FLTK valuator widgets" -

The value() method gets and sets the current value -of the widget. The minimum() and maximum() +The value() method gets and sets the current value +of the widget. The minimum() and maximum() methods set the range of values that are reported by the -widget.

+widget. -

Groups

+\section common_groups Groups -

The Fl_Group widget class is used as a general +The Fl_Group widget class is used as a general purpose "container" widget. Besides grouping radio buttons, the groups are used to encapsulate windows, tabs, and scrolled windows. The following group classes are available -with FLTK:

+with FLTK: -
    +\li Fl_Double_Window - A double-buffered window on the screen. -
  • Fl_Double_Window - A double-buffered window on the screen.
    • +\li Fl_Gl_Window - An OpenGL window on the screen. -
  • Fl_Gl_Window - An OpenGL window on the screen.
    • +\li Fl_Group - The base container class; can be used to group + any widgets together. -
  • Fl_Group - The base container class; can be used to group - any widgets together.
    • +\li Fl_Pack - A collection of widgets that are packed into the group area. -
  • Fl_Pack - A collection of widgets that are packed into the group area.
    • +\li Fl_Scroll - A scrolled window area. -
  • Fl_Scroll - A scrolled window area.
    • +\li Fl_Tabs - Displays child widgets as tabs. -
  • Fl_Tabs - Displays child widgets as tabs.
    • +\li Fl_Tile - A tiled window area. -
  • Fl_Tile - A tiled window area.
    • +\li Fl_Window - A window on the screen. -
  • Fl_Window - A window on the screen.
    • +\li Fl_Wizard - Displays one group of widgets at a time. -
  • Fl_Wizard - Displays one group of widgets at a time.
    • +\section common_sizeposition Setting the Size and Position of Widgets -
- -

Setting the Size and Position of Widgets

- -

The size and position of widgets is usually set when you +The size and position of widgets is usually set when you create them. You can access them with the x(), -y(), w(), and h() methods.

+y(), w(), and h() methods. -

You can change the size and position by using the -position(), resize(), and size() -methods:

+You can change the size and position by using the +position(), resize(), and size() +methods: \code button->position(x, y); @@ -176,69 +161,65 @@ group->resize(x, y, width, height); window->size(width, height); \endcode -

If you change a widget's size or position after it is +If you change a widget's size or position after it is displayed you will have to call redraw() on the -widget's parent.

+widget's parent. -

Colors

+ +\section common_colors Colors -

FLTK stores the colors of widgets as an 32-bit unsigned +FLTK stores the colors of widgets as an 32-bit unsigned number that is either an index into a color palette of 256 colors or a 24-bit RGB color. The color palette is not the X or WIN32 colormap, but instead is an internal table with -fixed contents.

+fixed contents. -

There are symbols for naming some of the more common colors:

+There are symbols for naming some of the more common colors: -
    -
  • FL_BLACK
    • +\li FL_BLACK -
  • FL_RED
    • +\li FL_RED -
  • FL_GREEN
    • +\li FL_GREEN -
  • FL_YELLOW
    • +\li FL_YELLOW -
  • FL_BLUE
    • +\li FL_BLUE -
  • FL_MAGENTA
    • +\li FL_MAGENTA -
  • FL_CYAN
    • +\li FL_CYAN -
  • FL_WHITE
    • +\li FL_WHITE -
  • FL_WHITE
    • -
+\li FL_WHITE -

These symbols are the default colors for all FLTK widgets. They are +These symbols are the default colors for all FLTK widgets. They are explained in more detail in the chapter -Enumerations

+Enumerations -
    -
  • FL_FOREGROUND_COLOR
    • +\li FL_FOREGROUND_COLOR -
  • FL_BACKGROUND_COLOR
    • +\li FL_BACKGROUND_COLOR -
  • FL_INACTIVE_COLOR
    • +\li FL_INACTIVE_COLOR -
  • FL_SELECTION_COLOR
    • -
+\li FL_SELECTION_COLOR -

RGB colors can be set using the fl_rgb_color() -function:

+RGB colors can be set using the fl_rgb_color() function: \code Fl_Color c = fl_rgb_color(85, 170, 255); \endcode -

The widget color is set using the color() method:

+The widget color is set using the color() method: \code button->color(FL_RED); \endcode -

Similarly, the label color is set using the labelcolor() -method:

+Similarly, the label color is set using the labelcolor() +method: \code button->labelcolor(FL_WHITE); @@ -247,35 +228,35 @@ button->labelcolor(FL_WHITE); \section common_boxtypes Box Types -

The type Fl_Boxtype stored and returned in Fl_Widget::box() +The type Fl_Boxtype stored and returned in Fl_Widget::box() is an enumeration defined in Enumerations.H. -Figure 3-3 shows the standard box types included with FLTK.

+Figure 3-3 shows the standard box types included with FLTK. \image html boxtypes.gif "Figure 3-3: FLTK box types" -

FL_NO_BOX means nothing is drawn at all, so whatever is -already on the screen remains. The FL_..._FRAME types only +FL_NO_BOX means nothing is drawn at all, so whatever is +already on the screen remains. The FL_..._FRAME 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.

+Figure 3-3 is the area that is not drawn by the frame types. -

Making Your Own Boxtypes

+\subsection common_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.

+You can define your own boxtypes by making a small function that draws +the box and adding it to the table of boxtypes.
Note: -

This interface has changed in FLTK 2.0!

+

This interface has changed in FLTK 2.0!

-

The Drawing Function

+\par The Drawing Function -

The drawing function is passed the bounding box and background color -for the widget:

+The drawing function is passed the bounding box and background color +for the widget: \code void xyz_draw(int x, int y, int w, int h, Fl_Color c) { @@ -285,8 +266,8 @@ void xyz_draw(int x, int y, int w, int h, Fl_Color c) { -

A simple drawing function might fill a rectangle with the -given color and then draw a black outline:

+A simple drawing function might fill a rectangle with the +given color and then draw a black outline: \code void xyz_draw(int x, int y, int w, int h, Fl_Color c) { @@ -297,183 +278,167 @@ void xyz_draw(int x, int y, int w, int h, Fl_Color c) { } \endcode -

Fl_Boxtype fl_down(Fl_Boxtype)

+ +\par Fl_Boxtype fl_down(Fl_Boxtype) -

fl_down returns the "pressed" or "down" version of a box. +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: fl_frame drawing. -

Fl_Boxtype fl_frame(Fl_Boxtype)

+ +\par Fl_Boxtype fl_frame(Fl_Boxtype) -

fl_frame returns the unfilled, frame-only version of a box. +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: fl_frame drawing. -

Fl_Boxtype fl_box(Fl_Boxtype)

+ +\par Fl_Boxtype fl_box(Fl_Boxtype) -

fl_box returns the filled version of a frame. +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: fl_frame. +See also: fl_frame. -

Adding Your Box Type

+\par Adding Your Box Type -

The Fl::set_boxtype() method adds or replaces the -specified box type:

+The Fl::set_boxtype() method adds or replaces the specified box type: \code #define XYZ_BOX FL_FREE_BOXTYPE Fl::set_boxtype(XYZ_BOX, xyz_draw, 1, 1, 2, 2); \endcode - -

The last 4 arguments to Fl::set_boxtype() are the +The last 4 arguments to Fl::set_boxtype() are the offsets for the x, y, width, and height values that should be -subtracted when drawing the label inside the box.

+subtracted when drawing the label inside the box. -

A complete box design contains four box types in this order: -a filled, neutral box (UP_BOX), a filled, depressed box -(DOWN_BOX), and the same as outlines only (UP_FRAME -and DOWN_FRAME). The function -fl_down(Fl_Boxtype) +A complete box design contains four box types in this order: +a filled, neutral box (UP_BOX), a filled, depressed box +(DOWN_BOX), and the same as outlines only (UP_FRAME +and DOWN_FRAME). The function +fl_down(Fl_Boxtype) expects the neutral design on a boxtype with a numerical value evenly divideable by two. -fl_frame(Fl_Boxtype) -expects the UP_BOX design at a value divideable by four.

+fl_frame(Fl_Boxtype) +expects the UP_BOX design at a value divideable by four. \section common_labels Labels and Label Types -

The label(), align(), labelfont(), -labelsize(), labeltype(), image(), and -deimage() methods control the labeling of widgets.

+The label(), align(), labelfont(), +labelsize(), labeltype(), image(), and +deimage() methods control the labeling of widgets. -

label()

+\par label() -

The label() method sets the string that is displayed +The 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.

+sign. Figure 3-4 shows the available symbols. \image html symbols.gif "Figure 3-4: FLTK label symbols" -

The @ sign may also be followed by the following optional -"formatting" characters, in this order:

+The @ sign may also be followed by the following optional +"formatting" characters, in this order: -
    +\li '#' forces square scaling, rather than distortion to the widget's shape. -
  • '#' forces square scaling, rather than distortion to - the widget's shape.
    • +\li +[1-9] or -[1-9] tweaks the scaling a little bigger or smaller. -
  • +[1-9] or -[1-9] tweaks the scaling a little bigger - or smaller.
    • +\li '$' flips the symbol horizontaly, '%' flips it verticaly. -
  • '$' flips the symbol horizontaly, '%' flips it verticaly.
    • +\li [0-9] - rotates by a multiple of 45 degrees. '5' and '6' do no rotation + while the others point in the direction of that key on a numeric keypad. + '0', followed by four more digits rotates the symbol by that amount in + degrees. -
  • [0-9] - rotates by a multiple of 45 degrees. '5' and - '6' do no rotation while the others point in the - direction of that key on a numeric keypad. '0', followed by four - more digits rotates the symbol by that amount in degrees.
    • - -
- -

Thus, to show a very large arrow pointing downward you would use the +Thus, to show a very large arrow pointing downward you would use the label string "@+92->". -

align()

- -

The align() method positions the label. The following -constants are defined and may be OR'd together as needed:

- -
    - -
  • FL_ALIGN_CENTER - center the label in the widget.
    • - -
  • FL_ALIGN_TOP - align the label at the top of the widget.
    • +\par align() -
  • FL_ALIGN_BOTTOM - align the label at the bottom of the - widget.
    • +The align() method positions the label. The following +constants are defined and may be OR'd together as needed: -
  • FL_ALIGN_LEFT - align the label to the left of the widget.
    • +\li FL_ALIGN_CENTER - center the label in the widget. -
  • FL_ALIGN_RIGHT - align the label to the right of the - widget.
    • +\li FL_ALIGN_TOP - align the label at the top of the widget. -
  • FL_ALIGN_INSIDE - align the label inside the widget.
    • +\li FL_ALIGN_BOTTOM - align the label at the bottom of the + widget. -
  • FL_ALIGN_CLIP - clip the label to the widget's bounding - box.
    • +\li FL_ALIGN_LEFT - align the label to the left of the widget. -
  • FL_ALIGN_WRAP - wrap the label text as needed.
    • +\li FL_ALIGN_RIGHT - align the label to the right of the + widget. -
  • FL_TEXT_OVER_IMAGE - show the label text over the image.
    • +\li FL_ALIGN_INSIDE - align the label inside the widget. -
  • FL_IMAGE_OVER_TEXT - show the label image over the text (default).
    • +\li FL_ALIGN_CLIP - clip the label to the widget's bounding + box. -
+\li FL_ALIGN_WRAP - wrap the label text as needed. -

labeltype()

+\li FL_TEXT_OVER_IMAGE - show the label text over the image. -

The labeltype() method sets the type of the label. The -following standard label types are included:

+\li FL_IMAGE_OVER_TEXT - show the label image over the text (default). -
    + +\par labeltype() -
  • FL_NORMAL_LABEL - draws the text.
    • +The labeltype() method sets the type of the label. The +following standard label types are included: -
  • FL_NO_LABEL - does nothing.
    • +\li FL_NORMAL_LABEL - draws the text. -
  • FL_SHADOW_LABEL - draws a drop shadow under - the text.
    • +\li FL_NO_LABEL - does nothing. -
  • FL_ENGRAVED_LABEL - draws edges as though - the text is engraved.
    • +\li FL_SHADOW_LABEL - draws a drop shadow under the text. -
  • FL_EMBOSSED_LABEL - draws edges as thought - the text is raised.
    • +\li FL_ENGRAVED_LABEL - draws edges as though the text is engraved. -
  • FL_ICON_LABEL - draws the icon associated - with the text.
    • +\li FL_EMBOSSED_LABEL - draws edges as thought the text is raised. -
+\li FL_ICON_LABEL - draws the icon associated with the text. -

image() and deimage()

+\par image() and deimage() -

The image() and deimage() methods set an image that -will be displayed with the widget. The deimage() method sets the -image that is shown when the widget is inactive, while the image() -method sets the image that is shown when the widget is active.

+The image() and deimage() methods set an image that +will be displayed with the widget. The deimage() method sets the +image that is shown when the widget is inactive, while the image() +method sets the image that is shown when the widget is active. -

To make an image you use a subclass of -Fl_Image.

+To make an image you use a subclass of +Fl_Image. -

Making Your Own Label Types

+\par Making Your Own Label Types -

Label types are actually indexes into a table of functions +Label types are actually indexes into a table of functions that draw them. The primary purpose of this is to use this to draw the labels in ways inaccessible through the -fl_font mechanisim (e.g. FL_ENGRAVED_LABEL) or -with program-generated letters or symbology.

+fl_font mechanisim (e.g. FL_ENGRAVED_LABEL) or +with program-generated letters or symbology.
Note: -

This interface has changed in FLTK 2.0!

+

This interface has changed in FLTK 2.0!

-
Label Type Functions
+\par Label Type Functions -

To setup your own label type you will need to write two +To setup your own label type you will need to write two functions: one to draw and one to measure the label. The draw -function is called with a pointer to a Fl_Label +function is called with a pointer to a Fl_Label structure containing the label information, the bounding box for -the label, and the label alignment:

+the label, and the label alignment: \code void xyz_draw(const Fl_Label *label, int x, int y, int w, int h, Fl_Align align) { @@ -481,13 +446,13 @@ void xyz_draw(const Fl_Label *label, int x, int y, int w, int h, Fl_Align align) } \endcode -

The label should be drawn inside this bounding box, -even if FL_ALIGN_INSIDE is not enabled. The function -is not called if the label value is NULL.

+The label should be drawn inside this bounding box, +even if FL_ALIGN_INSIDE is not enabled. The function +is not called if the label value is NULL. -

The measure function is called with a pointer to a -Fl_Label structure and references to the width and -height:

+The measure function is called with a pointer to a +Fl_Label structure and references to the width and +height: \code void xyz_measure(const Fl_Label *label, int &w, int &h) { @@ -495,13 +460,13 @@ void xyz_measure(const Fl_Label *label, int &w, int &h) { } \endcode -

The function should measure the size of the label and set -w and h to the size it will occupy.

+The function should measure the size of the label and set +w and h to the size it will occupy. -
Adding Your Label Type
+\par Adding Your Label Type -

The Fl::set_labeltype method creates a label type -using your draw and measure functions:

+The Fl::set_labeltype method creates a label type +using your draw and measure functions: \code #define XYZ_LABEL FL_FREE_LABELTYPE @@ -509,47 +474,48 @@ using your draw and measure functions:

Fl::set_labeltype(XYZ_LABEL, xyz_draw, xyz_measure); \endcode -

The label type number n can be any integer value -starting at the constant FL_FREE_LABELTYPE. Once you -have added the label type you can use the labeltype() -method to select your label type.

+The label type number n can be any integer value +starting at the constant FL_FREE_LABELTYPE. Once you +have added the label type you can use the labeltype() +method to select your label type. -

The Fl::set_labeltype method can also be used to overload -an existing label type such as FL_NORMAL_LABEL.

+The Fl::set_labeltype method can also be used to overload +an existing label type such as FL_NORMAL_LABEL. -

Making your own symbols

+ +\par Making your own symbols -

It is also possible to define your own drawings and add +It is also possible to define your own drawings and add them to the symbol list, so they can be rendered as part of -any label.

+any label. -

To create a new symbol, you implement a drawing function +To create a new symbol, you implement a drawing function void drawit(Fl_Color c) which typically uses the complex drawing functions 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:

+table using fl_add_symbol: \code int fl_add_symbol(const char *name, void (*drawit)(Fl_Color), int scalable) \endcode -

name is the name of the symbol without the "@"; scalable +name is the name of the symbol without the "@"; scalable must be set to 1 if the symbol is generated using scalable vector drawing -functions.

+functions. \code int fl_draw_symbol(const char *name,int x,int y,int w,int h,Fl_Color col) \endcode -

This function draws a named symbol fitting the given rectangle. +This function draws a named symbol fitting the given rectangle. -

Callbacks

+\section common_callbacks Callbacks -

Callbacks are functions that are called when the value of a -widget changes. A callback function is sent a Fl_Widget +Callbacks are functions that are called when the value of a +widget changes. A callback function is sent a Fl_Widget pointer of the widget that changed and a pointer to data that -you provide:

+you provide: \code void xyz_callback(Fl_Widget *w, void *data) { @@ -557,9 +523,9 @@ void xyz_callback(Fl_Widget *w, void *data) { } \endcode -

The callback() method sets the callback function for a +The callback() method sets the callback function for a widget. You can optionally pass a pointer to some data needed for the -callback:

+callback: \code int xyz_data; @@ -567,9 +533,9 @@ int xyz_data; button->callback(xyz_callback, &xyz_data); \endcode -

Normally callbacks are performed only when the value of the +Normally callbacks are performed only when the value of the widget changes. You can change this using the Fl_Widget::when() -method:

+method: \code button->when(FL_WHEN_NEVER); @@ -589,22 +555,22 @@ button->when(FL_WHEN_CHANGED | FL_WHEN_NOT_CHANGED); 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.

+ to do so.

Hint:

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 this pointer is not - initialized for class methods.

+ outside a C++ class, the this pointer is not + initialized for class methods.

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 - callback() method of the widget can be a - pointer to the instance of your class.

+ callback() method of the widget can be a + pointer to the instance of your class. \code class Foo { @@ -621,11 +587,11 @@ w->callback(my_static_callback, (void *)this); -

Shortcuts

+\section common_shortcuts Shortcuts -

Shortcuts are key sequences that activate widgets such as -buttons or menu items. The shortcut() method sets the -shortcut for a widget:

+Shortcuts are key sequences that activate widgets such as +buttons or menu items. The shortcut() method sets the +shortcut for a widget: \code button->shortcut(FL_Enter); @@ -636,11 +602,11 @@ button->shortcut(FL_CTRL + FL_ALT + 'b'); button->shortcut(0); // no shortcut \endcode -

The shortcut value is the key event value - the ASCII value +The shortcut value is the key event value - the ASCII value or one of the special keys like -FL_Enter - +FL_Enter - combined with any modifiers like Shift, -Alt, and Control.

+Alt, and Control.
[Index]    -- cgit v1.2.3