From 3f1f8715853cd855aa66062f50843b21071f288a Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Wed, 8 Jan 2020 18:41:50 +0100 Subject: Drop 1.0 compatibility; document 1.4 migration The FLTK 1.0 compatibility support by defining macro 'FLTK_1_0_COMPAT' did no longer work since FLTK 1.3.x and nobody complained. Hence we can safely remove this "feature". Documentation changes: - Drop chapter 'Migrating Code from FLTK 1.0 to 1.1' - Drop chapter 'Migrating Code from FLTK 1.1 to 1.3' - Add chapter 'Migrating Code from FLTK 1.3 to 1.4' The removed chapters are still available in FLTK 1.3 docs. --- documentation/Doxyfile.in | 3 +- documentation/Makefile | 5 +- documentation/src/development.dox | 8 +- documentation/src/index.dox | 6 +- documentation/src/migration_1_1.dox | 176 ------------------------------------ documentation/src/migration_1_3.dox | 80 ---------------- documentation/src/migration_1_4.dox | 52 +++++++++++ documentation/src/osissues.dox | 4 +- documentation/src/preface.dox | 5 +- 9 files changed, 65 insertions(+), 274 deletions(-) delete mode 100644 documentation/src/migration_1_1.dox delete mode 100644 documentation/src/migration_1_3.dox create mode 100644 documentation/src/migration_1_4.dox (limited to 'documentation') diff --git a/documentation/Doxyfile.in b/documentation/Doxyfile.in index 58bc2b67f..f619a7fa1 100644 --- a/documentation/Doxyfile.in +++ b/documentation/Doxyfile.in @@ -572,8 +572,7 @@ INPUT += @CMAKE_CURRENT_SOURCE_DIR@/src/enumerations.dox INPUT += @CMAKE_CURRENT_SOURCE_DIR@/src/glut.dox INPUT += @CMAKE_CURRENT_SOURCE_DIR@/src/forms.dox INPUT += @CMAKE_CURRENT_SOURCE_DIR@/src/osissues.dox -INPUT += @CMAKE_CURRENT_SOURCE_DIR@/src/migration_1_1.dox -INPUT += @CMAKE_CURRENT_SOURCE_DIR@/src/migration_1_3.dox +INPUT += @CMAKE_CURRENT_SOURCE_DIR@/src/migration_1_4.dox INPUT += @CMAKE_CURRENT_SOURCE_DIR@/src/development.dox INPUT += @CMAKE_CURRENT_SOURCE_DIR@/src/license.dox INPUT += @CMAKE_CURRENT_SOURCE_DIR@/src/examples.dox diff --git a/documentation/Makefile b/documentation/Makefile index 73c39dc56..97886ae03 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -3,7 +3,7 @@ # # Makefile for the Fast Light Tool Kit (FLTK) documentation. # -# Copyright 1998-2015 by Bill Spitzak and others. +# Copyright 1998-2020 by Bill Spitzak and others. # # This library is free software. Distribution and use rights are outlined in # the file "COPYING" which should have been included with this file. If this @@ -43,8 +43,7 @@ HTMLFILES = \ $(SRC_DOCDIR)/glut.dox \ $(SRC_DOCDIR)/forms.dox \ $(SRC_DOCDIR)/osissues.dox \ - $(SRC_DOCDIR)/migration_1_1.dox \ - $(SRC_DOCDIR)/migration_1_3.dox \ + $(SRC_DOCDIR)/migration_1_4.dox \ $(SRC_DOCDIR)/development.dox \ $(SRC_DOCDIR)/license.dox \ $(SRC_DOCDIR)/examples.dox \ diff --git a/documentation/src/development.dox b/documentation/src/development.dox index e2fcefd0c..13808e6a6 100644 --- a/documentation/src/development.dox +++ b/documentation/src/development.dox @@ -315,9 +315,9 @@ The following code gives the navigation bar at the bottom of this page: diff --git a/documentation/src/preface.dox b/documentation/src/preface.dox index ea4d72f08..ef3a6c155 100644 --- a/documentation/src/preface.dox +++ b/documentation/src/preface.dox @@ -32,8 +32,7 @@ This manual is organized into the following chapters and appendices: \li \ref glut \li \ref forms \li \ref osissues -\li \ref migration_1_1 -\li \ref migration_1_3 +\li \ref migration_1_4 \li \ref development \li \ref license \li \ref examples @@ -76,7 +75,7 @@ was dropped after FLTK 1.0.10. FLTK uses the preprocessor definition \section preface_copyrights Copyrights and Trademarks -FLTK is Copyright 1998-2018 by Bill Spitzak and others. Use and +FLTK is Copyright 1998-2020 by Bill Spitzak and others. Use and distribution of FLTK is governed by the GNU Library General Public License with 4 exceptions, located in \ref license. -- cgit v1.2.3
- + [Prev] - Migrating Code from FLTK 1.1 to 1.3 + Migrating Code from FLTK 1.3 to 1.4 @@ -340,9 +340,9 @@ The following code gives the navigation bar at the bottom of this page:
- + [Prev] - Migrating Code from FLTK 1.1 to 1.3 + Migrating Code from FLTK 1.3 to 1.4 diff --git a/documentation/src/index.dox b/documentation/src/index.dox index c483b7d96..c81ac5f23 100644 --- a/documentation/src/index.dox +++ b/documentation/src/index.dox @@ -13,7 +13,7 @@ Revision 11 by F. Costantini, D. Gibson, M. Melcher, A. Schlosser, B. Spitzak and M. Sweet. - Copyright 1998-2018 by Bill Spitzak and others. + Copyright 1998-2020 by Bill Spitzak and others.
@@ -80,9 +80,7 @@ - \subpage osissues - - \subpage migration_1_1 - - - \subpage migration_1_3 + - \subpage migration_1_4 - \subpage development diff --git a/documentation/src/migration_1_1.dox b/documentation/src/migration_1_1.dox deleted file mode 100644 index ef5a5d8c8..000000000 --- a/documentation/src/migration_1_1.dox +++ /dev/null @@ -1,176 +0,0 @@ -/** - - \page migration_1_1 Migrating Code from FLTK 1.0 to 1.1 - - -This appendix describes the differences between the FLTK -1.0.x and FLTK 1.1.x functions and classes. - -\section migration_1_1_color Color Values - -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. - -\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 \c FL_FOREGROUND_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 - -The FLTK clipboard is now broken into two parts - a local -selection value and a cut-and-paste value. This allows FLTK to -support things like highlighting and replacing text that was -previously cut or copied, which makes FLTK applications behave -like traditional GUI applications. - -\section migration_1_1_file_chooser File Chooser - -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 \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 \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 -#include -#include -#include -\endcode - -The following table shows the old and new function names: - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Old 1.0.x NameNew 1.1.x Name
contrast()fl_contrast()
down()fl_down()
filename_absolute()fl_filename_absolute()
filename_expand()fl_filename_expand()
filename_ext()fl_filename_ext()
filename_isdir()fl_filename_isdir()
filename_list()fl_filename_list()
filename_match()fl_filename_match()
filename_name()fl_filename_name()
filename_relative()fl_filename_relative()
filename_setext()fl_filename_setext()
frame()fl_frame()
inactive()fl_inactive()
numericsort()fl_numericsort()
-
- -\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. - -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. - -Image labels are no longer provided as an add-on label type. -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 -mechanism to preserve source compatibility. - -\section migration_1_1_keyboard Keyboard Navigation - -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() -method to disable it: - -\code -Fl::visible_focus(0); -\endcode - - -\htmlonly -
- - - - - - -
- - [Prev] - Operating System Issues - - - [Index] - - - Migrating Code from FLTK 1.1 to 1.3 - [Next] - -
-\endhtmlonly - -*/ diff --git a/documentation/src/migration_1_3.dox b/documentation/src/migration_1_3.dox deleted file mode 100644 index 203e8d09a..000000000 --- a/documentation/src/migration_1_3.dox +++ /dev/null @@ -1,80 +0,0 @@ -/** - - \page migration_1_3 Migrating Code from FLTK 1.1 to 1.3 - -This appendix describes the differences between the FLTK -1.1.x and FLTK 1.3.x functions and classes. - -\section migration_1_3_fltk_1_0 Migrating From FLTK 1.0 - -If you want to migrate your code from FLTK 1.0 to FLTK 1.3, -then you should first consult Appendix \ref migration_1_1. - - -\section migration_1_3_fl_scroll Fl_Scroll Widget - -Fl_Scroll::scroll_to(int x, int y) replaces Fl_Scroll::position(int x, int y). - -This change was needed because Fl_Scroll::position(int,int) redefined -Fl_Widget::position(int,int), but with a completely different function (moving -the scrollbars instead of moving the widget). - -Please be aware that you need to change your application's code for all -Fl_Scroll-derived widgets, if you used Fl_Scroll::position(int x, int y) -to position the scrollbars (not the widget itself). - -The compiler will not detect any errors, because your calls to -\b position(int x, int y) will be calling Fl_Widget::position(int x, int y). - - -\section migration_1_3_unicode Unicode (UTF-8) - -FLTK 1.3 uses Unicode (UTF-8) encoding internally. If you are only using -characters in the ASCII range (32-127), there is a high probability that -you don't need to modify your code. However, if you use international -characters (128-255), encoded as e.g. Windows codepage 1252, ISO-8859-1, -ISO-8859-15 or any other encoding, then you will need to update your character -string constants and widget input data accordingly. - -Please refer to the \ref unicode chapter for more details. - -\note It is important that, although your software uses only ASCII characters -for input to FLTK widgets, the user may enter non-ASCII characters, and FLTK -will return these characters with UTF-8 encoding to your application, e.g. -via Fl_Input::value(). You \b will need to re-encode them to \b your (non-UTF-8) -encoding, otherwise you might see or print garbage in your data. - - -\section migration_1_3_int_coords Widget Coordinate Representation - -FLTK 1.3 changed all Widget coordinate variables and methods, e.g. -Fl_Widget::x(), Fl_Widget::y(), Fl_Widget::w(), Fl_Widget::h(), from -short (16-bit) to int (32-bit) representation. This should not affect -any existing code, but makes it possible to use bigger scroll areas -(e.g. Fl_Scroll widget). - - -\htmlonly -
- - - - - - -
- - [Prev] - Migrating Code from FLTK 1.0 to 1.1 - - - [Index] - - - Developer Information - [Next] - -
-\endhtmlonly - -*/ diff --git a/documentation/src/migration_1_4.dox b/documentation/src/migration_1_4.dox new file mode 100644 index 000000000..425135ca9 --- /dev/null +++ b/documentation/src/migration_1_4.dox @@ -0,0 +1,52 @@ +/** + + \page migration_1_4 Migrating Code from FLTK 1.3 to 1.4 + +This appendix describes the differences between the FLTK +1.3.x and FLTK 1.4.x functions and classes. + +\section migration_1_4_old_versions Migrating From FLTK 1.0 Or 1.1 To 1.4 + +If you want to migrate your code from FLTK 1.0 or 1.1 to FLTK 1.4, +then you should first consult the relevant appendices in FLTK 1.3 +documentation online or by downloading the FLTK 1.3 documentation. +See https://www.fltk.org/doc-1.3/index.html +and/or https://www.fltk.org/software.php , respectively. + + +\section migration_1_4_headers Minor Changes in Header Files + +(to be documented) + + + +\section migration_1_4_preferences Fl_Preferences + +(to be documented) + + + +\htmlonly +
+ + + + + + +
+ + [Prev] + Operating System Issues + + + [Index] + + + Developer Information + [Next] + +
+\endhtmlonly + +*/ diff --git a/documentation/src/osissues.dox b/documentation/src/osissues.dox index 86b05b9c0..c391d28c0 100644 --- a/documentation/src/osissues.dox +++ b/documentation/src/osissues.dox @@ -918,8 +918,8 @@ FLTK uses UTF-8-encoded UNIX-style filenames and paths. [Index] 		- - Migrating Code from FLTK 1.0 to 1.1 + + Migrating Code from FLTK 1.3 to 1.4 [Next]