diff options
Diffstat (limited to 'documentation')
32 files changed, 474 insertions, 488 deletions
diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt index b27568bf4..66546cfa6 100644 --- a/documentation/CMakeLists.txt +++ b/documentation/CMakeLists.txt @@ -1,6 +1,4 @@ # -# "$Id$" -# # CMakeLists.txt to build docs for the FLTK project using CMake (www.cmake.org) # # Copyright 1998-2020 by Bill Spitzak and others. @@ -11,9 +9,9 @@ # # https://www.fltk.org/COPYING.php # -# Please report all bugs and problems on the following page: +# Please see the following page on how to report bugs and issues: # -# https://www.fltk.org/str.php +# https://www.fltk.org/bugs.php # set (DOCS) @@ -36,29 +34,29 @@ if (OPTION_BUILD_HTML_DOCUMENTATION) # generate Doxygen file "Doxyfile" - set(GENERATE_HTML YES) - set(GENERATE_LATEX NO) - set(LATEX_HEADER "") + set(GENERATE_HTML YES) + set(GENERATE_LATEX NO) + set(LATEX_HEADER "") configure_file( - ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in - ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile - @ONLY + ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in + ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + @ONLY ) configure_file( - ${CMAKE_CURRENT_SOURCE_DIR}/src/tiny.png - ${CMAKE_CURRENT_BINARY_DIR}/html/tiny.png - COPYONLY + ${CMAKE_CURRENT_SOURCE_DIR}/src/tiny.png + ${CMAKE_CURRENT_BINARY_DIR}/html/tiny.png + COPYONLY ) # generate html docs add_custom_target(html - # ALL - ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} - COMMENT "Generating HTML documentation" VERBATIM + # ALL + ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating HTML documentation" VERBATIM ) endif (OPTION_BUILD_HTML_DOCUMENTATION) @@ -73,14 +71,14 @@ if (OPTION_BUILD_PDF_DOCUMENTATION) # generate Doxygen file "Doxybook" - set(GENERATE_HTML NO) - set(GENERATE_LATEX YES) - set(LATEX_HEADER "${CMAKE_CURRENT_BINARY_DIR}/fltk-book.tex") + set(GENERATE_HTML NO) + set(GENERATE_LATEX YES) + set(LATEX_HEADER "${CMAKE_CURRENT_BINARY_DIR}/fltk-book.tex") configure_file( - ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in - ${CMAKE_CURRENT_BINARY_DIR}/Doxybook - @ONLY + ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in + ${CMAKE_CURRENT_BINARY_DIR}/Doxybook + @ONLY ) # generate LaTeX header fltk-book.tex @@ -88,30 +86,30 @@ if (OPTION_BUILD_PDF_DOCUMENTATION) set(FL_VERSION ${FLTK_VERSION_FULL}) set(DOXY_VERSION ${DOXYGEN_VERSION}) execute_process(COMMAND date +%Y - OUTPUT_VARIABLE YEAR + OUTPUT_VARIABLE YEAR ) configure_file(${CMAKE_CURRENT_SOURCE_DIR}/src/fltk-book.tex.in - ${CMAKE_CURRENT_BINARY_DIR}/fltk-book.tex - @ONLY + ${CMAKE_CURRENT_BINARY_DIR}/fltk-book.tex + @ONLY ) # generate fltk.pdf add_custom_command( - OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/fltk.pdf - COMMAND ${DOXYGEN_EXECUTABLE} Doxybook - COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/make_pdf - COMMAND cp -f latex/refman.pdf fltk.pdf - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} - COMMENT "Generating PDF documentation" VERBATIM + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/fltk.pdf + COMMAND ${DOXYGEN_EXECUTABLE} Doxybook + COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/make_pdf + COMMAND cp -f latex/refman.pdf fltk.pdf + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating PDF documentation" VERBATIM ) # add target 'pdf' add_custom_target(pdf - # ALL - DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/fltk.pdf + # ALL + DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/fltk.pdf ) endif(OPTION_BUILD_PDF_DOCUMENTATION) @@ -123,8 +121,8 @@ endif(OPTION_BUILD_PDF_DOCUMENTATION) if (DOCS) add_custom_target(docs - # ALL - DEPENDS ${DOCS} + # ALL + DEPENDS ${DOCS} ) endif (DOCS) @@ -136,7 +134,7 @@ endif (DOCS) if (OPTION_INSTALL_HTML_DOCUMENTATION AND OPTION_BUILD_HTML_DOCUMENTATION) install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html - DESTINATION ${FLTK_DATADIR}/doc/fltk + DESTINATION ${FLTK_DATADIR}/doc/fltk ) endif (OPTION_INSTALL_HTML_DOCUMENTATION AND OPTION_BUILD_HTML_DOCUMENTATION) @@ -144,7 +142,7 @@ endif (OPTION_INSTALL_HTML_DOCUMENTATION AND OPTION_BUILD_HTML_DOCUMENTATION) if (OPTION_INSTALL_PDF_DOCUMENTATION AND OPTION_BUILD_PDF_DOCUMENTATION) install(FILES ${CMAKE_CURRENT_BINARY_DIR}/fltk.pdf - DESTINATION ${FLTK_DATADIR}/doc/fltk/ + DESTINATION ${FLTK_DATADIR}/doc/fltk/ ) endif (OPTION_INSTALL_PDF_DOCUMENTATION AND OPTION_BUILD_PDF_DOCUMENTATION) diff --git a/documentation/Makefile b/documentation/Makefile index 97886ae03..0c03b8c56 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -1,6 +1,4 @@ # -# "$Id$" -# # Makefile for the Fast Light Tool Kit (FLTK) documentation. # # Copyright 1998-2020 by Bill Spitzak and others. @@ -9,11 +7,11 @@ # the file "COPYING" which should have been included with this file. If this # file is missing or damaged, see the license at: # -# http://www.fltk.org/COPYING.php +# https://www.fltk.org/COPYING.php # -# Please report all bugs and problems on the following page: +# Please see the following page on how to report bugs and issues: # -# http://www.fltk.org/str.php +# https://www.fltk.org/bugs.php # # Get configuration stuff... @@ -187,7 +185,3 @@ src/fltk-book.tex: src/fltk-book.tex.in -e"s/@FL_VERSION@/$(FL_VERSION)/g" \ -e"s/@DOXY_VERSION@/$$DOXY_VERSION/g" \ < $< > $@ - -# -# End of "$Id$". -# diff --git a/documentation/README.txt b/documentation/README.txt index 6b7e39980..f144bc68b 100644 --- a/documentation/README.txt +++ b/documentation/README.txt @@ -71,8 +71,8 @@ more CMake options using cmake-gui, ccmake, or cmake -DOPTION... These options are predefined to OFF and can be switched ON: - - OPTION_BUILD_HTML_DOCUMENTATION:BOOL=OFF target: html - - OPTION_BUILD_PDF_DOCUMENTATION:BOOL=OFF target: pdf + - OPTION_BUILD_HTML_DOCUMENTATION:BOOL=OFF target: html + - OPTION_BUILD_PDF_DOCUMENTATION:BOOL=OFF target: pdf - OPTION_INSTALL_HTML_DOCUMENTATION:BOOL=OFF - OPTION_INSTALL_PDF_DOCUMENTATION:BOOL=OFF @@ -106,7 +106,7 @@ Bugs and Feature Requests: -------------------------- If you find any typos, things that are unclear, or would like to contribute an example, section, or chapter to the FLTK manual, please -post a question in the fltk newsgroup fltk.general or post a bug -report or feature request at: +post a question in the fltk group fltk.general or post a bug +report or feature request. For more information see this page: - https://www.fltk.org/str.php + https://www.fltk.org/bugs.php diff --git a/documentation/make_pdf b/documentation/make_pdf index dd8894895..7580cb1d8 100755 --- a/documentation/make_pdf +++ b/documentation/make_pdf @@ -1,7 +1,5 @@ #! /bin/sh # -# $Id$ -# # Makefile helper script for the Fast Light Tool Kit (FLTK) documentation. # # Copyright 1998-2015 by Bill Spitzak and others. @@ -10,11 +8,11 @@ # the file "COPYING" which should have been included with this file. If this # file is missing or damaged, see the license at: # -# http://www.fltk.org/COPYING.php +# https://www.fltk.org/COPYING.php # -# Please report all bugs and problems on the following page: +# Please see the following page on how to report bugs and issues: # -# http://www.fltk.org/str.php +# https://www.fltk.org/bugs.php # # This script generates latex/refman.pdf after doxygen has been executed. @@ -41,7 +39,3 @@ latex_count=`expr $latex_count - 1` done cd ..) > pdfall.log 2>&1 - -# -# End of "$Id$". -# diff --git a/documentation/src/basics.dox b/documentation/src/basics.dox index 97cdb53ea..2b839c322 100644 --- a/documentation/src/basics.dox +++ b/documentation/src/basics.dox @@ -1,7 +1,7 @@ /** \page basics FLTK Basics - + This chapter teaches you the basics of compiling programs that use FLTK. @@ -104,22 +104,22 @@ copy of it - it just uses the pointer. \subsection basics_hierarchies Creating Widget hierarchies -Widgets are commonly ordered into functional groups, which -in turn may be grouped again, creating a hierarchy of widgets. -FLTK makes it easy to fill groups by automatically adding all widgets +Widgets are commonly ordered into functional groups, which +in turn may be grouped again, creating a hierarchy of widgets. +FLTK makes it easy to fill groups by automatically adding all widgets that are created between a <tt>myGroup->begin()</tt> -and +and <tt>myGroup->end()</tt>. In this example, \p myGroup would be the \e current group. Newly created groups and their derived widgets implicitly call -\p begin() in the constructor, effectively adding all +\p begin() in the constructor, effectively adding all subsequently created widgets to itself until \p end() is called. Setting the current group to \p NULL will stop automatic -hierarchies. New widgets can now be added manually using +hierarchies. New widgets can now be added manually using <tt>Fl_Group::add(...)</tt> and <tt>Fl_Group::insert(...)</tt>. @@ -208,7 +208,7 @@ write, or when an error condition occurs on a file. They are most often used to monitor network connections (sockets) for data-driven displays. -FLTK applications must periodically check (Fl::check()) +FLTK applications must periodically check (Fl::check()) or wait (Fl::wait()) for events or use the Fl::run() method to enter a standard event processing loop. Calling Fl::run() is equivalent to the following code: @@ -310,10 +310,10 @@ SRCS = CubeMain.cxx CubeView.cxx CubeViewUI.cxx .SUFFIXES: .o .cxx %.o: %.cxx - $(CXX) $(CXXFLAGS) $(DEBUG) -c $< + $(CXX) $(CXXFLAGS) $(DEBUG) -c $< all: $(TARGET) - $(LINK) -o $(TARGET) $(OBJS) $(LDSTATIC) + $(LINK) -o $(TARGET) $(OBJS) $(LDSTATIC) $(TARGET): $(OBJS) CubeMain.o: CubeMain.cxx CubeViewUI.h @@ -321,16 +321,16 @@ CubeView.o: CubeView.cxx CubeView.h CubeViewUI.h CubeViewUI.o: CubeViewUI.cxx CubeView.h clean: $(TARGET) $(OBJS) - rm -f *.o 2> /dev/null - rm -f $(TARGET) 2> /dev/null + rm -f *.o 2> /dev/null + rm -f $(TARGET) 2> /dev/null \endcode \section basics_visual_cpp Compiling Programs with Microsoft Visual C++ In Visual C++ you will need to tell the compiler where to find the FLTK header files. This can be done by selecting -"Settings" from the "Project" menu and then changing the -"Preprocessor" settings under the "C/C++" tab. You will also +"Settings" from the "Project" menu and then changing the +"Preprocessor" settings under the "C/C++" tab. You will also need to add the FLTK (<tt>FLTK.LIB</tt> or <tt>FLTKD.LIB</tt>) and the Windows Common Controls (<tt>COMCTL32.LIB</tt>) libraries to the "Link" settings. diff --git a/documentation/src/blocks.man b/documentation/src/blocks.man index 920300708..18f263d42 100644 --- a/documentation/src/blocks.man +++ b/documentation/src/blocks.man @@ -21,6 +21,6 @@ Press the spacebar to pause the game. .SH SEE ALSO fltk(3) .br -FLTK Web Site, http://www.fltk.org/ +FLTK Web Site, https://www.fltk.org/ .SH AUTHOR Michael R Sweet. diff --git a/documentation/src/checkers.man b/documentation/src/checkers.man index 097277474..927f22c1c 100644 --- a/documentation/src/checkers.man +++ b/documentation/src/checkers.man @@ -19,6 +19,6 @@ to a "king" which can move both forwards and backwards. .SH SEE ALSO fltk(3) .br -FLTK Web Site, http://www.fltk.org/ +FLTK Web Site, https://www.fltk.org/ .SH AUTHORS Bill Spitzak and others. diff --git a/documentation/src/common.dox b/documentation/src/common.dox index 70cbe8901..2c586a352 100644 --- a/documentation/src/common.dox +++ b/documentation/src/common.dox @@ -1,6 +1,6 @@ /** - \page common Common Widgets and Attributes + \page common Common Widgets and Attributes This chapter describes many of the widgets that are provided with FLTK and covers how to query and set the standard @@ -46,10 +46,10 @@ lbutton->type(FL_TOGGLE_BUTTON); rbutton->type(FL_RADIO_BUTTON); \endcode -For toggle and radio buttons, the \p value() method returns +For toggle and radio buttons, the \p value() method returns the current button state (0 = off, 1 = on). The \p set() and -\p clear() methods can be used on toggle buttons to turn a -toggle button on or off, respectively. +\p clear() methods can be used on toggle buttons to turn a +toggle button on or off, respectively. Radio buttons can be turned on with the \p setonly() method; this will also turn off other radio buttons in the same group. @@ -64,7 +64,7 @@ FLTK provides several text widgets for displaying and receiving text: \li Fl_Multiline_Input - A multi-line text input field. -\li Fl_Multiline_Output - A multi-line text output field. +\li Fl_Multiline_Output - A multi-line text output field. \li Fl_Text_Display - A multi-line text display widget. @@ -76,7 +76,7 @@ The Fl_Output and Fl_Multiline_Output widgets allow the user to copy text from the output field but not change it. -The \p value() method is used to get or set the +The \p value() method is used to get or set the string that is displayed: \code @@ -113,7 +113,7 @@ strings. FLTK provides the following valuators: \image html valuators.png "Figure 3-2: FLTK valuator widgets" \image latex valuators.png "FLTK valuator widgets" width=10cm -The \p value() method gets and sets the current value +The \p value() method gets and sets the current value of the widget. The \p minimum() and \p maximum() methods set the range of values that are reported by the widget. @@ -329,14 +329,14 @@ The last 4 arguments to Fl::set_boxtype() are the offsets for the \p x, \p y, \p width, and \p height values that should be subtracted when drawing the label inside the box. -A complete box design contains four box types in this order: +A complete box design contains four box types in this order: a filled, neutral box (<tt>UP_BOX</tt>), a filled, depressed box (<tt>DOWN_BOX</tt>), and the same as outlines only (<tt>UP_FRAME</tt> and <tt>DOWN_FRAME</tt>). The function \ref common_fl_down "fl_down(Fl_Boxtype)" -expects the neutral design on a boxtype with a numerical -value evenly dividable by two. +expects the neutral design on a boxtype with a numerical +value evenly dividable by two. \ref common_fl_frame "fl_frame(Fl_Boxtype)" expects the \p UP_BOX design at a value dividable by four. @@ -507,7 +507,7 @@ It is also possible to define your own drawings and add them to the symbol list, so they can be rendered as part of any label. -To create a new symbol, you implement a drawing function +To create a new symbol, you implement a drawing function <tt>void drawit(Fl_Color c)</tt> which typically uses the functions described in \ref ssect_Complex to generate a vector shape inside a two-by-two units sized box @@ -567,28 +567,28 @@ button->when(FL_WHEN_CHANGED | FL_WHEN_NOT_CHANGED); <CENTER><TABLE WIDTH="80%" BORDER="1" CELLPADDING="5" CELLSPACING="0" BGCOLOR="#cccccc"> <TR> - <TD><B>Note:</B> + <TD><B>Note:</B> - You cannot delete a widget inside a callback, as the - widget may still be accessed by FLTK after your callback - is completed. Instead, use the Fl::delete_widget() - method to mark your widget for deletion when it is safe - to do so. + You cannot delete a widget inside a callback, as the + widget may still be accessed by FLTK after your callback + is completed. Instead, use the Fl::delete_widget() + method to mark your widget for deletion when it is safe + to do so. - <B>Hint:</B> + <B>Hint:</B> - Many programmers new to FLTK or C++ try to use a - non-static class method instead of a static class method - or function for their callback. Since callbacks are done - outside a C++ class, the <tt>this</tt> pointer is not - initialized for class methods. + Many programmers new to FLTK or C++ try to use a + non-static class method instead of a static class method + or function for their callback. Since callbacks are done + outside a C++ class, the <tt>this</tt> pointer is not + initialized for class methods. - To work around this problem, define a static method - in your class that accepts a pointer to the class, and - then have the static method call the class method(s) as - needed. The data pointer you provide to the - \p callback() method of the widget can be a - pointer to the instance of your class. + To work around this problem, define a static method + in your class that accepts a pointer to the class, and + then have the static method call the class method(s) as + needed. The data pointer you provide to the + \p callback() method of the widget can be a + pointer to the instance of your class. \code class Foo { @@ -601,7 +601,7 @@ class Foo { w->callback(my_static_callback, (void *)this); \endcode - </TD> + </TD> </TR> </TABLE></CENTER> diff --git a/documentation/src/development.dox b/documentation/src/development.dox index 13808e6a6..071db9263 100644 --- a/documentation/src/development.dox +++ b/documentation/src/development.dox @@ -15,14 +15,14 @@ This chapter describes FLTK development and documentation. /** \class Fl_Clock_Output \brief This widget can be used to display a program-supplied time. - + The time shown on the clock is not updated. To display the current time, use Fl_Clock instead. - \image html clock.png - \image latex clock.png "" width=10cm + \image html clock.png + \image latex clock.png "" width=10cm \image html round_clock.png - \image latex clock.png "" width=10cm + \image latex clock.png "" width=10cm \image html round_clock.png "" width=10cm */ /** @@ -163,10 +163,10 @@ Alternatively you can use \b UTF-8 encoding within Doxygen comments. \section development_structure Document Structure - \li \b \\page creates a named page - \li \b \\section creates a named section within that page - \li \b \\subsection creates a named subsection within the current section - \li \b \\subsubsection creates a named subsubsection within the current subsection + \li \b \\page creates a named page + \li \b \\section creates a named section within that page + \li \b \\subsection creates a named subsection within the current section + \li \b \\subsubsection creates a named subsubsection within the current subsection All these statements take a "name" as their first argument, and a title as their second argument. The title can contain spaces. @@ -176,7 +176,7 @@ a size like \b "<H1>", \b "<H2>", and \b "<H3>", and \b "<H4>", respectively. By <b>FLTK documentation convention</b>, a file like this one with a doxygen documentation chapter has the name <b>"<chapter>.dox".</b> -The \b \\page statement at the top of the page is +The \b \\page statement at the top of the page is <b>"\page <chapter> This is the title"</b>. Sections within a documentation page must be called \b "<chapter>_<section>", where \b "<chapter>" is the name part of the file, and \b "<section>" is a @@ -190,18 +190,18 @@ links \b from normal (e.g. class) documentation \b to documentation sections This page has \code - \page development I - Developer Information + \page development I - Developer Information \endcode at its top. This section is \code - \section development_structure Document Structure + \section development_structure Document Structure \endcode The following section is \code - \section development_links Creating Links + \section development_links Creating Links \endcode diff --git a/documentation/src/drawing.dox b/documentation/src/drawing.dox index d49518a5f..4e12affb2 100644 --- a/documentation/src/drawing.dox +++ b/documentation/src/drawing.dox @@ -1,12 +1,12 @@ /** - \page drawing Drawing Things in FLTK + \page drawing Drawing Things in FLTK This chapter covers the drawing functions that are provided with FLTK. \section sect_WhenCanYouDraw When Can You Draw Things in FLTK? -There are only certain places you can execute FLTK code +There are only certain places you can execute FLTK code that draws to the computer's display. Calling these functions at other places will result in undefined behavior! @@ -22,16 +22,16 @@ Calling these functions at other places will result in undefined behavior! \li You can call Fl_Window::make_current() to do incremental update of a widget. Use Fl_Widget::window() to find the window. - + In contrast, code that draws to other drawing surfaces than the display -(i.e., instances of derived classes of the Fl_Surface_Device class, except -Fl_Display_Device, such as Fl_Printer and Fl_Copy_Surface) can be executed +(i.e., instances of derived classes of the Fl_Surface_Device class, except +Fl_Display_Device, such as Fl_Printer and Fl_Copy_Surface) can be executed at any time as follows: -<ol><li> Make your surface the new current drawing surface calling the +<ol><li> Make your surface the new current drawing surface calling the Fl_Surface_Device::push_current(Fl_Surface_Device*) function. <li> Make a series of calls to any of the drawing functions described below; these will operate on the new current drawing surface; -<li> Set the current drawing surface back to its previous state calling +<li> Set the current drawing surface back to its previous state calling Fl_Surface_Device::pop_current(). </ol> @@ -162,7 +162,7 @@ is the order of the line segments: \par Note that -\ref common_fl_frame "fl_frame(Fl_Boxtype b)" +\ref common_fl_frame "fl_frame(Fl_Boxtype b)" is described in the \ref common_boxtypes section. @@ -231,7 +231,7 @@ Fl_Region fl_clip_region() \par Replace the top of the clip stack with a clipping region of any shape. -Fl_Region is an operating system specific type. The second form returns +Fl_Region is an operating system specific type. The second form returns the current clipping region. @@ -529,8 +529,8 @@ use \p w-1 and \p h-1. void \ref fl_scroll(int X, int Y, int W, int H, int dx, int dy, void (*draw_area)(void*, int,int,int,int), void* data) \par Scroll a rectangle and draw the newly exposed portions. The contents -of the rectangular area is first shifted by \p dx and -\p dy \ref ssect_DrawingUnit "FLTK units". The callback is then called for every newly +of the rectangular area is first shifted by \p dx and +\p dy \ref ssect_DrawingUnit "FLTK units". The callback is then called for every newly exposed rectangular area, @@ -613,7 +613,7 @@ the path. It is unnecessary but harmless to call or several times in a row. \par -\p %fl_gap() should only be called between +\p %fl_gap() should only be called between \p %fl_begin_complex_polygon() and \p %fl_end_complex_polygon(). To outline the polygon, use @@ -687,13 +687,13 @@ the baseline of the font. To align to the bottom, subtract \p %fl_descent() from \p y. To align to the top, subtract \p %fl_descent() and add \p %fl_height(). This version of \p %fl_draw() provides direct access to -the text drawing function of the underlying OS. It does not apply any -special handling to control characters. +the text drawing function of the underlying OS. It does not apply any +special handling to control characters. void fl_rtl_draw(const char *str, int n, int x, int y) \par -Draw a UTF-8 string of length n bytes right to left starting at the given x, y location. +Draw a UTF-8 string of length n bytes right to left starting at the given x, y location. void fl_draw(const char* str, int x, int y, int w, int h, Fl_Align align, Fl_Image* img, int draw_symbols) @@ -769,7 +769,7 @@ ie. the 'inked area'. Given a string "txt" drawn using fl_draw(txt, x, y) you would determine its extents in \ref ssect_DrawingUnit "FLTK units" on the display using fl_text_extents(txt, dx, dy, wo, ho) such that a bounding box that exactly fits around the inked area of the text -could be drawn with fl_rect(x+dx, y+dy, wo, ho). +could be drawn with fl_rect(x+dx, y+dy, wo, ho). \par Refer to the full documentation for fl_text_extents() for details on usage. @@ -833,21 +833,21 @@ Returns the face and size set by the most recent call to \subsection ssect_CharacterEncoding Character Encoding -FLTK 1.3 expects 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 1.3 expects 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 -a string, in UCS-4 encoding, which is also ASCII compatible, but +FLTK expects individual characters, characters that are not part of +a string, in UCS-4 encoding, which is also ASCII compatible, but requires 4 bytes to store a Unicode character. FLTK can draw accurately any Unicode-supported script for which the system contains relevant fonts. Under X11 platforms, this requires -to build the library with the OPTION_USE_PANGO CMake option turned On +to build the library with the OPTION_USE_PANGO CMake option turned On (or with configure --enable-pango). Plain text drawing starting at a user-given coordinate -is well supported by FLTK, including for right-to-left scripts. +is well supported by FLTK, including for right-to-left scripts. Further text-related operations (i.e., selection, formatting, input, and editing) are functional with left-to-right scripts only. @@ -917,7 +917,7 @@ or negative to flip the image vertically. \par It is highly recommended that you put the following code before the first show() of \e any window in your program to get rid -of the dithering if possible: +of the dithering if possible: \code Fl::visual(FL_RGB); @@ -1039,7 +1039,7 @@ for widgets using the \p image() and \p deimage() methods or drawn directly. Images can be drawn scaled to any size, independently from the size of the image's data (see Fl_Image::scale()). -The Fl_Image class does almost nothing by itself, but is instead +The Fl_Image class does almost nothing by itself, but is instead supported by three basic image types: \li Fl_Bitmap @@ -1054,29 +1054,29 @@ The Fl_Pixmap class encapsulates a colormapped image. The \p draw() method draws the image using the colors in the file, and masks off any transparent colors automatically. -The Fl_RGB_Image class encapsulates a full-color -(or grayscale) image with 1 to 4 color components. Images with -an even number of components are assumed to contain an -alpha channel that is used for transparency. The transparency -provided by the draw() method is either a 24-bit -blend against the existing window contents or a "screen door" -transparency mask, depending on the platform and screen color depth. +The Fl_RGB_Image class encapsulates a full-color +(or grayscale) image with 1 to 4 color components. Images with +an even number of components are assumed to contain an +alpha channel that is used for transparency. The transparency +provided by the draw() method is either a 24-bit +blend against the existing window contents or a "screen door" +transparency mask, depending on the platform and screen color depth. char fl_can_do_alpha_blending() \par \p %fl_can_do_alpha_blending() will return 1, if your -platform supports true alpha blending for RGBA images, or 0, +platform supports true alpha blending for RGBA images, or 0, if FLTK will use screen door transparency. FLTK also provides several image classes based on the three standard image types for common file formats: -\li Fl_GIF_Image -\li Fl_JPEG_Image -\li Fl_PNG_Image -\li Fl_PNM_Image -\li Fl_XBM_Image +\li Fl_GIF_Image +\li Fl_JPEG_Image +\li Fl_PNG_Image +\li Fl_PNM_Image +\li Fl_XBM_Image \li Fl_XPM_Image \li Fl_SVG_Image @@ -1127,7 +1127,7 @@ where img is a pointer to any Fl_Image type. \subsection ssect_Offscreen Offscreen Drawing Sometimes it can be very useful to generate a complex drawing -in memory first and copy it to the screen at a later point in +in memory first and copy it to the screen at a later point in time. This technique can significantly reduce the amount of repeated drawing. Offscreen drawing functions are declared in <FL/fl_draw.H>. @@ -1148,8 +1148,8 @@ Delete a previously created offscreen buffer. All drawings are lost. void fl_begin_offscreen(Fl_Offscreen) \par -Send all subsequent drawing commands to this offscreen buffer. -FLTK can draw into a buffer at any time. There is no need to wait for +Send all subsequent drawing commands to this offscreen buffer. +FLTK can draw into a buffer at any time. There is no need to wait for an Fl_Widget::draw() to occur. void fl_end_offscreen() diff --git a/documentation/src/editor.dox b/documentation/src/editor.dox index 2531dfbae..77c8bbaa5 100644 --- a/documentation/src/editor.dox +++ b/documentation/src/editor.dox @@ -1,6 +1,6 @@ /** - \page editor Designing a Simple Text Editor + \page editor Designing a Simple Text Editor This chapter takes you through the design of a simple FLTK-based text editor. diff --git a/documentation/src/enumerations.dox b/documentation/src/enumerations.dox index fee48b32d..b7c04d055 100644 --- a/documentation/src/enumerations.dox +++ b/documentation/src/enumerations.dox @@ -1,10 +1,10 @@ /** - \page enumerations FLTK Enumerations + \page enumerations FLTK Enumerations - \note This file is not actively maintained any more, but is left - here as a reference, until the doxygen documentation is - completed. + \note This file is not actively maintained any more, but is left + here as a reference, until the doxygen documentation is + completed. \sa \ref FL/Enumerations.H. @@ -31,10 +31,10 @@ The FLTK version number is stored in a number of compile-time constants: currently 10400 (default) \note The ABI version (FL_ABI_VERSION) is usually constant throughout one - major/minor release version, for instance 10300 if FL_API_VERSION is 10304. - Hence the ABI is constant if only the patch version is changed. - You can change this with configure or CMake though if you want the - latest enhancements (called "ABI features", see CHANGES). + major/minor release version, for instance 10300 if FL_API_VERSION is 10304. + Hence the ABI is constant if only the patch version is changed. + You can change this with configure or CMake though if you want the + latest enhancements (called "ABI features", see CHANGES). \section enumerations_events Events diff --git a/documentation/src/events.dox b/documentation/src/events.dox index 82718bec6..7657ce933 100644 --- a/documentation/src/events.dox +++ b/documentation/src/events.dox @@ -1,7 +1,7 @@ /** - \page events Handling Events - + \page events Handling Events + This chapter discusses the FLTK event model and how to handle events in your program or widget. @@ -20,7 +20,7 @@ Other information about the most recent event is stored in static locations and acquired by calling the \ref events_event_xxx. This static information remains valid until the next event -is read from the window system, so it is ok to look at it outside +is read from the window system, so it is ok to look at it outside of the \p handle() method. @@ -59,7 +59,7 @@ the matching \p FL_RELEASE events. If \p handle() returns zero then FLTK will try sending the \p FL_PUSH to -another widget. +another widget. \subsection events_fl_drag FL_DRAG @@ -84,7 +84,7 @@ return non-zero when handling \p FL_PUSH. \subsection events_fl_move FL_MOVE -The mouse has moved without any mouse buttons held down. +The mouse has moved without any mouse buttons held down. This event is sent to the Fl::belowmouse() widget. @@ -169,7 +169,7 @@ If you are writing a text-editing widget you may also want to call the Fl::compose() function to translate individual keystrokes into characters. -\p FL_KEYUP events are sent to the widget that +\p FL_KEYUP events are sent to the widget that currently has focus. This is not necessarily the same widget that received the corresponding \p FL_KEYDOWN event because focus may have changed between events. @@ -241,12 +241,12 @@ class \p handle() method!</I> -\note The events in this chapter ("Widget Events"), i.e. - FL_ACTIVATE, FL_DEACTIVATE, FL_SHOW, and FL_HIDE, - are the only events deactivated and invisible widgets - can usually get, depending on their states. Under certain - circumstances, there may also be FL_LEAVE or FL_UNFOCUS - events delivered to deactivated or hidden widgets. +\note The events in this chapter ("Widget Events"), i.e. + FL_ACTIVATE, FL_DEACTIVATE, FL_SHOW, and FL_HIDE, + are the only events deactivated and invisible widgets + can usually get, depending on their states. Under certain + circumstances, there may also be FL_LEAVE or FL_UNFOCUS + events delivered to deactivated or hidden widgets. \section events_clipboard Clipboard Events @@ -266,17 +266,17 @@ selection indication. Most modern programs ignore this. \section events_dnd Drag and Drop Events -FLTK supports drag and drop of text and files from any +FLTK supports drag and drop of text and files from any application on the desktop to an FLTK widget. Text is transferred using UTF-8 encoding. Files are received as a list of full path -and file names, separated by newline. +and file names, separated by newline. On some X11 platforms, files are received as a URL-encoded UTF-8 string, -that is, non-ASCII bytes (and a few others such as space and %) are +that is, non-ASCII bytes (and a few others such as space and %) are replaced by the 3 bytes "%XY" where XY are the byte's hexadecimal value. The \ref fl_decode_uri() function can be used to transform in-place the received string into a proper UTF-8 string. On these platforms, -strings corresponding to dropped files are further prepended +strings corresponding to dropped files are further prepended by <tt>file://</tt> (or other prefixes such as <tt>computer://</tt>). See Fl::dnd() for drag and drop from an FLTK widget. @@ -308,7 +308,7 @@ The mouse has moved out of the widget. \subsection events_fl_dnd_release FL_DND_RELEASE -The user has released the mouse button dropping data into +The user has released the mouse button dropping data into the widget. If the widget returns 1, it will receive the data in the immediately following \p FL_PASTE event. @@ -324,7 +324,7 @@ Use Fl::add_handler() to be notified of this event. The application window has been changed from normal to fullscreen, or from fullscreen to normal. If you are using a X window manager which supports Extended Window Manager Hints, this event will not be -delivered until the change has actually happened. +delivered until the change has actually happened. \section events_event_xxx Fl::event_*() methods @@ -337,7 +337,7 @@ and \p callback() methods. -These are all trivial inline functions and thus very fast and small: +These are all trivial inline functions and thus very fast and small: \li Fl::event_button() \li Fl::event_clicks() @@ -361,7 +361,7 @@ These are all trivial inline functions and thus very fast and small: Widgets receive events via the virtual handle() function. The argument indicates the type of event that can be handled. The widget must indicate if it handled the -event by returning 1. FLTK will then remove the event and wait for further events +event by returning 1. FLTK will then remove the event and wait for further events from the host. If the widget's handle function returns 0, FLTK may redistribute the event based on a few rules. @@ -399,7 +399,7 @@ Mouse motion (FL_MOVE) events are sent to the Fl::belowmouse() widget, i.e. the widget that returned 1 on the last FL_ENTER event. Mouse wheel events are sent to the window that caused the event. The window -propagates the event down the tree, first to the widget that is below the +propagates the event down the tree, first to the widget that is below the mouse pointer, and if that does not succeed, to all other widgets in the group. This ensures that scroll widgets work as expected with the widget furthest down in the hierarchy getting the first opportunity to use the wheel event, @@ -407,22 +407,22 @@ but also giving scroll bars, that are not directly below the mouse a chance. Keyboard events are sent directly to the widget that has keyboard focus. If the focused widget rejects the event, it is resent as a shortcut event, -first to the top-most window, then to the widget below the mouse pointer, +first to the top-most window, then to the widget below the mouse pointer, propagating up the hierarchy to all its parents. Those send the event also -to all widgets that are not below the mouse pointer. Now if that did not work +to all widgets that are not below the mouse pointer. Now if that did not work out, the shortcut is sent to all registered shortcut handlers. If we are still unsuccessful, the event handler flips the case of the shortcut -letter and starts over. Finally, if the key is "escape", FLTK sends a close +letter and starts over. Finally, if the key is "escape", FLTK sends a close event to the top-most window. -All other events are pretty much sent right away to the window that created +All other events are pretty much sent right away to the window that created the event. Widgets can "grab" events. The grabbing window gets all events exclusively, but usually by the same rules as described above. -Windows can also request exclusivity in event handling by making the +Windows can also request exclusivity in event handling by making the window modal. @@ -433,7 +433,7 @@ requires that you call the Fl::compose() function if you are writing your own text editor widget. Currently, all characters made by single key strokes -with or without modifier keys, or by system-defined character +with or without modifier keys, or by system-defined character compose sequences (that can involve dead keys or a compose key) can be input. You should call Fl::compose() in case any enhancements to this processing are done in the future. The diff --git a/documentation/src/examples.dox b/documentation/src/examples.dox index e7fa38154..4bd3ccd0d 100644 --- a/documentation/src/examples.dox +++ b/documentation/src/examples.dox @@ -1,6 +1,6 @@ /** - \page examples Example Source Code + \page examples Example Source Code The FLTK distribution contains over 60 sample applications written in, or ported to, FLTK. If the FLTK archive you received does not diff --git a/documentation/src/faq.dox b/documentation/src/faq.dox index a407327dd..b42aafeb7 100644 --- a/documentation/src/faq.dox +++ b/documentation/src/faq.dox @@ -1,6 +1,6 @@ /** - \page FAQ FAQ (Frequently Asked Questions) + \page FAQ FAQ (Frequently Asked Questions) A list of frequently asked questions about FLTK. @@ -32,7 +32,7 @@ and then read them, download and build FLTK from the source, then run the test/demo program. Also, go into the 'examples/' directory and run 'make', then run some of those programs. -If you prefer watching TV to reading books and code, google search for +If you prefer watching TV to reading books and code, google search for "FLTK video tutorials" which has some introductory examples of how to write FLTK programs in C++ and build them. @@ -79,8 +79,8 @@ clause ("exception") to allow for static linking. Specifically: example statement can be included in user documentation to satisfy this requirement: - [program/widget] is based in part on the work of the - FLTK project (http://www.fltk.org). + [program/widget] is based in part on the work of the + FLTK project (https://www.fltk.org). \endverbatim diff --git a/documentation/src/fltk-config.man b/documentation/src/fltk-config.man index 2fc3b7f09..6b53958b8 100644 --- a/documentation/src/fltk-config.man +++ b/documentation/src/fltk-config.man @@ -85,6 +85,6 @@ fluid(1), fltk(3) .br FLTK Programming Manual .br -FLTK Web Site, http://www.fltk.org/ +FLTK Web Site, https://www.fltk.org/ .SH AUTHORS Bill Spitzak and others. diff --git a/documentation/src/fltk.man b/documentation/src/fltk.man index 8950712cd..89d680a75 100644 --- a/documentation/src/fltk.man +++ b/documentation/src/fltk.man @@ -21,7 +21,7 @@ The authors do request that such modifications be contributed to the FLTK project - send all contributions through the "Software Trouble Report" on the following page: .IP - http://www.fltk.org/str.php + https://www.fltk.org/bugs.php .IP 2. Widgets that are subclassed from FLTK widgets do not constitute a derivative work. @@ -46,12 +46,12 @@ following example statement can be included in user documentation to satisfy this requirement: .IP [program/widget] is based in part on the work of the FLTK -project (http://www.fltk.org). +project (https://www.fltk.org). .SH SEE ALSO fltk\-config(1), fluid(1) .br FLTK Programming Manual .br -FLTK Web Site, http://www.fltk.org/ +FLTK Web Site, https://www.fltk.org/ .SH AUTHORS Bill Spitzak and others. diff --git a/documentation/src/fluid.dox b/documentation/src/fluid.dox index 1978ce636..9d1e1fcc4 100644 --- a/documentation/src/fluid.dox +++ b/documentation/src/fluid.dox @@ -3,7 +3,7 @@ <!-- Warning: \p .h does not work but <tt>.h</tt> does --> <!-- Warning: \p .cxx does not work but <tt>.cxx</tt> does --> - \page fluid Programming with FLUID + \page fluid Programming with FLUID This chapter shows how to use the Fast Light User-Interface Designer ("FLUID") to create your GUIs. @@ -135,7 +135,7 @@ files: \code my_panels.h my_panels.cxx: my_panels.fl - fluid -c my_panels.fl + fluid -c my_panels.fl \endcode Most versions of make support rules that cause <tt>.fl</tt> @@ -144,7 +144,7 @@ files to be compiled: \code .SUFFIXES: .fl .cxx .h .fl.h .fl.cxx: - fluid -c $< + fluid -c $< \endcode If you use diff --git a/documentation/src/fluid.man b/documentation/src/fluid.man index cb6849bc3..1e00598ac 100644 --- a/documentation/src/fluid.man +++ b/documentation/src/fluid.man @@ -9,7 +9,7 @@ fluid [ \-c [ \-o .I header-filename ] ] [ .I filename.fl -] +] .fi .SH DESCRIPTION \fIfluid\fR is an interactive GUI designer for FLTK. When run @@ -19,7 +19,7 @@ Functions, classes, windows, and GUI components can be manipulated as needed. .LP When used with the \fI\-c\fR option, \fIfluid\fR will create the -necessary C++ header and code files in the current directory. +necessary C++ header and code files in the current directory. You can override the default extensions, filenames, and directories using the \fI\-o\fR and \fI\-h\fR options. .SH SEE ALSO @@ -27,6 +27,6 @@ fltk\-config(1), fltk(3) .br FLTK Programming Manual, Chapter 9 .br -FLTK Web Site, http://www.fltk.org/ +FLTK Web Site, https://www.fltk.org/ .SH AUTHORS Bill Spitzak and others. diff --git a/documentation/src/forms.dox b/documentation/src/forms.dox index c2379e983..bb6279934 100644 --- a/documentation/src/forms.dox +++ b/documentation/src/forms.dox @@ -1,7 +1,7 @@ /** <!-- Warning: \p .fd does not work but <tt>.fd</tt> does --> - \page forms Forms Compatibility + \page forms Forms Compatibility This appendix describes the Forms compatibility included with FLTK. @@ -27,7 +27,7 @@ new name so you don't write over the old one. You will need to edit your main code considerably to get it to link with the output from FLUID. If you are not interested in this you may -have more immediate luck with the forms compatibility header, <FL/forms.H>. +have more immediate luck with the forms compatibility header, <FL/forms.H>. \section forms_using Using the Compatibility Header File @@ -42,31 +42,31 @@ without changes. You will also have to compile your Forms or XForms program using a C++ compiler. The FLTK library does not provide C bindings or header -files. +files. Although FLTK was designed to be compatible with the GL Forms library (version 0.3 or so), XForms has bloated severely and its interface is X-specific. Therefore, XForms compatibility is no longer a goal of FLTK. Compatibility was limited to things that were free, or that would add code that would not be linked in if the feature is -unused, or that was not X-specific. +unused, or that was not X-specific. To use any new features of FLTK, you should rewrite your code to not use the inline functions and instead use "pure" FLTK. This will make it a lot cleaner and make it easier to figure out how to call the FLTK functions. Unfortunately this conversion is harder than expected and -even Digital Domain's inhouse code still uses <tt>forms.H</tt> a lot. +even Digital Domain's inhouse code still uses <tt>forms.H</tt> a lot. \section forms_problems Problems You Will Encounter Many parts of XForms use X-specific structures like \c XEvent in their interface. I did not emulate these! Unfortunately these features (such as the "canvas" widget) are needed by most large -programs. You will need to rewrite these to use FLTK subclasses. +programs. You will need to rewrite these to use FLTK subclasses. Fl_Free widgets emulate the \e old Forms "free" widget. It may be useful for porting programs that change the \c handle() -function on widgets, but you will still need to rewrite things. +function on widgets, but you will still need to rewrite things. Fl_Timer widgets are provided to emulate the XForms timer. These work, but are quite @@ -77,33 +77,33 @@ the \p x, \p y, \p w, \p h, \p label, or other fields of your Forms widgets you will have to add empty parenthesis after each reference. The easiest way to do this is to globally replace <tt>"->x"</tt> with <tt>"->x()"</tt>, etc. -Replace <tt>"boxtype"</tt> with <tt>"box()"</tt>. +Replace <tt>"boxtype"</tt> with <tt>"box()"</tt>. <tt>const char *</tt> arguments to most FLTK methods are simply stored, while Forms would \c strdup() the passed string. This is most noticeable with the label of widgets. Your program must always pass static data such as a string constant or malloc'd buffer to \c label(). If you are using labels to display program output you -may want to try the Fl_Output widget. +may want to try the Fl_Output widget. The default fonts and sizes are matched to the older GL version of Forms, so all labels will draw somewhat larger than an XForms program -does. +does. fdesign outputs a setting of a "fdui" instance variable to the main window. I did not emulate this because I wanted all instance variables to be hidden. You can store the same information in the \c user_data() field of a window. To do this, search through the fdesign output for all occurrences of <tt>"->fdui"</tt> and edit to use <tt>"->user_data()"</tt> -instead. This will require casts and is not trivial. +instead. This will require casts and is not trivial. The prototype for the functions passed to \c fl_add_timeout() -and \c fl_set_idle_callback() callback are different. +and \c fl_set_idle_callback() callback are different. <B>All the following XForms calls are missing:</B> \li \c FL_REVISION, \c fl_library_version() -\li \c FL_RETURN_DBLCLICK (use Fl::event_clicks()) +\li \c FL_RETURN_DBLCLICK (use Fl::event_clicks()) \li \c fl_add_signal_callback() \li \c fl_set_form_atactivate() \c fl_set_form_atdeactivate() \li \c fl_set_form_property() @@ -111,38 +111,38 @@ and \c fl_set_idle_callback() callback are different. \li \c fl_set_form_minsize(), \c fl_set_form_maxsize() \li \c fl_set_form_event_cmask(), \c fl_get_form_event_cmask() \li \c fl_set_form_dblbuffer(), \c fl_set_object_dblbuffer() - (use an Fl_Double_Window instead) + (use an Fl_Double_Window instead) \li \c fl_adjust_form_size() \li \c fl_register_raw_callback() \li \c fl_set_object_bw(), \c fl_set_border_width() \li \c fl_set_object_resize(), \c fl_set_object_gravity() \li \c fl_set_object_shortcutkey() \li \c fl_set_object_automatic() -\li \c fl_get_object_bbox() (maybe FLTK should do this) +\li \c fl_get_object_bbox() (maybe FLTK should do this) \li \c fl_set_object_prehandler(), \c fl_set_object_posthandler() \li \c fl_enumerate_fonts() -\li Most drawing functions -\li \c fl_set_coordunit() (FLTK uses pixels all the time) +\li Most drawing functions +\li \c fl_set_coordunit() (FLTK uses pixels all the time) \li \c fl_ringbell() \li \c fl_gettime() -\li \c fl_win*() (all these functions) -\li \c fl_initialize(argc,argv,x,y,z) ignores last 3 arguments +\li \c fl_win*() (all these functions) +\li \c fl_initialize(argc,argv,x,y,z) ignores last 3 arguments \li \c fl_read_bitmapfile(), \c fl_read_pixmapfile() \li \c fl_addto_browser_chars() -\li \c FL_MENU_BUTTON just draws normally +\li \c FL_MENU_BUTTON just draws normally \li \c fl_set_bitmapbutton_file(), \c fl_set_pixmapbutton_file() -\li \c FL_CANVAS objects -\li \c FL_DIGITAL_CLOCK (comes out analog) +\li \c FL_CANVAS objects +\li \c FL_DIGITAL_CLOCK (comes out analog) \li \c fl_create_bitmap_cursor(), \c fl_set_cursor_color() \li \c fl_set_dial_angles() \li \c fl_show_oneliner() -\li \c fl_set_choice_shortcut(a,b,c) -\li command log -\li Only some of file selector is emulated +\li \c fl_set_choice_shortcut(a,b,c) +\li command log +\li Only some of file selector is emulated \li \c FL_DATE_INPUT -\li \c fl_pup*() (all these functions) -\li textbox object (should be easy but I had no sample programs) -\li xyplot object +\li \c fl_pup*() (all these functions) +\li textbox object (should be easy but I had no sample programs) +\li xyplot object \section forms_notes Additional Notes @@ -166,15 +166,15 @@ panels. If the user did things to the IRISGL window, you would find this out by having the value FL_EVENT returned from the call to Forms. None of this works with FLTK. Nor will it compile, the necessary -calls are not in the interface. +calls are not in the interface. You have to make a subclass of Fl_Gl_Window and write a \c draw() method and \c handle() method. This may require anywhere from a trivial to a -major rewrite. +major rewrite. If you draw into the overlay planes you will have to also write a \c draw_overlay() method and call \c redraw_overlay() on the -OpenGL window. +OpenGL window. One easy way to hack your program so it works is to make the \c draw() and \c handle() methods on your window set some static variables, storing @@ -186,7 +186,7 @@ they are events read from \c fl_queue. The file <FL/gl.h> defines replacements for a lot of IRISGL calls, translating them to OpenGL. There are much better translators -available that you might want to investigate. +available that you might want to investigate. \par You Cannot Make Forms Subclasses @@ -200,10 +200,10 @@ if it "understood" the event. An attempt has been made to emulate the "free" widget. This appears to work quite well. It may be quicker to modify your subclass into a -"free" widget, since the "handle" functions match. +"free" widget, since the "handle" functions match. If your subclass draws into the overlay you are in trouble and will -have to rewrite things a lot. +have to rewrite things a lot. \par You Cannot Use <device.h> diff --git a/documentation/src/glut.dox b/documentation/src/glut.dox index 985d3074f..0effbe5a4 100644 --- a/documentation/src/glut.dox +++ b/documentation/src/glut.dox @@ -1,6 +1,6 @@ /** - \page glut GLUT Compatibility + \page glut GLUT Compatibility This appendix describes the GLUT compatibility header file supplied with FLTK. FLTK's GLUT compatibility is based on the original GLUT 3.7 and @@ -42,7 +42,7 @@ to compile: \li \p glutLayerGet(GLUT_LAYER_IN_USE) \li \p glutPushWindow() \li \p glutSetColor(), \p glutGetColor(), \p glutCopyColormap() -\li \p glutVideoResize() missing. +\li \p glutVideoResize() missing. \li \p glutWarpPointer() \li \p glutWindowStatusFunc() \li Spaceball, buttonbox, dials, and tablet functions @@ -94,17 +94,17 @@ Fl_Window parent window must already be shown. \li Don't call \p glutInit(). \li Create your Fl_Window, and any FLTK widgets. Leave a - blank area in the window for your GLUT window. + blank area in the window for your GLUT window. \li \p show() the Fl_Window. Perhaps call \p show(argc,argv). \li Call <tt>window->begin()</tt> so that the GLUT window will be - automatically added to it. + automatically added to it. \li Use \p glutInitWindowSize() and \p glutInitWindowPosition() - to set the location in the parent window to put the GLUT window. + to set the location in the parent window to put the GLUT window. \li Put your GLUT code next. It probably does not need many changes. Call <tt>window->end()</tt> immediately after the \p glutCreateWindow()! \li You can call either \p glutMainLoop(), Fl::run(), - or loop calling Fl::wait() to run the program. + or loop calling Fl::wait() to run the program. \section glut_Fl_Glut_Window class Fl_Glut_Window @@ -139,7 +139,7 @@ or make the window current. <tt>window->make_current()</tt> is the same as \p glutSetWindow(number). If the window has not had \p show() called on it yet, some functions -that assume an OpenGL context will not work. +that assume an OpenGL context will not work. If you do \p show() the window, call \p make_current() again to set the context. @@ -152,57 +152,57 @@ be altered directly: <CENTER><TABLE WIDTH="80%" BORDER="1" ALT="Fl_Glut_Window public members."> <TR> - <TH>member</TH> - <TH>description</TH> + <TH>member</TH> + <TH>description</TH> </TR> <TR> - <TD>display</TD> - <TD>A pointer to the function to call to draw the normal planes.</TD> + <TD>display</TD> + <TD>A pointer to the function to call to draw the normal planes.</TD> </TR> <TR> - <TD>entry</TD> - <TD>A pointer to the function to call when the mouse moves into - or out of the window.</TD> + <TD>entry</TD> + <TD>A pointer to the function to call when the mouse moves into + or out of the window.</TD> </TR> <TR> - <TD>keyboard</TD> - <TD>A pointer to the function to call when a regular key is pressed.</TD> + <TD>keyboard</TD> + <TD>A pointer to the function to call when a regular key is pressed.</TD> </TR> <TR> - <TD>menu[3]</TD> - <TD>The menu to post when one of the mouse buttons is pressed.</TD> + <TD>menu[3]</TD> + <TD>The menu to post when one of the mouse buttons is pressed.</TD> </TR> <TR> - <TD>mouse</TD> - <TD>A pointer to the function to call when a button is pressed or - released.</TD> + <TD>mouse</TD> + <TD>A pointer to the function to call when a button is pressed or + released.</TD> </TR> <TR> - <TD>motion</TD> - <TD>A pointer to the function to call when the mouse is moved with - a button down.</TD> + <TD>motion</TD> + <TD>A pointer to the function to call when the mouse is moved with + a button down.</TD> </TR> <TR> - <TD>overlaydisplay</TD> - <TD>A pointer to the function to call to draw the overlay planes.</TD> + <TD>overlaydisplay</TD> + <TD>A pointer to the function to call to draw the overlay planes.</TD> </TR> <TR> - <TD>passivemotion</TD> - <TD>A pointer to the function to call when the mouse is moved with - no buttons down.</TD> + <TD>passivemotion</TD> + <TD>A pointer to the function to call when the mouse is moved with + no buttons down.</TD> </TR> <TR> - <TD>reshape</TD> - <TD>A pointer to the function to call when the window is resized.</TD> + <TD>reshape</TD> + <TD>A pointer to the function to call when the window is resized.</TD> </TR> <TR> - <TD>special</TD> - <TD>A pointer to the function to call when a special key is pressed.</TD> + <TD>special</TD> + <TD>A pointer to the function to call when a special key is pressed.</TD> </TR> <TR> - <TD>visibility</TD> - <TD>A pointer to the function to call when the window is iconified - or restored (made visible.)</TD> + <TD>visibility</TD> + <TD>A pointer to the function to call when the window is iconified + or restored (made visible.)</TD> </TR> </TABLE></CENTER> diff --git a/documentation/src/html_footer b/documentation/src/html_footer index ac12b5f5f..4d60ab346 100644 --- a/documentation/src/html_footer +++ b/documentation/src/html_footer @@ -2,7 +2,7 @@ <li class="footer"> <!-- Generated for $projectname by Doxygen --> © 1998-2018 by Bill Spitzak and others. - <a href="http://www.fltk.org"><img src="tiny.png" align="bottom" alt="FLTK"></a> + <a href="https://www.fltk.org"><img src="tiny.png" align="bottom" alt="FLTK"></a> </li> </ul> </div> @@ -11,7 +11,7 @@ <hr class="footer"/><address class="footer"><small> <!-- Generated for $projectname by Doxygen --> © 1998-2018 by Bill Spitzak and others. - <a href="http://www.fltk.org"><img src="tiny.png" align="bottom" alt="FLTK"></a> + <a href="https://www.fltk.org"><img src="tiny.png" align="bottom" alt="FLTK"></a> </small></address> <hr class="footer"/><address class="footer"><small> <div align="center"> diff --git a/documentation/src/index.dox b/documentation/src/index.dox index c81ac5f23..09b4545bd 100644 --- a/documentation/src/index.dox +++ b/documentation/src/index.dox @@ -38,27 +38,27 @@ \subpage basics \subpage common - - \ref common_colors - - \ref common_boxtypes - - \ref common_labels - - \ref drawing_images + - \ref common_colors + - \ref common_boxtypes + - \ref common_labels + - \ref drawing_images \subpage editor \subpage drawing \subpage events - - \ref events_event_xxx - - \ref events_propagation + - \ref events_event_xxx + - \ref events_propagation \subpage subclassing \subpage opengl \subpage fluid - - \ref fluid_widget_attributes - - \ref fluid_selecting_moving - - \ref fluid_images + - \ref fluid_widget_attributes + - \ref fluid_selecting_moving + - \ref fluid_images </TD> <TD ALIGN="LEFT" VALIGN="TOP"> @@ -70,25 +70,25 @@ <b>Appendices:</b> - - \subpage enumerations + - \subpage enumerations - - \subpage glut - - \ref glut_Fl_Glut_Window - <!-- - Fl_Glut_Window (not yet commented ?) --> + - \subpage glut + - \ref glut_Fl_Glut_Window + <!-- - Fl_Glut_Window (not yet commented ?) --> - - \subpage forms + - \subpage forms - - \subpage osissues + - \subpage osissues - - \subpage migration_1_4 + - \subpage migration_1_4 - - \subpage development + - \subpage development - - \subpage license + - \subpage license - - \subpage examples + - \subpage examples - - \subpage FAQ + - \subpage FAQ </TD> </TR> diff --git a/documentation/src/intro.dox b/documentation/src/intro.dox index 338e8ae99..8df76f07c 100644 --- a/documentation/src/intro.dox +++ b/documentation/src/intro.dox @@ -356,7 +356,7 @@ FLTK is available on the 'net in a bunch of locations: \par WWW https://www.fltk.org/ <br> -https://www.fltk.org/str.php [for reporting bugs] <br> +https://www.fltk.org/bugs.php [for reporting bugs] <br> https://www.fltk.org/software.php [download source code]<br> https://www.fltk.org/newsgroups.php [newsgroup/forums] @@ -368,7 +368,7 @@ https://www.fltk.org/newsgroups.php [web interface]<br> \section intro_reporting Reporting Bugs To report a bug in FLTK, or for feature requests, please use the form at -<A href="https://www.fltk.org/str.php">https://www.fltk.org/str.php</A>, +<A href="https://www.fltk.org/bugs.php">https://www.fltk.org/bugs.php</A>, and click on "Submit Bug or Feature Request". You'll be prompted for the FLTK version, operating system & version, diff --git a/documentation/src/license.dox b/documentation/src/license.dox index 63c96ad2a..1110280ed 100644 --- a/documentation/src/license.dox +++ b/documentation/src/license.dox @@ -1,6 +1,6 @@ /** - \page license Software License + \page license Software License \par December 11, 2001 @@ -8,43 +8,43 @@ The FLTK library and included programs are provided under the terms of the GNU Library General Public License (LGPL) with the following exceptions: --# Modifications to the FLTK configure script, config - header file, and makefiles by themselves to support - a specific platform do not constitute a modified or - derivative work.<BR> - <BR> +-# Modifications to the FLTK configure script, config + header file, and makefiles by themselves to support + a specific platform do not constitute a modified or + derivative work.<BR> + <BR> The authors do request that such modifications be contributed to the FLTK project - send all contributions through the "Software Trouble Report" on the following page: - http://www.fltk.org/str.php<BR> - <BR> --# Widgets that are subclassed from FLTK widgets do not - constitute a derivative work.<BR> - <BR> --# Static linking of applications and widgets to the - FLTK library does not constitute a derivative work - and does not require the author to provide source - code for the application or widget, use the shared - FLTK libraries, or link their applications or - widgets against a user-supplied version of FLTK.<BR> - <BR> - If you link the application or widget to a modified - version of FLTK, then the changes to FLTK must be - provided under the terms of the LGPL in sections - 1, 2, and 4.<BR> - <BR> --# You do not have to provide a copy of the FLTK license - with programs that are linked to the FLTK library, nor - do you have to identify the FLTK license in your - program or documentation as required by section 6 - of the LGPL.<BR> - <BR> - However, programs must still identify their use of FLTK. - The following example statement can be included in user - documentation to satisfy this requirement:<BR> - <BR> - <I>[program/widget] is based in part on the work of - the FLTK project (http://www.fltk.org).</I> + https://www.fltk.org/bugs.php<BR> + <BR> +-# Widgets that are subclassed from FLTK widgets do not + constitute a derivative work.<BR> + <BR> +-# Static linking of applications and widgets to the + FLTK library does not constitute a derivative work + and does not require the author to provide source + code for the application or widget, use the shared + FLTK libraries, or link their applications or + widgets against a user-supplied version of FLTK.<BR> + <BR> + If you link the application or widget to a modified + version of FLTK, then the changes to FLTK must be + provided under the terms of the LGPL in sections + 1, 2, and 4.<BR> + <BR> +-# You do not have to provide a copy of the FLTK license + with programs that are linked to the FLTK library, nor + do you have to identify the FLTK license in your + program or documentation as required by section 6 + of the LGPL.<BR> + <BR> + However, programs must still identify their use of FLTK. + The following example statement can be included in user + documentation to satisfy this requirement:<BR> + <BR> + <I>[program/widget] is based in part on the work of + the FLTK project (https://www.fltk.org).</I> <HR> @@ -68,7 +68,7 @@ software--to make sure the software is free for all its users. This license, the Library General Public License, applies to some specially designated Free Software Foundation software, and to any other libraries whose authors decide to use it. You can use it for -your libraries, too. +your libraries, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you @@ -153,7 +153,7 @@ General Public License rather than by this special one. \b 0. This License Agreement applies to any software library which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this -Library General Public License (also called "this License"). +Library General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data diff --git a/documentation/src/migration_1_4.dox b/documentation/src/migration_1_4.dox index 57fd9faea..1a24d487a 100644 --- a/documentation/src/migration_1_4.dox +++ b/documentation/src/migration_1_4.dox @@ -1,6 +1,6 @@ /** - \page migration_1_4 Migrating Code from FLTK 1.3 to 1.4 + \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. diff --git a/documentation/src/opengl.dox b/documentation/src/opengl.dox index 94c13eb17..9d727d87a 100644 --- a/documentation/src/opengl.dox +++ b/documentation/src/opengl.dox @@ -1,6 +1,6 @@ /** - \page opengl Using OpenGL + \page opengl Using OpenGL This chapter discusses using FLTK for your OpenGL applications. @@ -55,15 +55,15 @@ glDrawBuffer(GL_BACK); <CENTER><TABLE WIDTH="80%" BORDER="1" CELLPADDING="5" CELLSPACING="0" BGCOLOR="#cccccc"> <TR> - <TD><B>Note:</B> + <TD><B>Note:</B> - If you are using the Mesa graphics library, the call - to \p glDrawBuffer() is not required and will slow - down drawing considerably. The preprocessor instructions - shown above will optimize your code based upon the - graphics library used. + If you are using the Mesa graphics library, the call + to \p glDrawBuffer() is not required and will slow + down drawing considerably. The preprocessor instructions + shown above will optimize your code based upon the + graphics library used. - </TD> + </TD> </TR> </TABLE></CENTER> @@ -150,12 +150,12 @@ loading functions by doing: \code case FL_PUSH: - make_current(); // make OpenGL context current + make_current(); // make OpenGL context current if (!valid()) { ... set up projection exactly the same as draw ... - valid(1); // stop it from doing this next time + valid(1); // stop it from doing this next time } ... ok to call NON-DRAWING OpenGL code here, such as hit detection, loading textures, etc... @@ -453,10 +453,10 @@ void OptimizerWindow::draw() { // Clear the window... context_->clear(csContext::COLOR_CLEAR | csContext::DEPTH_CLEAR, - 0.0f, // Red - 0.0f, // Green - 0.0f, // Blue - 1.0f); // Alpha + 0.0f, // Red + 0.0f, // Green + 0.0f, // Blue + 1.0f); // Alpha // Then draw the scene (if any)... if (scene_) diff --git a/documentation/src/osissues.dox b/documentation/src/osissues.dox index e2511f4ef..d629acfab 100644 --- a/documentation/src/osissues.dox +++ b/documentation/src/osissues.dox @@ -1,6 +1,6 @@ /** - \page osissues Operating System Issues + \page osissues Operating System Issues This appendix describes the operating system specific interfaces in FLTK: \li \ref osissues_accessing @@ -21,24 +21,24 @@ This header file will define the appropriate interface for your environment. The pages that follow describe the functionality that is provided for each operating system. -\note These definitions used to be in FL/x.H up to FLTK 1.3.x. Usage of - FL/x.H is deprecated since FLTK 1.4.0. You should replace all references - of FL/x.H with FL/platform.H if your target is FLTK 1.4 or later. - FL/x.H will be retained for backwards compatibility for some - releases but will be removed in a later (not yet specified) - FLTK release. +\note These definitions used to be in FL/x.H up to FLTK 1.3.x. Usage of + FL/x.H is deprecated since FLTK 1.4.0. You should replace all references + of FL/x.H with FL/platform.H if your target is FLTK 1.4 or later. + FL/x.H will be retained for backwards compatibility for some + releases but will be removed in a later (not yet specified) + FLTK release. <CENTER> <TABLE WIDTH="90%" BORDER="1" CELLPADDING="5" CELLSPACING="0" BGCOLOR="#cccccc"> <TR> - <TD><B>WARNING:</B> + <TD><B>WARNING:</B> - The interfaces provided by this header file may - change radically in new FLTK releases. Use them only - when an existing generic FLTK interface is not - sufficient. + The interfaces provided by this header file may + change radically in new FLTK releases. Use them only + when an existing generic FLTK interface is not + sufficient. - </TD> + </TD> </TR> </TABLE> </CENTER> @@ -157,7 +157,7 @@ int fl_parse_color(const char* p, uchar& r, uchar& g, uchar& b) Convert a name into the red, green, and blue values of a color by parsing the X11 color names. On other systems, \c fl_parse_color() can only convert names in hexadecimal encoding, for example <tt>\#ff8083</tt>. - + extern XFontStruct *fl_xfont \par @@ -167,7 +167,7 @@ This is not necessarily the current font of \c fl_gc, which is not set until \ref ssect_Text "fl_draw()" is called. If FLTK was compiled with Xft support, \c fl_xfont -will usually be 0 and \c fl_xftfont will contain a pointer +will usually be 0 and \c fl_xftfont will contain a pointer to the \c XftFont structure instead. extern void *fl_xftfont @@ -176,7 +176,7 @@ extern void *fl_xftfont If FLTK was compiled with Xft support enabled, \c fl_xftfont points to the xft font selected by the most recent \ref ssect_Fonts "fl_font()". -Otherwise it will be 0. \c fl_xftfont should be cast to +Otherwise it will be 0. \c fl_xftfont should be cast to <tt>XftFont*</tt>. \subsection osissues_xvisual Changing the Display, Screen, or X Visual @@ -283,7 +283,7 @@ An example: \code void MyWindow::show() { if (shown()) {Fl_Window::show(); return;} // you must do this! - fl_open_display(); // necessary if this is first window + fl_open_display(); // necessary if this is first window // we only calculate the necessary visual colormap once: static XVisualInfo *visual; static Colormap colormap; @@ -428,13 +428,13 @@ of libraries that are used to link the application (usually "-lXpm"). <CENTER> <TABLE WIDTH="90%" BORDER="1" CELLPADDING="5" CELLSPACING="0" BGCOLOR="#cccccc"> <TR> - <TD><B>NOTE:</B> - - You must call Fl_Window::show(int argc, char** argv) - for the icon to be used. The Fl_Window::show() method - does not bind the icon to the window. + <TD><B>NOTE:</B> + + You must call Fl_Window::show(int argc, char** argv) + for the icon to be used. The Fl_Window::show() method + does not bind the icon to the window. - </TD> + </TD> </TR> </TABLE> </CENTER> @@ -446,27 +446,27 @@ Fl_Window::show(int argc, char** argv) method is called, FLTK looks for the following X resources: \li \c background - The default background color - for widgets (color). + for widgets (color). \li \c dndTextOps - The default setting for - drag and drop text operations (boolean). + drag and drop text operations (boolean). \li \c foreground - The default foreground (label) - color for widgets (color). + color for widgets (color). \li \c scheme - The default scheme to use (string). \li \c selectBackground - The default selection - color for menus, etc. (color). + color for menus, etc. (color). \li <tt>Text.background</tt> - The default background - color for text fields (color). + color for text fields (color). \li \c tooltips - The default setting for - tooltips (boolean). + tooltips (boolean). \li \c visibleFocus - The default setting for - visible keyboard focus on non-text widgets (boolean). + visible keyboard focus on non-text widgets (boolean). Resources associated with the first window's Fl_Window::xclass() string are queried first, or if no class has been specified then @@ -488,7 +488,7 @@ state information and data structures. \subsection non_ascii_filenames Using filenames with non-ASCII characters In FLTK, all strings, including filenames, are UTF-8 encoded. The utility functions -fl_fopen() and fl_open() allow to open files potentially having non-ASCII names in a +fl_fopen() and fl_open() allow to open files potentially having non-ASCII names in a cross-platform fashion, whereas the standard fopen()/open() functions fail to do so. \subsection osissues_wm_quit Responding to WM_QUIT @@ -615,13 +615,13 @@ bitmap data. <CENTER> <TABLE WIDTH="90%" BORDER="1" CELLPADDING="5" CELLSPACING="0" BGCOLOR="#cccccc"> <TR> - <TD><B>NOTE:</B> - - You must call Fl_Window::show(int argc, char** argv) - for the icon to be used. The Fl_Window::show() method - does not bind the icon to the window. + <TD><B>NOTE:</B> + + You must call Fl_Window::show(int argc, char** argv) + for the icon to be used. The Fl_Window::show() method + does not bind the icon to the window. - </TD> + </TD> </TR> </TABLE> </CENTER> @@ -656,32 +656,32 @@ them in the foreground. The following is a list of known bugs and problems in the Windows version of FLTK: -\li If a program is deactivated, <tt>Fl::wait()</tt> - does not return until it is activated again, even though - many events are delivered to the program. This can cause - idle background processes to stop unexpectedly. This - also happens while the user is dragging or resizing - windows or otherwise holding the mouse down. We were - forced to remove most of the efficiency FLTK uses for - redrawing in order to get windows to update while being - moved. This is a design error in Windows and probably - impossible to get around. - -\li <tt>Fl_Gl_Window::can_do_overlay()</tt> returns true - until the first time it attempts to draw an overlay, and - then correctly returns whether or not there is overlay - hardware. - -\li <tt>SetCapture</tt> (used by <tt>Fl::grab()</tt>) - doesn't work, and the main window title bar turns gray - while menus are popped up. - -\li Compilation with <tt>gcc 3.4.4</tt> and <tt>-Os</tt> exposes an - optimisation bug in gcc. The symptom is that when drawing - filled circles only the perimeter is drawn. This can for instance - be seen in the symbols demo. Other optimisation options such - as -O2 and -O3 seem to work OK. More details can be found - in STR#1656 +\li If a program is deactivated, <tt>Fl::wait()</tt> + does not return until it is activated again, even though + many events are delivered to the program. This can cause + idle background processes to stop unexpectedly. This + also happens while the user is dragging or resizing + windows or otherwise holding the mouse down. We were + forced to remove most of the efficiency FLTK uses for + redrawing in order to get windows to update while being + moved. This is a design error in Windows and probably + impossible to get around. + +\li <tt>Fl_Gl_Window::can_do_overlay()</tt> returns true + until the first time it attempts to draw an overlay, and + then correctly returns whether or not there is overlay + hardware. + +\li <tt>SetCapture</tt> (used by <tt>Fl::grab()</tt>) + doesn't work, and the main window title bar turns gray + while menus are popped up. + +\li Compilation with <tt>gcc 3.4.4</tt> and <tt>-Os</tt> exposes an + optimisation bug in gcc. The symptom is that when drawing + filled circles only the perimeter is drawn. This can for instance + be seen in the symbols demo. Other optimisation options such + as -O2 and -O3 seem to work OK. More details can be found + in STR#1656 \section osissues_macos The Apple OS X Interface @@ -707,8 +707,8 @@ Right Click simulation with Ctrl Click The Apple HIG guidelines indicate applications should support 'Ctrl Click' to simulate 'Right Click' for e.g. context menus, so users with one-button mice and one-click trackpads can still -access right-click features. However, paraphrasing -<A HREF="http://www.fltk.org/newsgroups.php?gfltk.coredev+v:14725"> +access right-click features. However, paraphrasing +<A HREF="https://www.fltk.org/newsgroups.php?gfltk.coredev+v:14725"> Manolo's comment on the fltk.coredev newsgroup</A>: \par <UL><LI> @@ -725,24 +725,24 @@ showing an example of how to do this: \code case FL_PUSH: { - int btn = Fl::event_button(); + int btn = Fl::event_button(); #ifdef __APPLE__ - int ev_state = Fl::event_state(); + int ev_state = Fl::event_state(); #endif - // - // Context menu can be called up in one of two ways: - - // 1 - right click, as normally used on Windows and Linux - // 2 - Ctrl + left click, as sometimes used on Mac - // + // + // Context menu can be called up in one of two ways: - + // 1 - right click, as normally used on Windows and Linux + // 2 - Ctrl + left click, as sometimes used on Mac + // #ifdef __APPLE__ - // On apple, check right click, and ctrl+left click - if ((btn == FL_RIGHT_MOUSE) || (ev_state == (FL_CTRL | FL_BUTTON1))) + // On apple, check right click, and ctrl+left click + if ((btn == FL_RIGHT_MOUSE) || (ev_state == (FL_CTRL | FL_BUTTON1))) #else - // On other platforms, only check right click as ctrl+left is used for selections - if (btn == FL_RIGHT_MOUSE) + // On other platforms, only check right click as ctrl+left is used for selections + if (btn == FL_RIGHT_MOUSE) #endif - { - // Did we right click on the object?.. + { + // Did we right click on the object?.. \endcode \par There is a thread about this subject on fltk.coredev (Aug 1-14, 2014) @@ -753,7 +753,7 @@ Apple "Quit" Event \par When the user presses Cmd-Q or requests a termination of the application, FLTK sends an \c FL_CLOSE event to all open -windows. If any window remains open, the termination request aborts. +windows. If any window remains open, the termination request aborts. If all windows close, the application's event loop terminates, that is, Fl::run() returns. The application can then follow FLTK's normal termination path executing cleanup code that may be programmed @@ -789,7 +789,7 @@ Fl_Window *fl_find(Window xid) Returns the Fl_Window that corresponds to the given window reference, or \c NULL if not found. -void fl_mac_set_about( Fl_Callback *cb, void *user_data, int shortcut) +void fl_mac_set_about( Fl_Callback *cb, void *user_data, int shortcut) \par Attaches the callback \c cb to the "About myprog" item of the system application menu. @@ -816,14 +816,14 @@ it is necessary to use the iconutil command-line utility. <key>CFBundleIconFile</key> <string>foo.icns</string> \endverbatim -replacing <tt>foo</tt> by your application name. If you use Xcode, just add your .icns file to your +replacing <tt>foo</tt> by your application name. If you use Xcode, just add your .icns file to your application target. \subsection osissues_quartz Drawing Things Using Quartz All code inside Fl_Widget::draw() -is expected to call Quartz drawing functions. The Quartz coordinate system +is expected to call Quartz drawing functions. The Quartz coordinate system is flipped to match FLTK's coordinate system. The origin for all drawing is in the top left corner of the enclosing Fl_Window. The global variable @@ -834,9 +834,9 @@ Include FL/platform.H to declare the \c fl_gc variable. All FLTK programs contain an application menu with, e.g., the About xxx, Hide xxx, and Quit xxx items. This menu can be internationalized/localized by any of two means. \li using the Fl_Mac_App_Menu class. -\li using the standard Mac OS X localization procedure. Create a language-specific .lproj directory -(e.g., <tt>German.lproj</tt>) in the Resources subdirectory of the application bundle. -Create therein a <tt>Localizable.strings</tt> file that translates all menu items to this language. +\li using the standard Mac OS X localization procedure. Create a language-specific .lproj directory +(e.g., <tt>German.lproj</tt>) in the Resources subdirectory of the application bundle. +Create therein a <tt>Localizable.strings</tt> file that translates all menu items to this language. The German <tt>Localizable.strings</tt> file, for example, contains: \verbatim "About %@" = "Über %@"; @@ -854,9 +854,9 @@ and put <tt>CFBundleName = "localized name";</tt> in each such file. \subsection osissues_retina OpenGL and 'retina' displays It is possible to have OpenGL produce graphics at the high pixel resolution allowed by the so-called 'retina' displays present on recent Apple hardware. -For this, call +For this, call \verbatim -Fl::use_high_res_GL(1); +Fl::use_high_res_GL(1); \endverbatim before any Fl_Gl_Window is shown. Also, adapt your Fl_Gl_Window::draw() and Fl_Gl_Window::draw_overlay() methods replacing \verbatim @@ -909,13 +909,13 @@ fluid". It is advisable to use the Finder for moving and copying and Mac archiving tools like Sit for distribution as they will -handle the Resource Fork correctly. +handle the Resource Fork correctly. \par Mac File Paths FLTK uses UTF-8-encoded UNIX-style filenames and paths. -\sa group_macosx +\sa group_macosx \htmlonly diff --git a/documentation/src/preface.dox b/documentation/src/preface.dox index ef3a6c155..ab61efc03 100644 --- a/documentation/src/preface.dox +++ b/documentation/src/preface.dox @@ -63,7 +63,7 @@ The X Window System version 11. The X Window System interface library. \par MS Windows, <tt>WIN32</tt> -The Microsoft Windows Application Programmer's Interface for Windows 2000, +The Microsoft Windows Application Programmer's Interface for Windows 2000, Windows XP, Windows Vista, Windows 7 and later Windows versions. FLTK uses the preprocessor definition <tt>_WIN32</tt> for the 32 bit and 64 bit MS Windows API. @@ -79,7 +79,7 @@ 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. -UNIX is a registered trademark of the X Open Group, Inc. +UNIX is a registered trademark of the X Open Group, Inc. Microsoft and Windows are registered trademarks of Microsoft Corporation. OpenGL is a registered trademark of Silicon Graphics, Inc. Apple, Macintosh, MacOS, and Mac OS X are diff --git a/documentation/src/subclassing.dox b/documentation/src/subclassing.dox index 0ae55489a..f2a41472e 100644 --- a/documentation/src/subclassing.dox +++ b/documentation/src/subclassing.dox @@ -1,6 +1,6 @@ /** - \page subclassing Adding and Extending Widgets + \page subclassing Adding and Extending Widgets This chapter describes how to add your own widgets or extend existing @@ -12,18 +12,18 @@ New widgets are created by \e subclassing an existing FLTK widget, typically Fl_Widget for controls and Fl_Group for composite widgets. A control widget typically interacts with the user to receive and/or -display a value of some sort. +display a value of some sort. A composite widget holds a list of child widgets and handles moving, sizing, showing, or hiding them as needed. Fl_Group is the main composite widget class in FLTK, and all of the other composite widgets -(Fl_Pack, Fl_Scroll, Fl_Tabs, Fl_Tile, and Fl_Window) are subclasses of it. +(Fl_Pack, Fl_Scroll, Fl_Tabs, Fl_Tile, and Fl_Window) are subclasses of it. You can also subclass other existing widgets to provide a different look or user-interface. For example, the button widgets are all subclasses of Fl_Button since they all interact with the user via a mouse button click. The only difference is the code that draws -the face of the button. +the face of the button. \section subclassing_fl_widget Making a Subclass of Fl_Widget @@ -44,7 +44,7 @@ This will allow the class to be used in without problems. The constructor must call the constructor for the base class and -pass the same arguments: +pass the same arguments: \code MyClass::MyClass(int x, int y, int w, int h, const char *label) @@ -107,7 +107,7 @@ The second form indicates that a region is damaged. If only these calls are done in a window (no calls to \p damage(n)) then FLTK will clip to the union of all these calls before drawing anything. This can greatly speed up incremental displays. The mask bits are -OR'd into \p damage() unless this is a Fl_Window widget. +OR'd into \p damage() unless this is a Fl_Window widget. \par The third form returns the bitwise-OR of all \p damage(n) @@ -171,13 +171,13 @@ draw those labels). \par The second form uses the passed bounding box instead of the widget's bounding box. This is useful so "centered" labels are aligned with some -feature, like a moving slider. +feature, like a moving slider. \par The third form draws the label anywhere. It acts as though \p FL_ALIGN_INSIDE has been forced on so the label will appear inside the passed bounding box. This is designed for parent groups to draw -labels with. +labels with. \anchor subclassing_set_flag void Fl_Widget::set_flag(int c) <br> @@ -201,15 +201,15 @@ int Fl_Widget::test_shortcut() <br> static int Fl_Widget::test_shortcut(const char *s) \par -The first version tests Fl_Widget::label() against the current event -(which should be a \p FL_SHORTCUT event). If the label contains a '&' +The first version tests Fl_Widget::label() against the current event +(which should be a \p FL_SHORTCUT event). If the label contains a '&' character and the character after it matches the keypress, this returns -true. This returns false if the \p SHORTCUT_LABEL flag is off, if the -label is \p NULL, or does not have a '&' character in it, or if the +true. This returns false if the \p SHORTCUT_LABEL flag is off, if the +label is \p NULL, or does not have a '&' character in it, or if the keypress does not match the character. \par -The second version lets you do this test against an arbitrary string. +The second version lets you do this test against an arbitrary string. \todo Clarify Fl_Widget::test_shortcut() explanations. Fl_Widget.h says Internal Use only, but subclassing chapter gives details! @@ -236,21 +236,21 @@ be greater than the symbol \p FL_RESERVED_TYPE (which is 100) and less than \p FL_WINDOW (unless you make a subclass of Fl_Window). Look through the header files for \p FL_RESERVED_TYPE to find an unused number. If you make a subclass of Fl_Window you must use -<tt>FL_WINDOW + n</tt> (where \p n must be in the range 1 to 7). +<tt>FL_WINDOW + n</tt> (where \p n must be in the range 1 to 7). \section subclassing_events Handling Events The virtual method Fl_Widget::handle(int event) is called to handle each event passed to the widget. It can: -\li Change the state of the widget. -\li Call Fl_Widget::redraw() if the widget needs to be redisplayed. +\li Change the state of the widget. +\li Call Fl_Widget::redraw() if the widget needs to be redisplayed. \li Call Fl_Widget::damage(uchar c) if the widget needs a partial-update (assuming you provide support for this in your \ref subclassing_drawing "draw()" - method). -\li Call Fl_Widget::do_callback() if a callback should be generated. -\li Call Fl_Widget::handle() on child widgets. + method). +\li Call Fl_Widget::do_callback() if a callback should be generated. +\li Call Fl_Widget::handle() on child widgets. Events are identified by the integer argument. Other information about the most recent event is stored in static locations and acquired @@ -259,7 +259,7 @@ by calling the This information remains valid until another event is handled. Here is a sample \p handle() method for a widget that acts as -a pushbutton and also accepts the keystroke \p 'x' to cause the callback: +a pushbutton and also accepts the keystroke \p 'x' to cause the callback: \code int MyClass::handle(int event) { @@ -272,23 +272,23 @@ int MyClass::handle(int event) { int t = Fl::event_inside(this); if (t != highlight) { highlight = t; - redraw(); - } + redraw(); + } } return 1; case FL_RELEASE: if (highlight) { - highlight = 0; - redraw(); + highlight = 0; + redraw(); do_callback(); - // never do anything after a callback, as the callback - // may delete the widget! + // never do anything after a callback, as the callback + // may delete the widget! } return 1; case FL_SHORTCUT: if (Fl::event_key() == 'x') { do_callback(); - return 1; + return 1; } return 0; default: @@ -301,10 +301,10 @@ You must return non-zero if your \p handle() method uses the event. If you return zero, the parent widget will try sending the event to another widget. -For debugging purposes, event numbers can be printed as their actual event names +For debugging purposes, event numbers can be printed as their actual event names using the \ref fl_eventnames[] array, e.g.: \code - #include <FL/names.h> // defines fl_eventnames[] + #include <FL/names.h> // defines fl_eventnames[] [..] int MyClass::handle(int e) { printf("Event was %s (%d)\n", fl_eventnames[e], e); // e.g. "Event was FL_PUSH (1)" @@ -325,15 +325,15 @@ the \p damage(n) calls to this widget since it was last drawn. This can be used for minimal update, by only redrawing the parts whose bits are set. FLTK will turn on the \p FL_DAMAGE_ALL bit if it thinks the entire widget must -be redrawn, e.g. for an expose event. +be redrawn, e.g. for an expose event. -Expose events (and the -\ref subclassing_damage "damage(mask,x,y,w,h)" function described +Expose events (and the +\ref subclassing_damage "damage(mask,x,y,w,h)" function described above) will cause \p draw() to be called with FLTK's \ref ssect_Clipping "clipping" turned on. You can greatly speed up redrawing in some cases by testing \p fl_not_clipped(x,y,w,h) or \p %fl_clip_box() -and skipping invisible parts. +and skipping invisible parts. Besides the protected methods described above, FLTK provides a large number of basic drawing functions, which are described in the chapter @@ -350,7 +350,7 @@ actually change. This should \e not call \p redraw(), at least if only the \p x() and \p y() change. This is because composite widgets like -Fl_Scroll may have a more efficient way of drawing the new position. +Fl_Scroll may have a more efficient way of drawing the new position. \section subclassing_composite Making a Composite Widget @@ -360,7 +360,7 @@ It is possible to make a composite object that is not a subclass of Fl_Group, but you'll have to duplicate the code in Fl_Group anyways. -Instances of the child widgets may be included in the parent: +Instances of the child widgets may be included in the parent: \code class MyClass : public Fl_Group { @@ -370,7 +370,7 @@ class MyClass : public Fl_Group { }; \endcode -The constructor has to initialize these instances. They are automatically +The constructor has to initialize these instances. They are automatically added to the group, since the Fl_Group constructor does Fl_Group::begin(). <I>Don't forget to call Fl_Group::end() or use the Fl_End pseudo-class:</I> @@ -501,7 +501,7 @@ system specific. See \ref osissues for more details. FLTK provides routines to drag and drop UTF-8 encoded text between applications: -Drag'n'drop operations are initiated by copying data to the +Drag'n'drop operations are initiated by copying data to the clipboard and calling the function Fl::dnd(). Drop attempts are handled via the following events, @@ -525,7 +525,7 @@ that expects a system window ID to indicate where to draw. Subclassing Fl_Window is almost exactly like subclassing Fl_Group, and in fact you can easily switch a subclass back and forth. Watch out for the following -differences: +differences: -# Fl_Window is a subclass of Fl_Group so <I>make sure your constructor calls</I> \p end() diff --git a/documentation/src/sudoku.man b/documentation/src/sudoku.man index 32d496e8e..f72d4e245 100644 --- a/documentation/src/sudoku.man +++ b/documentation/src/sudoku.man @@ -28,6 +28,6 @@ with the actual number to use. .SH SEE ALSO fltk(3) .br -FLTK Web Site, http://www.fltk.org/ +FLTK Web Site, https://www.fltk.org/ .SH AUTHOR Michael R Sweet. diff --git a/documentation/src/unicode.dox b/documentation/src/unicode.dox index 63f8bb773..4d74f9931 100644 --- a/documentation/src/unicode.dox +++ b/documentation/src/unicode.dox @@ -484,7 +484,7 @@ converts the strings to lower case Unicode as part of the comparison. \b OksiD - char* fl_getenv(const char* name) \b OksiD -- char fl_make_path(const char* path) - returns char ? +- char fl_make_path(const char* path) - returns char ? \b OksiD - void fl_make_path_for_file(const char* path) \b OksiD |