diff --git a/documentation/src/development.dox b/documentation/src/development.dox index 347339814..d4f0efa13 100644 --- a/documentation/src/development.dox +++ b/documentation/src/development.dox @@ -415,48 +415,27 @@ The above code produces the following paragraphs: \image html tiny.gif \image latex tiny.eps "" width=2cm -\section development_navigation_test 5 Navigation Proposals +\section development_navigation_test Navigation Elements + +Each introduction (tutorial) page ends with navigation elements. These +elements must only be included in the html documentation, therefore +they must be separated with \\htmlonly and \\endhtmlonly. + +Example navigation links: + +\verbatim +\htmlonly +
+[Index]    +[Previous] Migrating Code from FLTK 1.1 to 1.3   +[Next] Software License +\endhtmlonly +\endverbatim \htmlonly -
-\link migration_1_3 [ Previous ] \endlink - [ Index ] - Next: \ref license - -
-[ Index ] - Previous: \ref migration_1_3 - Next: \ref license - -
-[ Index ]
- Previous: \ref migration_1_3
- Next: \ref license - -
-[ Index ] - Previous: \ref migration_1_3 - Next: \ref license - -
-\link migration_1_3 [ Previous ] \endlink - [ Top ] -\link license [ Next ] \endlink - -
-
-
- -\section development_proposed_nav Proposed (final) Navigation Elements - -See below. -
[Index]    -[Previous]  - \ref migration_1_3    -[Next]  - \ref license - +[Previous] Migrating Code from FLTK 1.1 to 1.3   +[Next] Software License \endhtmlonly */ diff --git a/documentation/src/migration_1_1.dox b/documentation/src/migration_1_1.dox index 17a498cc0..5abd94d9a 100644 --- a/documentation/src/migration_1_1.dox +++ b/documentation/src/migration_1_1.dox @@ -12,17 +12,15 @@ Color values are now stored in a 32-bit unsigned integer instead of the unsigned character in 1.0.x. This allows for the specification of 24-bit RGB values or 8-bit FLTK color indices. -FL_BLACK and FL_WHITE now remain black and -white, even if the base color of the gray ramp is changed using -Fl::background(). -FL_DARK3 and FL_LIGHT3 can be used instead to +\c FL_BLACK and \c FL_WHITE now remain black and white, even if +the base color of the gray ramp is changed using Fl::background(). +\c FL_DARK3 and \c FL_LIGHT3 can be used instead to draw a very dark or a very bright background hue. -Widgets use the new color symbols FL_FORGROUND_COLOR, -FL_BACKGROUND_COLOR, FL_BACKGROUND2_COLOR, -FL_INACTIVE_COLOR, and FL_SELECTION_COLOR. -More details can be found in the chapter -Enumerations. +Widgets use the new color symbols \c FL_FORGROUND_COLOR, +\c FL_BACKGROUND_COLOR, \c FL_BACKGROUND2_COLOR, +\c FL_INACTIVE_COLOR, and \c FL_SELECTION_COLOR. +More details can be found in the chapter \ref enumerations. \section migration_1_1_cutnpaste Cut and Paste Support @@ -36,18 +34,16 @@ like traditional GUI applications. The file chooser in FLTK 1.1.x is significantly different than the one supplied with FLTK 1.0.x. Any code that directly -references the old FCB class or members will need -to be ported to the new -Fl_File_Chooser -class. +references the old \c FCB class or members will need +to be ported to the new Fl_File_Chooser class. \section migration_1_1_functions Function Names Some function names have changed from FLTK 1.0.x to 1.1.x in order to avoid name space collisions. You can still use the old -function names by defining the FLTK_1_0_COMPAT -symbol on the command-line when you compile -(-DFLTK_1_0_COMPAT) or in your source, e.g.: +function names by defining the \c FLTK_1_0_COMPAT symbol on +the command-line when you compile (\c -DFLTK_1_0_COMPAT) or in +your source, e.g.: \code #define FLTK_1_0_COMPAT @@ -125,24 +121,18 @@ The following table shows the old and new function names: \section migration_1_1_images Image Support -Image support in FLTK has been significantly revamped in -1.1.x. The Fl_Image class -is now a proper base class, with the core image drawing -functionality in the -Fl_Bitmap, -Fl_Pixmap, -and -Fl_RGB_Image -classes. +Image support in FLTK has been significantly revamped in 1.1.x. +The Fl_Image class is now a proper base class, with the core +image drawing functionality in the Fl_Bitmap, Fl_Pixmap, and +Fl_RGB_Image classes. BMP, GIF, JPEG, PNG, XBM, and XPM image files can now be loaded using the appropriate image classes, and the -Fl_Shared_Image -class can be used to cache images in memory. +Fl_Shared_Image class can be used to cache images in memory. Image labels are no longer provided as an add-on label type. -If you use the old label() methods on an image, the -widget's image() method is called to set the image +If you use the old \c label() methods on an image, the +widget's \c image() method is called to set the image as the label. Image labels in menu items must still use the old labeltype @@ -152,8 +142,7 @@ mechanism to preserve source compatibility. FLTK 1.1.x now supports keyboard navigation and control with all widgets. To restore the old FLTK 1.0.x behavior so that only -text widgets get keyboard focus, call the -Fl::visible_focus() +text widgets get keyboard focus, call the Fl::visible_focus() method to disable it: \code @@ -163,10 +152,7 @@ Fl::visible_focus(0); \htmlonly
[Index]    -[Previous]  - \ref osissues    -[Next]  - \ref migration_1_3 - +[Previous] Operating System Issues   +[Next] Migrating Code from FLTK 1.1 to 1.3 \endhtmlonly */