From ecd2c821be8a72b0364cf3e08d102e3f9a82defc Mon Sep 17 00:00:00 2001
From: Michael R Sweet 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
-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. This chapter teaches you the basics of compiling programs
+that use FLTK. All programs must include the file <FL/Fl.H>.
+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. Listing 1 - "hello.cxx"
After including the required header files, the program then creates a
+window: and a box with the "Hello, World!" string in it: Next, we set the type of box and the size, font, and style of the label: Finally, we show the window and enter the FLTK event loop: 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. The widgets are created using the C++ new operator. For
+most widgets the arguments to the constructor are: 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. 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. 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.
+
+
+ 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. 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. 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. 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".
+
+ 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,
+which means that a raised button border will be drawn around
+the widget. You can learn more about boxtypes in
+Chapter 3. 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". 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 yourself. This greatly
-reduces code size and execution time. The only common exception is
-value() which calls redraw() if necessary.
+
+ 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
+yourself. This greatly reduces code size and execution time.
+The only common exception is value() which calls
+redraw() if necessary. 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 method sets the type of label. FLTK supports
-normal, embossed, shadowed, symbol, and image labels internally, and
-more types can be added as desired. A complete list of all label options can be found in
-Chapter 3. 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
+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
+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
+Chapter 3. 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. 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. 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. 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. 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. 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() does not return until all of the windows
+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 -I option: The fltk-config script included with FLTK can be
+used to get the options that are required by your compiler: Similarly, when linking your application you will need to tell the
+compiler to use the FLTK library: The fltk-config script included with FLTK can be
+used to get the options that are required by your linker: 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
+WinSock (WSOCK32.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 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
+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. All public symbols in FLTK start with the characters 'F' and 'L': The proper way to include FLTK header files is: Microsoft Windows developers please note: case *is*
+significant under other operating systems, and the C standard
+uses the forward slash (/) to separate directories. Do not
+use any of the following include lines: This chapter describes many of the widgets that are provided
+with FLTK and covers how to query and set the standard
+attributes. FLTK provides many types of buttons: For all of these buttons you just need to include the corresponding
-<FL/Fl_xyz_Button.H> header file. The constructor takes the
-bounding box of the button and optionally a label string:
- All of these buttons just need the corresponding
+<FL/Fl_xyz_Button.H> header file. The constructor
+takes the bounding box of the button and optionally a label
+string: Each button has an associated
+type()
+which allows it to behave as a push button, toggle button, or
+radio button: 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. FLTK provides several text widgets for displaying and receiving text: The value() method
-is used to get or set the string that is displayed: The Fl_Output and Fl_Multiline_Output
+widgets allow the user to copy text from the output field but
+not change it. The value()
+method is used to get or set the string that is displayed: 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. Unlike text widgets, valuators keep track of numbers instead of
+strings. FLTK provides the following valuators: 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. 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: You can change the size and position by using the position(),
-resize(), and size() methods:
- 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. You can change the size and position by using the
+position(), resize(), and size()
+methods: There are symbols for naming some of the more common colors:
+
+
+ If you change a widget's size or position after it is
+displayed you will have to call redraw() on the
+widget's parent. 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. There are symbols for naming some of the more common colors: RGB colors can be set using the fl_rgb_color()
+function: The widget color is set using the color() method: Similarly, the label color is set using the labelcolor()
+method: The type Fl_Boxtype stored and returned in
-Fl_Widget::box() is an enumeration defined in
-<Enumerations.H>:
- 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. 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. In the above diagram
-the blue color is the area that is not drawn by the box. You can define your own boxtypes by making a small function that draws
-the box and adding it to the table of boxtypes.
+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. You can define your own boxtypes by making a small function that draws
+the box and adding it to the table of boxtypes. This interface has changed in FLTK 2.0! The drawing function is passed the bounding box and background color
+for the widget: A simple drawing function might fill a rectangle with the
+given color and then draw a black outline: The Fl::set_boxtype() method adds or replaces the
+specified box type: 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. The label(), align(), labelfont(),
+labelsize(), labeltype(), image(), and
+deimage() methods control the labeling of widgets. 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. The @ sign may also be followed by the following optional
+"formatting" characters, in this order: The align() method positions the label. The following
+constants are defined and may be OR'd together as needed: The labeltype() method sets the type of the label. The
+following standard label types are included: 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. Label types are actually indexes into a table of functions that draw
-them. The primary purpose of this is to let you reuse the label()
- pointer as a pointer to arbitrary data such as a bitmap or pixmap. You
-can also 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.
+
+ 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. This interface has changed in FLTK 2.0! 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
+structure containing the label information, the bounding box for
+the label, and the label alignment: The measure function is called with a pointer to a Fl_Label
-structure and references to the width and height: 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 function should measure the size of the label and set
+w and h to the size it will occupy. The Fl::set_labeltype method creates a label type
+using your draw and measure functions: 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_SYMBOL_LABEL label type uses the label()
-string to look up a small drawing procedure in a hash table. For
-historical reasons the string always starts with '@'; if it starts with
-something else (or the symbol is not found) the label is drawn
-normally:
- The @ sign may be followed by the following optional "formatting"
-characters, in this order:
-2 - FLTK Basics
- This chapter will teach you the basics of compiling programs that use
-FLTK.
-Naming
- All public symbols in FLTK start with the characters 'F' and 'L':
-
-
-Header Files
- The proper way to include FLTK header files is:
-
-
-#include <FL/Fl_xyz.H>
-
-
-Microsoft Windows developers please note: case *is* significant
-under other operating systems, and the C standard uses the forward
-slash (/) to separate directories. Do not do any of the following:
-
-
-#include <FL\Fl_xyz.H>
-#include <fl/fl_xyz.h>
-#include <Fl/fl_xyz.h>
-
-
-Compiling Programs with Standard Compilers
- 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:
-
-
-CC -I/usr/local/include ...
-gcc -I/usr/local/include ...
-
-
- Similarly, when linking your application you will need to tell the
-compiler to use the FLTK library:
-
-
-CC ... -L/usr/local/lib -lfltk -lXext -lX11 -lm
-gcc ... -L/usr/local/lib -lfltk -lXext -lX11 -lm
-
-
-Compiling Programs with Microsoft Visual C++
- 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 WinSock (WSOCK32.LIB)
-libraries to the "Link" settings.
-Writing Your First FLTK Program
- All programs must include the file <FL/Fl.H>. 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.
+
+
@@ -83,111 +31,256 @@ int main(int argc, char **argv) {
window->show(argc, argv);
return Fl::run();
}
-
-
- After including the required header files, the program then creates a
-window:
-
-
+
+
+
Fl_Window *window = new Fl_Window(300,180);
-
-
- and a box with the "Hello, World!" string in it:
-
-
+
+
+
Fl_Box *box = new Fl_Box(20,40,260,100,"Hello, World!");
-
-
- Next, we set the type of box and the size, font, and style of the label:
-
-
+
+
+
box->box(FL_UP_BOX);
box->labelsize(36);
box->labelfont(FL_BOLD+FL_ITALIC);
box->labeltype(FL_SHADOW_LABEL);
-
-
- Finally, we show the window and enter the FLTK event loop:
-
-
+
+
+
window->end();
window->show(argc, argv);
return Fl::run();
-
-
-The resulting program will display the window below. You can quit the
-program by closing the window or pressing the ESCape key.
-

+Figure 2-1: The Hello, World! WindowCreating the Widgets
- The widgets are created using the C++ new operator. For
- most widgets the arguments to the constructor are:
-
-
+
+
Fl_Widget(x, y, width, height, label)
-
-
-Get/Set Methods
-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, which means that a raised button border will be drawn
-around the widget. You can learn more about boxtypes in
-Chapter 3.
-Redrawing After Changing Attributes
-Labels
-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.
-Showing the Window
- The show() method shows the widget or window. For windows
+
+The Main Event Loop
- FLTK provides the Fl:run()
- method to enter a standard event processing loop. This is equivalent
-to the following code:
-
-
+
+
while (Fl::wait());
-
+
+
+Compiling Programs with Standard Compilers
+
+
+CC -I/usr/local/include ...
+gcc -I/usr/local/include ...
+
+
+
+CC `fltk-config --cxxflags` ...
+
+
+
+CC ... -L/usr/local/lib -lfltk -lXext -lX11 -lm
+gcc ... -L/usr/local/lib -lfltk -lXext -lX11 -lm
+
+
+
+CC ... `fltk-config --ldflags`
+
+
+Compiling Programs with Microsoft Visual C++
+
+Naming
+
+
+
+
-Fl::run() does not return until all of the windows under FLTK
-control are closed by the user or your program.
+
+Header Files
+
+
+#include <FL/Fl_xyz.H>
+
+
+
+#include <FL\Fl_xyz.H>
+#include <fl/fl_xyz.h>
+#include <Fl/fl_xyz.h>
+
+
diff --git a/documentation/common.html b/documentation/common.html
index b13955da2..e05bdfbc8 100644
--- a/documentation/common.html
+++ b/documentation/common.html
@@ -1,326 +1,515 @@
-
+
+
+
3 - Common Widgets and Attributes
- This chapter describes many of the widgets that are provided with FLTK
-and covers how to query and set the standard attributes.
+
+Buttons
- FLTK provides many types of buttons:
+
+
-
-
-
-
+
+

+Figure 3-1: FLTK Button Widgets
Fl_Button *button = new Fl_Button(x, y, width, height, "label");
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");
-
-
- Each button has an associated
-type() which allows it to behave as a push button, toggle
-button, or radio button:
-
-
-button->type(0);
+
+
+
+button->type(FL_NORMAL_BUTTON);
lbutton->type(FL_TOGGLE_BUTTON);
rbutton->type(FL_RADIO_BUTTON);
-
-
- 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.
+
+
+Text
- FLTK provides several text widgets for displaying and receiving text:
+
+
-
- The Fl_Output and Fl_Multiline_Output widgets allow
-the user to copy text from the output field but not change it.
-
-
+
+
Fl_Input *input = new Fl_Input(x, y, width, height, "label");
input->value("Now is the time for all good men...");
-
-
-Valuators
- Unlike text widgets, valuators keep track of numbers instead of
-strings. FLTK provides the following valuators:
+
+
-
-

+Figure 3-2: FLTK valuator widgetsGroups
- 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:
+
+
-
+
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 x(), y(), w(),
-and h() methods.
-
-
+
+
button->position(x, y);
group->resize(x, y, width, height);
window->size(width, height);
-
-
-If you change a widget's size or position after it is displayed you
-will have to call redraw() on the widget's parent.
-Colors
-FLTK stores the colors of widgets as an 8-bit number that is an index
-into a color palette of 256 colors. This is not the X or WIN32
-colormap, but instead is an internal table with fixed contents.
-Colors
+
+
-
- The widget color can be set using the color() method:
-
-
+
+
+Fl_Color c = fl_rgb_color(85, 170, 255);
+
+
+
button->color(FL_RED);
-
-
- Similarly, the label color can be set using the labelcolor()
- method:
-
-
+
+
+
button->labelcolor(FL_WHITE);
-
-
-Box Types
-
Box Types
+
+
+Figure 3-3: FLTK box typesMaking your own Boxtypes
-Warning: this interface may change in future versions of fltk!
-Making Your Own Boxtypes
+
+
+
+
+Note:
+
+The Drawing Function
- The drawing function is passed the bounding box and background color
-for the widget:
-
-
+
+
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:
-
-
+
+
+
void xyz_draw(int x, int y, int w, int h, Fl_Color c) {
fl_color(c);
fl_rectf(x, y, w, h);
fl_color(FL_BLACK);
fl_rect(x, y, w, h);
}
-
-
+
+
Adding Your Box Type
- The Fl::set_boxtype() method adds or replaces the specified
-box type:
-
-
+
+
#define XYZ_BOX FL_FREE_BOXTYPE
Fl::set_boxtype(XYZ_BOX, xyz_draw, 1, 1, 2, 2);
-
-
- The last 4 arguments to Fl::set_boxtype() are the offsets for
-the bounding box that should be subtracted when drawing the label
-inside the box.
-Labels and Label Types
- The label(), align(), labelfont(),
-labelsize(), and labeltype() methods control the labeling
-of widgets.
+
+
+Labels and Label Types
+
+label()
- The label() method sets the string that is displayed for the
-label. For the FL_SYMBOL_LABEL and image label types the
-string contains the actual symbol or image data.
+
+
+Figure 3-4: FLTK label symbols
+
+
+
align()
- The align() method positions the label. The following
-constants are defined (they may be OR'd together as needed):
+
+
-
+
labeltype()
- The labeltype() method sets the type of the label. The
-following standard label types are included:
+
+
-
- To make bitmaps or pixmaps you use a method on the
-Fl_Bitmap or Fl_Pixmap
- objects.
+
+image() and deimage()
+
+Making Your Own Label Types
-Warning: this interface is changing in FLTK 2.0!
-
+
+
+Note:
+
+Label Type Functions
- To setup your own label type you will need to write two functions to
-draw and measure the label. The draw 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:
-
-
+
+
void xyz_draw(Fl_Label *label, int x, int y, int w, int h, Fl_Align align) {
...
}
-
-
- 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.
-
-
+
+
+
void xyz_measure(Fl_Label *label, int &w, int &h) {
...
}
-
-
- It should measure the size of the label and set w and h
- to the size it will occupy.
+
+
+Adding Your Label Type
- The Fl::set_labeltype method creates a label type using your
-draw and measure functions:
-
-
+
+
#define XYZ_LABEL FL_FREE_LABELTYPE
Fl::set_labeltype(XYZ_LABEL, xyz_draw, xyz_measure);
-
-
- 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.
+
+
+Symbol Labels
-
-
+an existing label type such as FL_NORMAL_LABEL.
+ +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:
+ +
void xyz_callback(Fl_Widget *w, void *data) {
...
}
-
-
- The callback() method sets the callback function for a
-widget. You can optionally pass a pointer to some data needed for the
-callback:
-++ +
The callback() method sets the callback function for a +widget. You can optionally pass a pointer to some data needed for the +callback:
+ +int xyz_data; -button->callback(xyz_callback, data); -- - Normally callbacks are performed only when the value of the widget -changes. You can change this using the -when() method: -
+button->callback(xyz_callback, &xyz_data); ++ +
Normally callbacks are performed only when the value of the +widget changes. You can change this using the +when() +method:
+ +button->when(FL_WHEN_NEVER); button->when(FL_WHEN_CHANGED); button->when(FL_WHEN_RELEASE); @@ -328,24 +517,60 @@ button->when(FL_WHEN_RELEASE_ALWAYS); button->when(FL_WHEN_ENTER_KEY); button->when(FL_WHEN_ENTER_KEY_ALWAYS); button->when(FL_WHEN_CHANGED | FL_WHEN_NOT_CHANGED); -- + + +
| 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. + +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. + +
+class foo {
+ void my_callback(Widget *);
+ static void my_static_callback(Widget *w, foo *f) { f->my_callback(w); }
+ ...
+}
+
+...
+
+w->callback(my_static_callback, this);
+
+ |
+
+ +Shortcuts are key sequences that activate widgets such as +buttons or menu items. The shortcut() method sets the +shortcut for a widget:
+ +
button->shortcut(FL_Enter); button->shortcut(FL_SHIFT + 'b'); button->shortcut(FL_CTRL + 'b'); button->shortcut(FL_ALT + 'b'); button->shortcut(FL_CTRL + FL_ALT + 'b'); button->shortcut(0); // no shortcut -- -The shortcut value is the key event value (the ASCII value or one of -the special keys like FL_Enter) combined -with any modifiers (like shift, alt, and control). - + + +
The shortcut value is the key event value - the ASCII value +or one of the special keys like +FL_Enter - +combined with any modifiers like Shift, +Alt, and Control.
+ + + diff --git a/documentation/intro.html b/documentation/intro.html index fe9d5fcac..c92b860af 100644 --- a/documentation/intro.html +++ b/documentation/intro.html @@ -1,43 +1,45 @@ +The Fast Light Tool Kit ("FLTK", pronounced "fulltick") is a LGPL'd C++ graphical user interface toolkit for X (UNIX®), OpenGL®, and Microsoft® -Windows® NT 4.0, 95, or 98. It was originally developed by -Mr. Bill Spitzak and is currently maintained by a small group -of developers across the world with a central repository in the -US.
+Windows®. Work is also underway to support FLTK under MacOS +X. It was originally developed by Mr. Bill Spitzak and is +currently maintained by a small group of developers across the +world with a central repository in the US.It has always been Bill's belief that the GUI API of all modern -systems is much too high level. Toolkits (even FL) are not what -should be provided and documented as part of an operating system. The -system only has to provide arbitrary shaped but featureless windows, a -powerful set of graphics drawing calls, and a simple unalterable -method of delivering events to the owners of the windows. NeXT (if -you ignored NextStep) provided this, but they chose to hide it and -tried to push their own baroque toolkit instead...
+It has always been Bill's belief that the GUI API of all +modern systems is much too high level. Toolkits (even FLTK) are +not what should be provided and documented as part of an +operating system. The system only has to provide arbitrary +shaped but featureless windows, a powerful set of graphics +drawing calls, and a simple unalterable method of +delivering events to the owners of the windows. NeXT (if you +ignored NextStep) provided this, but they chose to hide it and +tried to push their own baroque toolkit instead.
Many of the ideas in FLTK were developed on a NeXT (but not using NextStep) in 1987 in a C toolkit Bill called "views". Here he came up with passing events downward in the tree and having the handle routine return a value -indicating the used the event, and the table-driven menus. In +indicating the used the event, and the table-driven menus. In general he was trying to prove that complex UI ideas could be entirely implemented in a user space toolkit, with no knowledge or support by the system.
After going to film school for a few years, Bill worked at -Sun Microsystems on the (doomed) NeWS project. Here he found an -even better and cleaner windowing system, and he reimplemented -"views" atop that. NeWS did have an unnecessarily +Sun Microsystems on the (doomed) NeWS project. Here he found an +even better and cleaner windowing system, and he reimplemented +"views" atop that. NeWS did have an unnecessarily complex method of delivering events which hurt it. But the designers did admit that perhaps the user could write just as -good of a button as they could, and officially exposed the -lower level interface.
+good of a button as they could, and officially exposed the lower +level interface.With the death of NeWS Bill realized that he would have to live with X. The biggest problem with X is the "window @@ -45,7 +47,7 @@ manager", which means that the toolkit can no longer control the window borders or drag the window around.
At Digital Domain Bill discovered another toolkit, -"Forms". Forms was similar to his work, but provided +"Forms". Forms was similar to his work, but provided many more widgets, since it was used in many real applications, rather then as theoretical work. He decided to use Forms, except he integrated his table-driven menus into it. Several very large @@ -101,8 +103,8 @@ is now included with several Linux distributions.
performance.There are two ways to build FLTK under Microsoft Windows. +
There are three ways to build FLTK under Microsoft Windows. The first is to use the Visual C++ 5.0 project files under the "visualc" directory. Just open (or double-click on) the "fltk.dsw" file to get the whole shebang.
-The second method is to use a GNU-based development tool with -the files in the "makefiles" directory. To build +
The second method is to use the configure script +included with the FLTK software; this has only been tested with +the CygWin tools:
+ ++sh configure --prefix=C:/FLTK +make ++ +
The final method is to use a GNU-based development tool with +the files in the "makefiles" directory. To build using one of these tools simply copy the appropriate makeinclude and config files to the main directory and do a make:
@@ -252,19 +263,23 @@ makeWhen compiling an application or DLL that uses the FLTK DLL, you will need -to define the FL_DLL preprocessor symbol to get the correct linkage -commands embedded within the FLTK header files. + +
The "fltkdll.dsp" project file builds a DLL-version +of the FLTK library. Because of name mangling differences +between PC compilers (even between different versions of Visual +C++!) you can only use the DLL that is generated with the same +version compiler that you built it with.
+ +When compiling an application or DLL that uses the FLTK DLL, +you will need to define the FL_DLL preprocessor symbol +to get the correct linkage commands embedded within the FLTK +header files.
The current OS/2 build requires XFree86 for OS/2 to work. A +native Presentation Manager version has not been implemented +yet (volunteers are welcome!).
The current set of Makefiles/configuration failes assumes that EMX 0.9d and libExt @@ -274,18 +289,28 @@ is installed.
To build the XFree86 version of FLTK for OS/2, copy the appropriate makeinclude and config files to the main directory and do a make:
-+
copy makefiles\Makefile.os2x Makefile make -- + + +
The current version of FLTK requires the XFree86 X server for +Darwin. Follow the instructions for building FLTK under +UNIX.
+ +Future versions of FLTK will provide a Carbon-based window +interface, so XFree86 will no longer be required.
FLTK is available on the 'net in a bunch of locations:
+To send a message to the FLTK mailing list +("fltk@fltk.org") you must first join the list. +Non-member submissions are blocked to avoid problems with +unsolicited email.
+To join the FLTK mailing list, send a message to -"majordomo@fltk.org" with "subscribe fltk" in the message body. A -digest of this list is available by subscribing to the "fltk-digest" -mailing list.
+"majordomo@fltk.org" with "subscribe fltk" +in the message body. A digest of this list is available by +subscribing to the "fltk-digest" mailing list. +To report a bug in FLTK, send an email to +"fltk-bugs@fltk.org". Please include the FLTK version, +operating system & version, and compiler that you are using +when describing the bug or problem. We will be unable to provide +any kind of help without that basic information.
+ +Bugs can also be reported to the "fltk.bugs" newsgroup or on the +SourceForge bug tracker pages.
+For general support and questions, please use the FLTK mailing list -at "fltk@fltk.org".
- +at "fltk@fltk.org" or one of the newsgroups. + + + diff --git a/documentation/preface.html b/documentation/preface.html index a5ff66532..d6bd1952f 100644 --- a/documentation/preface.html +++ b/documentation/preface.html @@ -56,7 +56,9 @@ interfaces.