From 216ddd09c9255597ddb3a4cc8005dc94ad6878c1 Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Fri, 28 Jun 2024 13:47:33 +0200 Subject: [PATCH] Update documentation --- documentation/src/drawing.dox | 2 +- documentation/src/examples.dox | 44 +++++++++++++++++++++------------- documentation/src/forms.dox | 29 ++++++++++++++-------- 3 files changed, 48 insertions(+), 27 deletions(-) diff --git a/documentation/src/drawing.dox b/documentation/src/drawing.dox index 9fd2c5650..b2fe19e5f 100644 --- a/documentation/src/drawing.dox +++ b/documentation/src/drawing.dox @@ -409,7 +409,7 @@ used up to FLTK 1.3.x. You can use fl_contrast_mode(FL_CONTRAST_LEGACY); early in your program to select the old behavior if you really need strict backwards -compatibility but this is discouraged because the new algorithm is much better with +compatibility. This is discouraged because the new algorithm is much better with regard to human contrast perception. The default mode since FLTK 1.4.0 is fl_contrast_mode(FL_CONTRAST_CIELAB); diff --git a/documentation/src/examples.dox b/documentation/src/examples.dox index 992b85523..6c02ccc0f 100644 --- a/documentation/src/examples.dox +++ b/documentation/src/examples.dox @@ -36,86 +36,87 @@ you build FLTK, unlike those in the 'test' directory shown below. \ref examples_checkers + \ref examples_clipboard \ref examples_clock \ref examples_colbrowser \ref examples_color_chooser \ref examples_cube \ref examples_CubeView - \ref examples_cursor + \ref examples_cursor \ref examples_curve \ref examples_demo \ref examples_device \ref examples_doublebuffer \ref examples_editor - \ref examples_fast_slow + \ref examples_fast_slow \ref examples_file_chooser \ref examples_fluid \ref examples_fonts \ref examples_forms \ref examples_fractals - \ref examples_fullscreen + \ref examples_fullscreen \ref examples_gl_overlay \ref examples_glpuzzle \ref examples_hello \ref examples_help_dialog \ref examples_icon - \ref examples_iconize + \ref examples_iconize \ref examples_image \ref examples_inactive \ref examples_input \ref examples_input_choice \ref examples_keyboard - \ref examples_label + \ref examples_label \ref examples_line_style \ref examples_list_visuals \ref examples_mandelbrot \ref examples_menubar \ref examples_message - \ref examples_minimum + \ref examples_minimum \ref examples_native-filechooser \ref examples_navigation \ref examples_offscreen \ref examples_output \ref examples_overlay - \ref examples_pack + \ref examples_pack \ref examples_pixmap \ref examples_pixmap_browser \ref examples_preferences \ref examples_radio \ref examples_resize - \ref examples_resizebox + \ref examples_resizebox \ref examples_rotated_text \ref examples_scroll \ref examples_shape \ref examples_subwindow \ref examples_sudoku - \ref examples_symbols + \ref examples_symbols \ref examples_table \ref examples_tabs \ref examples_threads \ref examples_tile \ref examples_tiled_image - \ref examples_tree + \ref examples_tree \ref examples_twowin \ref examples_unittests \ref examples_utf8 @@ -204,7 +205,8 @@ The \c button test is a simple demo of push-buttons and callbacks. \par \c cairo_test shows a sample of drawing with Cairo in an Fl_Cairo_Window. -This program can only be built if FLTK was configured with Cairo support. +This program can only be built completely if FLTK was configured with Cairo +support. It displays a message box if Cairo support was not included. \subsection examples_checkers checkers @@ -217,6 +219,16 @@ pieces, and how the pieces are drawn by layering. Then tell me how to beat the computer at Checkers. +\subsection examples_clipboard clipboard + +\par +The \c clipboard demo can be used to view the contents of the +system clipboard, either text or image contents. Currently an +image is preferred if the clipboard contains both formats. +Images can be stored as PNG files so screenshots can be +stored on disk with this little FLTK demo program. + + \subsection examples_clock clock \par @@ -273,9 +285,8 @@ on few systems (some version of Irix for example). \subsection examples_demo demo \par -This tool allows quick access to all programs in the \c test directory. -\c demo is based on the visuals of the IrixGL demo program. The menu -tree can be changed by editing test/demo.menu. +This tool allows quick access to most programs in the \c test directory. +The menu tree can be changed by editing test/demo.menu. \subsection examples_device device @@ -283,9 +294,9 @@ tree can be changed by editing test/demo.menu. \par Exercises the Fl_Image_Surface, Fl_Copy_Surface, and Fl_Printer classes to draw to an Fl_Image object, copy graphical data to the clipboard, and for print support. -\note The clipboard.cxx program of the 'examples' directory is a clipboard watching +\note The clipboard.cxx program of the 'test' directory is a clipboard watching application that continuously displays the textual or graphical content of the system -clipboard (a.k.a pasteboard on Mac OS X) exercising Fl::paste(). +clipboard (a.k.a pasteboard on macOS) exercising Fl::paste(). \subsection examples_doublebuffer doublebuffer @@ -307,6 +318,7 @@ and derived classes are rather light weight, however Fl_Text_Editor is a complete port of nedit (with permission). The \c editor test is almost a full application, showing custom syntax highlighting and dialog creation. +See chapter \ref editor for a tutorial about creating this program. \subsection examples_fast_slow fast_slow diff --git a/documentation/src/forms.dox b/documentation/src/forms.dox index 1aa1571d5..816da55e6 100644 --- a/documentation/src/forms.dox +++ b/documentation/src/forms.dox @@ -5,16 +5,25 @@ This appendix describes the Forms compatibility included with FLTK. -
- - - - -
-Warning: The Forms compatibility is deprecated and no longer maintained -since FLTK 1.3.0 and is likely to be removed completely in FLTK 1.4 or 1.5 -
-
+\note The Forms compatibility library is deprecated, no longer actively + maintained since FLTK 1.3.0, and likely to be removed completely + in FLTK 1.5. + +Since FLTK 1.4 building the Forms compatibility library \c fltk_forms +(configure/Makefiles) or \c fltk::forms (CMake) can be disabled with +one of these commands: + \code + - ./configure --disable-forms ... + - cmake -D FLTK_BUILD_FORMS:BOOL=OFF ... + - cmake-gui ... + \endcode + +Fluid can still import Forms and XForms designer (.fd) files but w/o +any guarantees for working results. Manual fixes may be necessary. + +In the next minor or major release (1.5 or higher) the Forms compatibility +library will not be built by default or will be removed entirely. + \section forms_importing Importing Forms Layout Files