summaryrefslogtreecommitdiff
path: root/documentation/src_doc/migration_1_1.dox
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/src_doc/migration_1_1.dox')
-rw-r--r--documentation/src_doc/migration_1_1.dox172
1 files changed, 172 insertions, 0 deletions
diff --git a/documentation/src_doc/migration_1_1.dox b/documentation/src_doc/migration_1_1.dox
new file mode 100644
index 000000000..17a498cc0
--- /dev/null
+++ b/documentation/src_doc/migration_1_1.dox
@@ -0,0 +1,172 @@
+/**
+
+ \page migration_1_1 G - 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.
+
+<tt>FL_BLACK</tt> and <tt>FL_WHITE</tt> now remain black and
+white, even if the base color of the gray ramp is changed using
+<A HREF="Fl.html#Fl.background"><tt>Fl::background()</tt></A>.
+<tt>FL_DARK3</tt> and <tt>FL_LIGHT3</tt> can be used instead to
+draw a very dark or a very bright background hue.
+
+Widgets use the new color symbols <tt>FL_FORGROUND_COLOR</tt>,
+<tt>FL_BACKGROUND_COLOR</tt>, <tt>FL_BACKGROUND2_COLOR</tt>,
+<tt>FL_INACTIVE_COLOR</tt>, and <tt>FL_SELECTION_COLOR</tt>.
+More details can be found in the chapter
+<A HREF="enumerations.html#colors">Enumerations</A>.
+
+\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 <tt>FCB</tt> class or members will need
+to be ported to the new
+<A HREF="Fl_File_Chooser.html"><tt>Fl_File_Chooser</tt></A>
+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 <tt>FLTK_1_0_COMPAT</tt>
+symbol on the command-line when you compile
+(<tt>-DFLTK_1_0_COMPAT</tt>) or in your source, e.g.:
+
+\code
+#define FLTK_1_0_COMPAT
+#include <FL/Fl.H>
+#include <FL/Enumerations.H>
+#include <FL/filename.H>
+\endcode
+
+The following table shows the old and new function names:
+
+<CENTER>
+<TABLE WIDTH="80%" BORDER="1">
+<TR>
+ <TH>Old 1.0.x Name</TH>
+ <TH>New 1.1.x Name</TH>
+</TR>
+<TR>
+ <TD>contrast()</TD>
+ <TD>fl_contrast()</TD>
+</TR>
+<TR>
+ <TD>down()</TD>
+ <TD>fl_down()</TD>
+</TR>
+<TR>
+ <TD>filename_absolute()</TD>
+ <TD>fl_filename_absolute()</TD>
+</TR>
+<TR>
+ <TD>filename_expand()</TD>
+ <TD>fl_filename_expand()</TD>
+</TR>
+<TR>
+ <TD>filename_ext()</TD>
+ <TD>fl_filename_ext()</TD>
+</TR>
+<TR>
+ <TD>filename_isdir()</TD>
+ <TD>fl_filename_isdir()</TD>
+</TR>
+<TR>
+ <TD>filename_list()</TD>
+ <TD>fl_filename_list()</TD>
+</TR>
+<TR>
+ <TD>filename_match()</TD>
+ <TD>fl_filename_match()</TD>
+</TR>
+<TR>
+ <TD>filename_name()</TD>
+ <TD>fl_filename_name()</TD>
+</TR>
+<TR>
+ <TD>filename_relative()</TD>
+ <TD>fl_filename_relative()</TD>
+</TR>
+<TR>
+ <TD>filename_setext()</TD>
+ <TD>fl_filename_setext()</TD>
+</TR>
+<TR>
+ <TD>frame()</TD>
+ <TD>fl_frame()</TD>
+</TR>
+<TR>
+ <TD>inactive()</TD>
+ <TD>fl_inactive()</TD>
+</TR>
+<TR>
+ <TD>numericsort()</TD>
+ <TD>fl_numericsort()</TD>
+</TR>
+</TABLE>
+</CENTER>
+
+\section migration_1_1_images Image Support
+
+Image support in FLTK has been significantly revamped in
+1.1.x. The <A HREF="Fl_Image.html"><tt>Fl_Image</tt></A> class
+is now a proper base class, with the core image drawing
+functionality in the
+<A HREF="Fl_Bitmap.html"><tt>Fl_Bitmap</tt></A>,
+<A HREF="Fl_Pixmap.html"><tt>Fl_Pixmap</tt></A>,
+and
+<A HREF="Fl_RGB_Image.html"><tt>Fl_RGB_Image</tt></A>
+classes.
+
+BMP, GIF, JPEG, PNG, XBM, and XPM image files can now be
+loaded using the appropriate image classes, and the
+<A HREF="Fl_Shared_Image.html"><tt>Fl_Shared_Image</tt></A>
+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 <tt>label()</tt> methods on an image, the
+widget's <tt>image()</tt> 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
+<A HREF="Fl.html#Fl.visible_focus"><CODE>Fl::visible_focus()</CODE></A>
+method to disable it:
+
+\code
+Fl::visible_focus(0);
+\endcode
+
+\htmlonly
+<hr>
+<a class="el" href="index.html">[Index]</a> &nbsp;&nbsp;
+<a class="el" href="osissues.html">[Previous]</a>&nbsp;
+ \ref osissues &nbsp;&nbsp;
+<a class="el" href="migration_1_3.html">[Next]</a>&nbsp;
+ \ref migration_1_3
+
+\endhtmlonly
+*/