From d7af409f426fba1790149499dd26614b137a771a Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Wed, 13 Jan 2021 22:05:36 +0100 Subject: Remove "Figure x.y: " from html image captions ... as discussed in fltk.coredev for easier maintenance. Also edit some minor issues. --- documentation/src/common.dox | 20 ++++++++++---------- documentation/src/drawing.dox | 11 +++++------ documentation/src/editor.dox | 6 +++--- documentation/src/examples.dox | 6 +++--- documentation/src/fluid.dox | 30 +++++++++++++++--------------- documentation/src/resize.dox | 14 +++++++------- 6 files changed, 43 insertions(+), 44 deletions(-) (limited to 'documentation') diff --git a/documentation/src/common.dox b/documentation/src/common.dox index 96880b661..4950065a5 100644 --- a/documentation/src/common.dox +++ b/documentation/src/common.dox @@ -23,7 +23,7 @@ FLTK provides many types of buttons: \li Fl_Round_Button - A button with a radio circle. -\image html buttons.png "Figure 5.1: FLTK Button Widgets" +\image html buttons.png "FLTK Button Widgets" \image latex buttons.png "FLTK Button Widgets" width=10cm All of these buttons just need the corresponding @@ -110,7 +110,7 @@ strings. FLTK provides the following valuators: \li Fl_Value_Slider - A slider that shows the current value. -\image html valuators.png "Figure 5.2: FLTK valuator widgets" +\image html valuators.png "FLTK valuator widgets" \image latex valuators.png "FLTK valuator widgets" width=10cm The \p value() method gets and sets the current value @@ -249,15 +249,15 @@ the nearest entry in the colormap. The type Fl_Boxtype stored and returned in Fl_Widget::box() is an enumeration defined in Enumerations.H. -Figure 5.3 shows the standard box types included with FLTK. +These are the standard box types included with FLTK: -\image html boxtypes.png "Figure 5.3: FLTK box types" -\image latex boxtypes.png "FLTK box types" width=12cm +\image html boxtypes.png "FLTK Standard Box Types" +\image latex boxtypes.png "FLTK Standard Box Types" width=12cm \p 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. The blue color in -Figure 5.3 is the area that is not drawn by the frame types. +the image above is the area that is not drawn by the frame types. \subsection common_custom_boxtypes Making Your Own Boxtypes @@ -350,10 +350,10 @@ labeling of widgets. The \p 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 5.4 shows the available symbols. +escaping them using the "@" symbol - "@@" displays a single at sign. +These are the available symbols: -\image html symbols.png "Figure 5.4: FLTK label symbols" +\image html symbols.png "FLTK label symbols" \image latex symbols.png "FLTK label symbols" width=10cm @@ -379,7 +379,7 @@ Symbols and text can be combined in a label, however the symbol must be at the beginning and/or at the end of the text. If the text spans multiple lines, the symbol or symbols will scale up to match the height of all the lines. -\image html symbol-examples.png "Figure 5.5: FLTK symbols and text" +\image html symbol-examples.png "FLTK symbols and text" \image latex symbol-examples.png "FLTK symbols and text" width=10cm diff --git a/documentation/src/drawing.dox b/documentation/src/drawing.dox index c6b7e1e0f..84747fa03 100644 --- a/documentation/src/drawing.dox +++ b/documentation/src/drawing.dox @@ -245,10 +245,9 @@ If these bytes are zero, the "I" byte will be used as an index into the colormap. Colors with both "RGB" set and an "I" >0 are reserved for special use. -Values from 0 to 255, i.e. the "I" index value, represent -colors from the FLTK 1.3.x standard colormap -and are allocated as needed on screens without TrueColor support. -The \b Fl_Color enumeration type defines the +Values from 0 to 255, i.e. the "I" index value, represent colors from the +FLTK standard colormap and are allocated as needed on screens without +TrueColor support. The \b Fl_Color enumeration type defines the standard colors and color cube for the first 256 colors. All of these are named with symbols in \ref enumerations "". Example: @@ -834,8 +833,8 @@ Returns the face and size set by the most recent call to \subsection drawing_character_encoding Character Encoding -FLTK 1.3 expects all text in Unicode UTF-8 encoding. UTF-8 is -ASCII compatible for the first 128 characters. International +FLTK 1.3 and later versions expect all text in Unicode UTF-8 encoding. +UTF-8 is ASCII compatible for the first 128 characters. International characters are encoded in multibyte sequences. FLTK expects individual characters, characters that are not part of diff --git a/documentation/src/editor.dox b/documentation/src/editor.dox index 91123fc2c..9454adc4e 100644 --- a/documentation/src/editor.dox +++ b/documentation/src/editor.dox @@ -143,7 +143,7 @@ Fl_Input widgets, the "replace all" and the "replace next " button is a Fl_Return_Button widget: -\image html editor-replace.png "Figure 7.1: The search and replace dialog" +\image html editor-replace.png "The search and replace dialog" \image latex editor-replace.png "The search and replace dialog" width=10cm \code @@ -604,9 +604,9 @@ Congratulations, you've just built your own text editor! \section editor_final_product The Final Product -The final editor window should look like the image in Figure 7.2. +The final editor window should look like this: -\image html editor.png "Figure 7.2: The completed editor window" +\image html editor.png "The completed editor window" \image latex editor.png "The completed editor window" width=12cm \section editor_advanced_features Advanced Features diff --git a/documentation/src/examples.dox b/documentation/src/examples.dox index 0790ba7a5..0269f2c92 100644 --- a/documentation/src/examples.dox +++ b/documentation/src/examples.dox @@ -757,7 +757,7 @@ the display \b should look when running the example programs. The \c cairo_test demo program shows three shiny buttons drawn with Cairo in an Fl_Cairo_Window. - \image html cairo_test.png "Figure 22.1: Buttons drawn with Cairo" + \image html cairo_test.png "Buttons drawn with Cairo" \image latex cairo_test.png "Buttons drawn with Cairo" width=8cm @@ -767,7 +767,7 @@ in an Fl_Cairo_Window. The \c icon program lets you set the program icon from an image (here an Fl_RGB_Image). - \image html icon.png "Figure 22.2: Green icon (Windows 10)" + \image html icon.png "Green icon (Windows 10)" \image latex icon.png "Green icon (Windows 10)" width=6cm @@ -777,7 +777,7 @@ an Fl_RGB_Image). Select "drawing images" in the browser at the left side to see the image drawing example: - \image html unittest_images.png "Figure 22.3: Image Drawing" + \image html unittest_images.png "Image Drawing" \image latex unittest_images.png "Image Drawing" width=12cm diff --git a/documentation/src/fluid.dox b/documentation/src/fluid.dox index 25bc56c65..166685fc1 100644 --- a/documentation/src/fluid.dox +++ b/documentation/src/fluid.dox @@ -47,7 +47,7 @@ the .h file or they can \p \#include the .cxx file so it still appears to be a single source file. - \image html fluid-org.png "Figure 12.1: FLUID organization" + \image html fluid-org.png "FLUID organization" \image latex fluid-org.png "FLUID organization" width=12cm Normally the FLUID file defines one or more functions or classes which @@ -181,7 +181,7 @@ accomplish seemingly simple tasks with it. This tutorial will show you how to generate a complete user interface class with FLUID that is used for the CubeView program provided with FLTK. -\image html cubeview.png "Figure 12.2: CubeView demo" +\image html cubeview.png "CubeView demo" \image latex cubeview.png "CubeView demo" width=10cm The window is of class CubeViewUI, and is completely generated by FLUID, @@ -407,7 +407,7 @@ menu item. Name the class "CubeViewUI" and leave the subclass blank. We do not need any inheritance for this window. You should see the new class declaration in the FLUID browser window. -\image html fluid1.png "Figure 12.3: FLUID file for CubeView" +\image html fluid1.png "FLUID file for CubeView" \image latex fluid1.png "FLUID file for CubeView" width=10cm \par Adding the Class Constructor @@ -435,7 +435,7 @@ CubeViewUI. When you are finished you should have something like this: -\image html fluid2.png "Figure 12.4: FLUID window containing CubeView demo" +\image html fluid2.png "FLUID window containing CubeView demo" \image latex fluid2.png "FLUID window containing CubeView demo" width=10cm We will talk about the \p show() method that is highlighted @@ -463,7 +463,7 @@ This \p \#include is important, as we have just included CubeView as a member of CubeViewUI, so any public CubeView methods are now available to CubeViewUI. -\image html fluid3-cxx.png "Figure 12.5: CubeView methods" +\image html fluid3-cxx.png "CubeView methods" \image latex fluid3-cxx.png "CubeView methods" width=10cm \par Defining the Callbacks @@ -500,7 +500,7 @@ Make sure the top level CubeViewUI is selected and select not be adding any widgets to this method FLUID will assign it a return type of \p void. -\image html fluid4.png "Figure 12.6: CubeView constructor" +\image html fluid4.png "CubeView constructor" \image latex fluid4.png "CubeView constructor" width=10cm Once the new method has been added, highlight its name and select @@ -762,7 +762,7 @@ button the code file will include the header file automatically. Under the "Internationalization" tab are the \ref fluid_i18n "internationalization" options, described later in this chapter. -\image html fluid-edit-proj-settings.png "Figure 12.7: FLUID Project Settings Window" +\image html fluid-edit-proj-settings.png "FLUID Project Settings Window" \image latex fluid-edit-proj-settings.png "FLUID Project Settings Window" width=10cm \par Edit/GUI Settings... (Shift+Alt+p) @@ -770,7 +770,7 @@ options, described later in this chapter. \par Displays the GUI Settings panel, used to control the user interface settings. -\image html fluid-edit-gui-settings.png "Figure 12.8: FLUID GUI Settings Window" +\image html fluid-edit-gui-settings.png "FLUID GUI Settings Window" \image latex fluid-edit-gui-settings.png "FLUID GUI Settings Window" width=10cm \par Edit/Global FLTK Settings... (Shift+Alt+g) @@ -786,7 +786,7 @@ Tooltips provide descriptions of each option. At the lower-right, "User Settings" causes changes to only affect the current user, "System Settings" causes changes to be applied to all users on the current machine. -\image html fluid-edit-global-fltk-settings.png "Figure 12.9: FLUID Global Settings Window" +\image html fluid-edit-global-fltk-settings.png "FLUID Global Settings Window" \image latex fluid-edit-global-fltk-settings.png "FLUID Global Settings Window" width=10cm \par New/Code/Function @@ -875,7 +875,7 @@ This panel controls the grid that all widgets snap to when you move and resize them, and for the "snap" which is how far a widget has to be dragged from its original position to actually change. -\image html fluid-layout-grid-and-size-settings.png "Figure 12.10: FLUID Layout/Grid Settings Window" +\image html fluid-layout-grid-and-size-settings.png "FLUID Layout/Grid Settings Window" \image latex fluid-layout-grid-and-size-settings.png "FLUID Layout/Grid Settings Window" width=10cm \par Shell/Execute Command... (Alt+x) @@ -934,7 +934,7 @@ undone, however. -\image html fluid_widget_gui.png "Figure 12.11: The FLUID widget GUI attributes" +\image html fluid_widget_gui.png "The FLUID widget GUI attributes" \image latex fluid_widget_gui.png "The FLUID widget GUI attributes" width=10cm \section fluid_widget_attributes GUI Attributes @@ -1049,7 +1049,7 @@ as the class. This can change the icon or window decorations. On most (all?) window managers you will have to close the window and reopen it to see the effect. -\image html fluid_widget_style.png "Figure 12.12: The FLUID widget Style attributes" +\image html fluid_widget_style.png "The FLUID widget Style attributes" \image latex fluid_widget_style.png "The FLUID widget Style attributes" width=10cm \subsection fluid_style_attributes Style Attributes @@ -1120,7 +1120,7 @@ when they have the focus. Some widgets display text, such as input fields, pull-down menus, and browsers. -\image html fluid_widget_cxx.png "Figure 12.13: The FLUID widget C++ attributes" +\image html fluid_widget_cxx.png "The FLUID widget C++ attributes" \image latex fluid_widget_cxx.png "The FLUID widget C++ attributes" width=10cm \subsection fluid_cpp_attributes C++ Attributes @@ -1499,7 +1499,7 @@ fields will then appear to control the include file and function/macro name to use when retrieving the localized label strings. - \image html fluid-gettext.png "Figure 12.14: Internationalization using GNU gettext" + \image html fluid-gettext.png "Internationalization using GNU gettext" \image latex fluid-gettext.png "Internationalization using GNU gettext" width=10cm The \b \#include @@ -1524,7 +1524,7 @@ input fields will then appear to control the include file, catalog file, and set number for retrieving the localized label strings. - \image html fluid-catgets.png "Figure 12.15: Internationalization using POSIX catgets" + \image html fluid-catgets.png "Internationalization using POSIX catgets" \image latex fluid-catgets.png "Internationalization using POSIX catgets" width=10cm The \b \#include diff --git a/documentation/src/resize.dox b/documentation/src/resize.dox index 5eb5a23e0..348625cf9 100644 --- a/documentation/src/resize.dox +++ b/documentation/src/resize.dox @@ -52,7 +52,7 @@ If the group is stretched horizontally, the widths of the widgets within the group are adjusted proportionally. The same is true for vertical resizing. -\image html resize-example1.png "Figure 6.1: Proportional resizing example" +\image html resize-example1.png "Proportional resizing example" \image latex resize-example1.png "Proportional resizing example" width=12cm @@ -100,7 +100,7 @@ The resizing behavior is as follows: \li the widths and heights of the remaining widgets stay the same, i.e. the widgets marked A, D, I and L stay the same size. -\image html resize-example2.png "Figure 6.2: Complex resizing example" +\image html resize-example2.png "Complex resizing example" \image latex resize-example2.png "Complex resizing example" width=12cm @@ -120,7 +120,7 @@ be the \p resizable one? Setting the \p resizable to be the icon box won't give us what we want: -\image html resize-example3a.png "Figure 6.3: Resizing dialog example (a)" +\image html resize-example3a.png "Resizing dialog example (a)" \image latex resize-example3a.png "Resizing dialog example (a)" width=12cm The message text area would be the logical choice so that the user @@ -128,7 +128,7 @@ can expand the dialog to see if there is more of an explanation below the short error message. This results in the behaviour shown in the diagram below. -\image html resize-example3b.png "Figure 6.4: Resizing dialog example (b)" +\image html resize-example3b.png "Resizing dialog example (b)" \image latex resize-example3b.png "Resizing dialog example (b)" width=12cm The result is close to what we want, but not quite: @@ -141,7 +141,7 @@ That's ugly. How do we stop that from happening? Simple: put it in its own group and set the \p resizable to an invisible box widget, as shown in the diagram below. -\image html resize-example3c.png "Figure 6.5: Resizing dialog example (c)" +\image html resize-example3c.png "Resizing dialog example (c)" \image latex resize-example3c.png "Resizing dialog example (c)" width=12cm Now the invisible box, shown as "R", takes all of the @@ -170,7 +170,7 @@ How could you achieve this? Setting either of the input fields to be the \p resizable leaves the other one fixed, as shown below: -\image html resize-example4a.png "Figure 6.6: Resizing input fields example (a)" +\image html resize-example4a.png "Resizing input fields example (a)" \image latex resize-example4a.png "Resizing input fields example (b)" width=12cm The answer is to leave the \p resizable of the group set to itself, @@ -179,7 +179,7 @@ equally. Add a button and input field to each subgroup, and set each subgroup's \p resizable to the input field, as shown below. Tada! -\image html resize-example4b.png "Figure 6.7: Resizing input fields example (b)" +\image html resize-example4b.png "Resizing input fields example (b)" \image latex resize-example4b.png "Resizing inut fields example (b)" width=12cm In FLTK it is possible to solve almost any layout and resizing -- cgit v1.2.3