diff options
| author | Matthias Melcher <github@matthiasm.com> | 2024-04-17 17:51:32 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-04-17 17:51:32 +0200 |
| commit | fd791a068e39e06785adc44693f4c533d3d6c903 (patch) | |
| tree | ef7ff684b38f646165e80c142e454cd7ef077e2e /fluid/documentation | |
| parent | b4cf1a9824f2c4ba9596044962d3af36e3ca3d99 (diff) | |
Separate FLUID user documentation, screen shot automation (#936)
* CMake integration, no autotiools
* alignment panel is now correctly renamed to setting panel
* source view is now correctly renamed to code view
* Merge FLTK FLUID docs into FLUID user manual.
* Add two simple entry tutorials
* Remove FLUID chapter form FLTK docs.
* GitHub action to generate HTML and PDF docs and
make the available as artefacts
Diffstat (limited to 'fluid/documentation')
54 files changed, 5778 insertions, 0 deletions
diff --git a/fluid/documentation/CMakeLists.txt b/fluid/documentation/CMakeLists.txt new file mode 100644 index 000000000..fb2fac442 --- /dev/null +++ b/fluid/documentation/CMakeLists.txt @@ -0,0 +1,232 @@ +# +# CMakeLists.txt to build docs for the FLTK project using CMake (www.cmake.org) +# +# Copyright 1998-2024 by Bill Spitzak and others. +# +# This library is free software. Distribution and use rights are outlined in +# the file "COPYING" which should have been included with this file. If this +# file is missing or damaged, see the license at: +# +# https://www.fltk.org/COPYING.php +# +# Please see the following page on how to report bugs and issues: +# +# https://www.fltk.org/bugs.php +# + +set(DOCS) +set(GIT_REVISION "") +set(YEAR "") +set(CURRENT_DATE "") + +#------------------------------------------------ +# generate files used for both HTML and PDF docs +#------------------------------------------------ + +if(FLTK_BUILD_FLUID_DOCS OR FLTK_BUILD_PDF_DOCS) + + # create required variables + + execute_process(COMMAND date "+%Y" + OUTPUT_VARIABLE YEAR + OUTPUT_STRIP_TRAILING_WHITESPACE + ) + + # note: current locale is used for abbreviated month + execute_process(COMMAND date "+%b %d, %Y" + OUTPUT_VARIABLE CURRENT_DATE + OUTPUT_STRIP_TRAILING_WHITESPACE + ) + + # find git revision + + # FIXME: This must also work with tarballs where git is not available. + # For now we just ignore errors and set GIT_REVISION = "unknown". + # In the future tarball/zip generation should create a file + # that contains the git revision. + + execute_process(COMMAND + git rev-parse --short=10 HEAD + OUTPUT_VARIABLE GIT_REVISION + OUTPUT_STRIP_TRAILING_WHITESPACE + WORKING_DIRECTORY ${FLTK_SOURCE_DIR} + ERROR_QUIET + ) + + # set to "'unknown'" if git is not available + if(GIT_REVISION STREQUAL "") + set(GIT_REVISION "'unknown'") + endif() + + # Find "short" doxygen version if it was built from Git + # Note: this is still needed in CMake 3.12.0 but later CMake versions + # (notably 3.25) remove the Git revision in 'DOXYGEN_VERSION'. + # Todo: Find the "first good" CMake version and remove this redundant + # code once we require this as our minimal version and replace the + # variable DOXYGEN_VERSION_SHORT with DOXYGEN_VERSION below. + + if(DOXYGEN_FOUND) + # strip trailing git revision if doxygen was built from source + string(REGEX REPLACE " .*$" "" DOXYGEN_VERSION_SHORT ${DOXYGEN_VERSION}) + endif(DOXYGEN_FOUND) + + # configure copyright.dox (includes current year) + configure_file( + ${CMAKE_CURRENT_SOURCE_DIR}/copyright.dox.in + ${CMAKE_CURRENT_BINARY_DIR}/copyright.dox + @ONLY + ) + + # configure generated.dox (includes date and versions) + configure_file( + ${CMAKE_CURRENT_SOURCE_DIR}/generated.dox.in + ${CMAKE_CURRENT_BINARY_DIR}/generated.dox + @ONLY + ) + +endif(FLTK_BUILD_FLUID_DOCS OR FLTK_BUILD_PDF_DOCS) + +#------------------------------- +# build FLUID html documentation +#------------------------------- + +if(FLTK_BUILD_FLUID_DOCS) + + #list(APPEND DOCS html) + + # generate Doxygen file "Doxyfile" + + set(GENERATE_FLUID_HTML YES) + set(GENERATE_LATEX NO) + set(LATEX_HEADER "") + set(FL_HTML_INDEX "FL_HTML_INDEX") + set(DOXYFILE "Doxyfile") + set(LOGFILE "${CMAKE_CURRENT_BINARY_DIR}/${DOXYFILE}_error.log") + + # configure Doxygen input file for HTML docs (Doxyfile.in) + + configure_file( + ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in + ${CMAKE_CURRENT_BINARY_DIR}/${DOXYFILE}.in + @ONLY + ) + + # convert Doxyfile to used doxygen version + + add_custom_command( + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${DOXYFILE} + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/convert_doxyfile + ${DOXYGEN_EXECUTABLE} + ${DOXYFILE}.in + ${DOXYFILE} + ${LOGFILE} + BYPRODUCTS ${LOGFILE} + COMMENT "Converting ${DOXYFILE} to doxygen version ${DOXYGEN_VERSION_SHORT}" VERBATIM + ) + + # generate screen shot using FLUID --autodoc target_dir + # generate HTML documentation + + add_custom_target(fluid_docs + COMMAND mkdir -p ${CMAKE_CURRENT_BINARY_DIR}/src/ + COMMAND fltk::fluid -scheme gtk+ --autodoc ${CMAKE_CURRENT_BINARY_DIR}/src/ + COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE} + DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${DOXYFILE} + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating HTML documentation" VERBATIM + ) + add_dependencies(fluid_docs fltk::fluid) + +endif(FLTK_BUILD_FLUID_DOCS) + +#-------------------------- +# build pdf documentation +#-------------------------- + +if(FLTK_BUILD_PDF_DOCS AND FLTK_BUILD_FLUID_DOCS) + + # generate Doxygen input file "Doxybook" + + set(GENERATE_FLUID_HTML NO) + set(GENERATE_LATEX YES) + set(LATEX_HEADER "${CMAKE_CURRENT_BINARY_DIR}/fluid-book.tex") + set(FL_HTML_INDEX "FL_NO_HTML_INDEX") + set(DOXYFILE "Doxybook") + set(LOGFILE "${CMAKE_CURRENT_BINARY_DIR}/${DOXYFILE}_error.log") + + # configure Doxygen input file for PDF docs (Doxybook.in) + + configure_file( + ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in + ${CMAKE_CURRENT_BINARY_DIR}/${DOXYFILE}.in + @ONLY + ) + + # convert Doxybook to current doxygen version + + add_custom_command( + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${DOXYFILE} + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/convert_doxyfile + ${DOXYGEN_EXECUTABLE} + ${DOXYFILE}.in + ${DOXYFILE} + ${LOGFILE} + BYPRODUCTS ${LOGFILE} + COMMENT "Converting ${DOXYFILE} to doxygen version ${DOXYGEN_VERSION_SHORT}" VERBATIM + ) + + # generate LaTeX title fluid-title.tex + + configure_file( + ${CMAKE_CURRENT_SOURCE_DIR}/src/fluid-title.tex.in + ${CMAKE_CURRENT_BINARY_DIR}/fluid-title.tex + @ONLY + ) + + # generate fluid.pdf + + add_custom_command( + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/fluid.pdf + COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/make_header + ${DOXYGEN_EXECUTABLE} + ${CMAKE_CURRENT_BINARY_DIR}/fluid-title.tex + ${CMAKE_CURRENT_BINARY_DIR}/fluid-book.tex + COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE} + COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/make_pdf + COMMAND cp -f latex/refman.pdf fluid.pdf + DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${DOXYFILE} + ${CMAKE_CURRENT_BINARY_DIR}/fluid-title.tex + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating FLUID PDF documentation" VERBATIM + ) + + # add target 'pdf' + + add_custom_target(fluid_pdf + DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/fluid.pdf + ) + add_dependencies(fluid_pdf fluid_docs) + +endif(FLTK_BUILD_PDF_DOCS AND FLTK_BUILD_FLUID_DOCS) + +#--------------------------------------- +# install FLUID html + pdf documentation +#--------------------------------------- + +if(FLTK_INSTALL_FLUID_DOCS AND FLTK_BUILD_FLUID_DOCS) + + install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html + DESTINATION ${FLTK_DATADIR}/doc/fltk/fluid + ) + +endif(FLTK_INSTALL_FLUID_DOCS AND FLTK_BUILD_FLUID_DOCS) + +if(FLTK_INSTALL_PDF_DOCS AND FLTK_BUILD_PDF_DOCS AND FLTK_BUILD_FLUID_DOCS) + + install(FILES ${CMAKE_CURRENT_BINARY_DIR}/fluid.pdf + DESTINATION ${FLTK_DATADIR}/doc/fltk/ + ) + +endif(FLTK_INSTALL_PDF_DOCS AND FLTK_BUILD_PDF_DOCS AND FLTK_BUILD_FLUID_DOCS) diff --git a/fluid/documentation/Doxyfile.in b/fluid/documentation/Doxyfile.in new file mode 100644 index 000000000..f625dd52a --- /dev/null +++ b/fluid/documentation/Doxyfile.in @@ -0,0 +1,2485 @@ +# Doxyfile 1.8.14 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "FLUID for FLTK @FLTK_VERSION@" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = . + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = NO + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = YES + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if <section_label> ... \endif and \cond <section_label> +# ... \endcond blocks. + +ENABLED_SECTIONS = @FL_HTML_INDEX@ + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = YES + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = NO + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/index.dox \ + @CMAKE_CURRENT_SOURCE_DIR@/src/page_introduction.dox \ + @CMAKE_CURRENT_SOURCE_DIR@/src/page_commandline.dox \ + @CMAKE_CURRENT_SOURCE_DIR@/src/page_interactive.dox \ + @CMAKE_CURRENT_SOURCE_DIR@/src/page_main_window.dox \ + @CMAKE_CURRENT_SOURCE_DIR@/src/page_widgetbin_panel.dox \ + @CMAKE_CURRENT_SOURCE_DIR@/src/page_edit_window.dox \ + @CMAKE_CURRENT_SOURCE_DIR@/src/page_functional_nodes.dox \ + @CMAKE_CURRENT_SOURCE_DIR@/src/page_widget_panel.dox \ + @CMAKE_CURRENT_SOURCE_DIR@/src/page_setting_dialog.dox \ + @CMAKE_CURRENT_SOURCE_DIR@/src/page_codeview_panel.dox \ + @CMAKE_CURRENT_SOURCE_DIR@/src/page_tutorial.dox \ + @CMAKE_CURRENT_SOURCE_DIR@/src/page_appendices.dox + +# @FLTK_SOURCE_DIR@/fluid + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.H \ + *.h \ + *.c \ + *.cxx \ + *.dox + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = +# @FLTK_SOURCE_DIR@/src/drivers/ + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = +# */src/*_win32.cxx \ +# */src/*_mac.cxx \ +# */src/*_x.cxx \ +# */src/xdg* \ +# */src/text-input* + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = +# @CMAKE_CURRENT_SOURCE_DIR@/../test \ +# @CMAKE_CURRENT_SOURCE_DIR@/../examples \ +# @CMAKE_CURRENT_BINARY_DIR@ \ +# @CMAKE_CURRENT_SOURCE_DIR@ + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = *.cxx \ + *.h \ + *.H \ + *.fl + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/src \ + @CMAKE_CURRENT_BINARY_DIR@/src + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# <filter> <input-file> +# +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = +# fl_ \ +# FL_ \ +# Fl_ + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = @GENERATE_FLUID_HTML@ + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +# Note: since doxygen 1.9.5 + +HTML_COLORSTYLE = TOGGLE + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via Javascript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have Javascript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: https://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = YES + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://doc.qt.io/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://doc.qt.io/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://doc.qt.io/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/ + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use <access key> + S +# (what the <access key> is depends on the OS and browser, but it is typically +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down +# key> to jump into the search results window, the results can be navigated +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel +# the search. The filter options can be selected when the cursor is inside the +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> +# to select a filter and <Enter> or <escape> to activate or cancel the filter +# option. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a web server instead of a web client using Javascript. There +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH +# setting. When disabled, doxygen will generate a PHP script for searching and +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing +# and searching needs to be provided by external tools. See the section +# "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SERVER_BASED_SEARCH = NO + +# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP +# script for searching. Instead the search results are written to an XML file +# which needs to be processed by an external indexer. Doxygen will invoke an +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the +# search results. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: https://xapian.org/). +# +# See the section "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH = NO + +# The SEARCHENGINE_URL should point to a search engine hosted by a web server +# which will return the search results when EXTERNAL_SEARCH is enabled. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: https://xapian.org/). See the section "External Indexing and +# Searching" for details. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHENGINE_URL = + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed +# search data is written to a file for indexing by an external tool. With the +# SEARCHDATA_FILE tag the name of this file can be specified. +# The default file is: searchdata.xml. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHDATA_FILE = searchdata.xml + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple +# projects and redirect the results back to the right project. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH_ID = + +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# projects other than the one defined by this configuration file, but that are +# all added to the same external search index. Each project needs to have a +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of +# to a relative location where the documentation can be found. The format is: +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTRA_SEARCH_MAPPINGS = + +#--------------------------------------------------------------------------- +# Configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. +# The default value is: YES. + +GENERATE_LATEX = @GENERATE_LATEX@ + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: latex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. +# +# Note that when enabling USE_PDFLATEX this option is only used for generating +# bitmaps for formulas in the HTML output, but not in the Makefile that is +# written to the output directory. +# The default file is: latex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate +# index for LaTeX. +# The default file is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX +# documents. This may be useful for small projects and may help to save some +# trees in general. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used by the +# printer. +# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x +# 14 inches) and executive (7.25 x 10.5 inches). +# The default value is: a4. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names +# that should be included in the LaTeX output. The package can be specified just +# by its name or with the correct syntax as to be used with the LaTeX +# \usepackage command. To get the times font for instance you can specify : +# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} +# To use the option intlimits with the amsmath package you can specify: +# EXTRA_PACKAGES=[intlimits]{amsmath} +# If left blank no extra packages will be included. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the +# generated LaTeX document. The header should contain everything until the first +# chapter. If it is left blank doxygen will generate a standard header. See +# section "Doxygen usage" for information on how to let doxygen write the +# default header to a separate file. +# +# Note: Only use a user-defined header if you know what you are doing! The +# following commands have a special meaning inside the header: $title, +# $datetime, $date, $doxygenversion, $projectname, $projectnumber, +# $projectbrief, $projectlogo. Doxygen will replace $title with the empty +# string, for the replacement values of the other commands the user is referred +# to HTML_HEADER. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_HEADER = @LATEX_HEADER@ + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the +# generated LaTeX document. The footer should contain everything after the last +# chapter. If it is left blank doxygen will generate a standard footer. See +# LATEX_HEADER for more information on how to generate a default footer and what +# special commands can be used inside the footer. +# +# Note: Only use a user-defined footer if you know what you are doing! +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_FOOTER = + +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# LaTeX style sheets that are included after the standard style sheets created +# by doxygen. Using this option one can overrule certain style aspects. Doxygen +# will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_STYLESHEET = + +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the LATEX_OUTPUT output +# directory. Note that the files will be copied as-is; there are no commands or +# markers available. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_FILES = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is +# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will +# contain links (just like the HTML output) instead of page references. This +# makes the output suitable for online browsing using a PDF viewer. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate +# the PDF file directly from the LaTeX files. Set this option to YES, to get a +# higher quality PDF documentation. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode +# command to the generated LaTeX files. This will instruct LaTeX to keep running +# if errors occur, instead of asking the user for help. This option is also used +# when generating formulas in HTML. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_BATCHMODE = YES + +# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the +# index chapters (such as File Index, Compound Index, etc.) in the output. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_HIDE_INDICES = NO + +# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source +# code with syntax highlighting in the LaTeX output. +# +# Note that which sources are shown also depends on other settings such as +# SOURCE_BROWSER. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. See +# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. +# The default value is: plain. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_BIB_STYLE = plain + +# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_TIMESTAMP = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The +# RTF output is optimized for Word 97 and may not look too pretty with other RTF +# readers/editors. +# The default value is: NO. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: rtf. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF +# documents. This may be useful for small projects and may help to save some +# trees in general. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will +# contain hyperlink fields. The RTF file will contain links (just like the HTML +# output) instead of page references. This makes the output suitable for online +# browsing using Word or some other Word compatible readers that support those +# fields. +# +# Note: WordPad (write) and others do not support links. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's config +# file, i.e. a series of assignments. You only have to provide replacements, +# missing definitions are set to their default value. +# +# See also section "Doxygen usage" for information on how to generate the +# default style sheet that doxygen normally uses. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an RTF document. Syntax is +# similar to doxygen's config file. A template extensions file can be generated +# using doxygen -e rtf extensionFile. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_EXTENSIONS_FILE = + +# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code +# with syntax highlighting in the RTF output. +# +# Note that which sources are shown also depends on other settings such as +# SOURCE_BROWSER. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_SOURCE_CODE = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for +# classes and files. +# The default value is: NO. + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. A directory man3 will be created inside the directory specified by +# MAN_OUTPUT. +# The default directory is: man. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to the generated +# man pages. In case the manual section does not start with a number, the number +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is +# optional. +# The default value is: .3. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_EXTENSION = .3 + +# The MAN_SUBDIR tag determines the name of the directory created within +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by +# MAN_EXTENSION with the initial . removed. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_SUBDIR = + +# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it +# will generate one additional man file for each entity documented in the real +# man page(s). These additional files only source the real man page, but without +# them the man command would be unable to find the correct page. +# The default value is: NO. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that +# captures the structure of the code including all documentation. +# The default value is: NO. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: xml. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_OUTPUT = xml + +# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program +# listings (including syntax highlighting and cross-referencing information) to +# the XML output. Note that enabling this will significantly increase the size +# of the XML output. +# The default value is: YES. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the DOCBOOK output +#--------------------------------------------------------------------------- + +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files +# that can be used to generate PDF. +# The default value is: NO. + +GENERATE_DOCBOOK = NO + +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in +# front of it. +# The default directory is: docbook. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_OUTPUT = docbook + +# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the +# program listings (including syntax highlighting and cross-referencing +# information) to the DOCBOOK output. Note that enabling this will significantly +# increase the size of the DOCBOOK output. +# The default value is: NO. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_PROGRAMLISTING = NO + +#--------------------------------------------------------------------------- +# Configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an +# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures +# the structure of the code including all documentation. Note that this feature +# is still experimental and incomplete at the moment. +# The default value is: NO. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module +# file that captures the structure of the code including all documentation. +# +# Note that this feature is still experimental and incomplete at the moment. +# The default value is: NO. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary +# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI +# output from the Perl module output. +# The default value is: NO. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely +# formatted so it can be parsed by a human reader. This is useful if you want to +# understand what is going on. On the other hand, if this tag is set to NO, the +# size of the Perl module output will be much smaller and Perl will parse it +# just the same. +# The default value is: YES. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file are +# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful +# so different doxyrules.make files included by the same Makefile don't +# overwrite each other's variables. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all +# C-preprocessor directives found in the sources and include files. +# The default value is: YES. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names +# in the source code. If set to NO, only conditional compilation will be +# performed. Macro expansion can be done in a controlled way by setting +# EXPAND_ONLY_PREDEF to YES. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +MACRO_EXPANSION = YES + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then +# the macro expansion is limited to the macros specified with the PREDEFINED and +# EXPAND_AS_DEFINED tags. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +EXPAND_ONLY_PREDEF = YES + +# If the SEARCH_INCLUDES tag is set to YES, the include files in the +# INCLUDE_PATH will be searched if a #include is found. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by the +# preprocessor. +# This tag requires that the tag SEARCH_INCLUDES is set to YES. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will be +# used. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that are +# defined before the preprocessor is started (similar to the -D option of e.g. +# gcc). The argument of the tag is a list of macros of the form: name or +# name=definition (no spaces). If the definition and the "=" are omitted, "=1" +# is assumed. To prevent a macro definition from being undefined via #undef or +# recursively expanded use the := operator instead of the = operator. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +PREDEFINED = FL_DOXYGEN \ + FL_ABI_VERSION=99999 \ + FLTK_HAVE_CAIRO \ + HAVE_GL \ + HAVE_GL_OVERLAY \ + FL_EXPORT:= \ + __cplusplus + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this +# tag can be used to specify a list of macro names that should be expanded. The +# macro definition that is found in the sources will be used. Use the PREDEFINED +# tag if you want to use a different macro definition that overrules the +# definition found in the source code. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +EXPAND_AS_DEFINED = FL_DEPRECATED + +# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will +# remove all references to function-like macros that are alone on a line, have +# an all uppercase name, and do not end with a semicolon. Such function macros +# are typically used for boiler-plate code, and will confuse the parser if not +# removed. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES tag can be used to specify one or more tag files. For each tag +# file the location of the external documentation should be added. The format of +# a tag file without this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where loc1 and loc2 can be relative or absolute paths or URLs. See the +# section "Linking to external documentation" for more information about the use +# of tag files. +# Note: Each tag file must have a unique name (where the name does NOT include +# the path). If a tag file is not located in the directory in which doxygen is +# run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create a +# tag file that is based on the input files it reads. See section "Linking to +# external documentation" for more information about the usage of tag files. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in +# the class index. If set to NO, only the inherited external classes will be +# listed. +# The default value is: NO. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will be +# listed. +# The default value is: YES. + +EXTERNAL_GROUPS = YES + +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in +# the related pages index. If set to NO, only the current project's pages will +# be listed. +# The default value is: YES. + +EXTERNAL_PAGES = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of 'which perl'). +# The default file (with absolute path) is: /usr/bin/perl. + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram +# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to +# NO turns the diagrams off. Note that this option also works with HAVE_DOT +# disabled, but it is recommended to install and use dot, since it yields more +# powerful graphs. +# The default value is: YES. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see: +# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# You can include diagrams made with dia in doxygen documentation. Doxygen will +# then run dia to produce the diagram and insert it in the documentation. The +# DIA_PATH tag allows you to specify the directory where the dia binary resides. +# If left empty dia is assumed to be found in the default search path. + +DIA_PATH = + +# If set to YES the inheritance and collaboration graphs will hide inheritance +# and usage relations if the target is undocumented or is not a class. +# The default value is: YES. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz (see: +# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent +# Bell Labs. The other options in this section have no effect if this option is +# set to NO +# The default value is: NO. + +HAVE_DOT = NO + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed +# to run in parallel. When set to 0 doxygen will base this on the number of +# processors available in the system. You can set it explicitly to a value +# larger than 0 to get control over the balance between CPU load and processing +# speed. +# Minimum value: 0, maximum value: 32, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_NUM_THREADS = 0 + +# When you want a differently looking font in the dot files that doxygen +# generates you can specify the font name using DOT_FONTNAME. You need to make +# sure dot is able to find the font, which can be done by putting it in a +# standard location or by setting the DOTFONTPATH environment variable or by +# setting DOT_FONTPATH to the directory containing the font. +# The default value is: Helvetica. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of +# dot graphs. +# Minimum value: 4, maximum value: 24, default value: 10. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the default font as specified with +# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set +# the path where dot can find it using this tag. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTPATH = + +# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for +# each documented class showing the direct and indirect inheritance relations. +# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a +# graph for each documented class showing the direct and indirect implementation +# dependencies (inheritance, containment, and class references variables) of the +# class with other documented classes. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for +# groups, showing the direct groups dependencies. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +UML_LOOK = NO + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the +# class node. If there are many fields or methods and many nodes the graph may +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the +# number of items for each type to make the size more manageable. Set this to 0 +# for no limit. Note that the threshold may be exceeded by 50% before the limit +# is enforced. So when you set the threshold to 10, up to 15 fields may appear, +# but if the number exceeds 15, the total amount of fields shown is limited to +# 10. +# Minimum value: 0, maximum value: 100, default value: 10. +# This tag requires that the tag HAVE_DOT is set to YES. + +UML_LIMIT_NUM_FIELDS = 10 + +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and +# collaboration graphs will show the relations between templates and their +# instances. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +TEMPLATE_RELATIONS = NO + +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to +# YES then doxygen will generate a graph for each documented file showing the +# direct and indirect include dependencies of the file with other documented +# files. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +INCLUDE_GRAPH = YES + +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are +# set to YES then doxygen will generate a graph for each documented file showing +# the direct and indirect include dependencies of the file with other documented +# files. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH tag is set to YES then doxygen will generate a call +# dependency graph for every global function or class method. +# +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. Disabling a call graph can be +# accomplished by means of the command \hidecallgraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller +# dependency graph for every global function or class method. +# +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable caller graphs for selected +# functions only using the \callergraph command. Disabling a caller graph can be +# accomplished by means of the command \hidecallergraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical +# hierarchy of all classes instead of a textual one. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the +# dependencies a directory has on other directories in a graphical way. The +# dependency relations are determined by the #include relations between the +# files in the directories. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. For an explanation of the image formats see the section +# output formats in the documentation of the dot tool (Graphviz (see: +# http://www.graphviz.org/)). +# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order +# to make the SVG files visible in IE 9+ (other browsers do not have this +# requirement). +# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and +# png:gdiplus:gdiplus. +# The default value is: png. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# +# Note that this requires a modern browser other than Internet Explorer. Tested +# and working are Firefox, Chrome, Safari, and Opera. +# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make +# the SVG files visible. Older versions of IE do not have SVG support. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +INTERACTIVE_SVG = NO + +# The DOT_PATH tag can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the \dotfile +# command). +# This tag requires that the tag HAVE_DOT is set to YES. + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the \mscfile +# command). + +MSCFILE_DIRS = + +# The DIAFILE_DIRS tag can be used to specify one or more directories that +# contain dia files that are included in the documentation (see the \diafile +# command). + +DIAFILE_DIRS = + +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the +# path where java can find the plantuml.jar file. If left blank, it is assumed +# PlantUML is not used or called during a preprocessing step. Doxygen will +# generate a warning when it encounters a \startuml command in this case and +# will not generate output for the diagram. + +PLANTUML_JAR_PATH = + +# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for plantuml. + +PLANTUML_CFG_FILE = + +# When using plantuml, the specified paths are searched for files specified by +# the !include statement in a plantuml block. + +PLANTUML_INCLUDE_PATH = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes +# that will be shown in the graph. If the number of nodes in a graph becomes +# larger than this value, doxygen will truncate the graph, which is visualized +# by representing a node as a red box. Note that doxygen if the number of direct +# children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that +# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. +# Minimum value: 0, maximum value: 10000, default value: 50. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs +# generated by dot. A depth value of 3 means that only nodes reachable from the +# root by following a path via at most 3 edges will be shown. Nodes that lay +# further from the root node will be omitted. Note that setting this option to 1 +# or 2 may greatly reduce the computation time needed for large code bases. Also +# note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. +# Minimum value: 0, maximum value: 1000, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not seem +# to support this out of the box. +# +# Warning: Depending on the platform used, enabling this option may lead to +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to +# read). +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) support +# this, this feature is disabled by default. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page +# explaining the meaning of the various boxes and arrows in the dot generated +# graphs. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot +# files that are used to generate the various graphs. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_CLEANUP = YES diff --git a/fluid/documentation/convert_doxyfile b/fluid/documentation/convert_doxyfile new file mode 100755 index 000000000..1e06e760a --- /dev/null +++ b/fluid/documentation/convert_doxyfile @@ -0,0 +1,44 @@ +#!/bin/sh +# +# Convert 'Doxyfile.in' to 'Doxyfile' or 'Doxybook' for doxygen docs +# +# Usage: +# +# $ sh convert_doxyfile doxygen_path input output logfile +# +# where +# - 'doxygen_path' is the full path to the doxygen executable or just +# 'doxygen' if this is in the user's PATH. If the full path is used +# an arbitrary doxygen executable and thus doxygen version can be used. +# - 'input' is the file 'Doxyfile.in' stored in Git or any other file. +# - 'output' is the generated doxygen file, usually either 'Doxyfile' +# or 'Doxybook' which will be used subsequently to generate the +# HTML or PDF docs, respectively. +# +# Doxygen warnings and errors are stored in 'logfile' for review. +# +#======================================================================= +# This script requires a posix shell and uses the following commands: +# 'echo', 'date', and (obviously) doxygen. +#======================================================================= + +# doxygen command, input and output file names + +DOXYGEN="$1" + INFILE="$2" +OUTFILE="$3" +LOGFILE="$4" + +# get doxygen version + +VERSION=$("$DOXYGEN" --version) + +# write info header to LOGFILE + +echo "$OUTFILE created by doxygen version $VERSION" > $LOGFILE +echo " at `date`" >> $LOGFILE +echo "" >> $LOGFILE + +# convert doxygen file and append errors and warnings to LOGFILE + +"${DOXYGEN}" -u -s - < $INFILE > $OUTFILE 2>> $LOGFILE diff --git a/fluid/documentation/copyright.dox.in b/fluid/documentation/copyright.dox.in new file mode 100644 index 000000000..990de8844 --- /dev/null +++ b/fluid/documentation/copyright.dox.in @@ -0,0 +1 @@ +Copyright © 1998 - @YEAR@ by Bill Spitzak and others. diff --git a/fluid/documentation/generated.dox.in b/fluid/documentation/generated.dox.in new file mode 100644 index 000000000..9ab6987e0 --- /dev/null +++ b/fluid/documentation/generated.dox.in @@ -0,0 +1,6 @@ +<br> +<small> + Generated on @CURRENT_DATE@ + from Git revision @GIT_REVISION@ + by Doxygen @DOXYGEN_VERSION_SHORT@ +</small> diff --git a/fluid/documentation/make_header b/fluid/documentation/make_header new file mode 100755 index 000000000..58df10af2 --- /dev/null +++ b/fluid/documentation/make_header @@ -0,0 +1,63 @@ +#!/bin/sh +# +# Create a new LaTeX header file for doxygen PDF docs +# +# Note: this LaTeX file depends on Doxygen and LaTeX versions, resp. +# and needs therefore to be created with current Doxygen and LaTeX +# versions on the build system. +# +# Usage: +# +# $ sh make_header doxygen_path input-file output-file +# +# where +# - 'doxygen_path' is the full path to the doxygen executable +# or just 'doxygen'. If the full path is used an arbitrary +# doxygen executable and thus doxygen version can be used. +# - 'input-file' is the pure (LaTeX) title page (template) +# - 'output-file' is the generated (LaTeX) title page (template) +# that is used by `make' or `cmake` to generate the final LaTeX +# page header (combined doxygen template + FLTK title page). +# +#======================================================================= +# This script requires a posix shell and uses the following commands: +# cat, rm and sed and (obviously) doxygen +#======================================================================= + +# input and output file names +DOXY_CMD="$1" +FLTK_HEAD="$2" +DOXY_HEAD="$3" +# temp file +DOXY_TEMP="doxy-header.tex.$$" + +if test x$FLTK_HEAD = x; then + echo "usage: $0 fltk-header-file output-file" + exit 1 +fi + +if test x$DOXY_HEAD = x; then + echo "usage: $0 fltk-header-file output-file" + exit 1 +fi + +# Create the doxygen LaTeX header template and replace the LaTeX +# code between (and including) the lines containing +# - 'begin{titlepage}' and +# - 'end{titlepage}' +# with our PDF document title page (LaTeX code) and write the +# result to $DOXY_HEAD. + +"$DOXY_CMD" -w latex $DOXY_TEMP /dev/null /dev/null + +# combine three parts of these files to the output file +# using '( ... ) > $DOXY_HEAD' to write (concatenate) +# all three parts to one file + +( sed -e'/begin{titlepage}/,$d' < $DOXY_TEMP + cat $FLTK_HEAD + sed -e'1,/end{titlepage}/d' < $DOXY_TEMP +) > $DOXY_HEAD + +# cleanup +rm -f $DOXY_TEMP diff --git a/fluid/documentation/make_pdf b/fluid/documentation/make_pdf new file mode 100755 index 000000000..abc7b371d --- /dev/null +++ b/fluid/documentation/make_pdf @@ -0,0 +1,41 @@ +#! /bin/sh +# +# Makefile helper script for the Fast Light Tool Kit (FLTK) documentation. +# +# Copyright 1998-2020 by Bill Spitzak and others. +# +# This library is free software. Distribution and use rights are outlined in +# the file "COPYING" which should have been included with this file. If this +# file is missing or damaged, see the license at: +# +# https://www.fltk.org/COPYING.php +# +# Please see the following page on how to report bugs and issues: +# +# https://www.fltk.org/bugs.php +# + +# This script generates latex/refman.pdf after doxygen has been executed. +# +# Input: run `doxygen Doxybook' (creates files in subdirectory latex) +# Output: latex/refman.pdf (if successful) +# +# Next step: cp -f latex/refman.pdf fluid.pdf (why is this extra step needed ?) +# +# Working directory: fltk/documentation +# +# Used in: Makefile and CMakeLists.txt + +( cd latex + pdflatex --interaction=nonstopmode refman.tex + makeindex refman.idx + pdflatex --interaction=nonstopmode refman.tex + latex_count=5 + while egrep -s 'Rerun (LaTeX|to get cross-references right)' refman.log \ + && [ $latex_count -gt 0 ] + do + echo "Rerunning pdflatex ..." + pdflatex --interaction=nonstopmode refman.tex + latex_count=`expr $latex_count - 1` + done + cd ..) > pdfall.log 2>&1 diff --git a/fluid/documentation/src/1of7GUIs.png b/fluid/documentation/src/1of7GUIs.png Binary files differnew file mode 100644 index 000000000..a7a98df0f --- /dev/null +++ b/fluid/documentation/src/1of7GUIs.png diff --git a/fluid/documentation/src/cubeview.png b/fluid/documentation/src/cubeview.png Binary files differnew file mode 100644 index 000000000..877be186c --- /dev/null +++ b/fluid/documentation/src/cubeview.png diff --git a/fluid/documentation/src/edit_live_resize.png b/fluid/documentation/src/edit_live_resize.png Binary files differnew file mode 100644 index 000000000..3ff601347 --- /dev/null +++ b/fluid/documentation/src/edit_live_resize.png diff --git a/fluid/documentation/src/edit_outside.png b/fluid/documentation/src/edit_outside.png Binary files differnew file mode 100644 index 000000000..8755a926c --- /dev/null +++ b/fluid/documentation/src/edit_outside.png diff --git a/fluid/documentation/src/edit_overlap.png b/fluid/documentation/src/edit_overlap.png Binary files differnew file mode 100644 index 000000000..0e2264a4e --- /dev/null +++ b/fluid/documentation/src/edit_overlap.png diff --git a/fluid/documentation/src/edit_select_group.png b/fluid/documentation/src/edit_select_group.png Binary files differnew file mode 100644 index 000000000..19599296f --- /dev/null +++ b/fluid/documentation/src/edit_select_group.png diff --git a/fluid/documentation/src/edit_select_multiple.png b/fluid/documentation/src/edit_select_multiple.png Binary files differnew file mode 100644 index 000000000..4df984b3e --- /dev/null +++ b/fluid/documentation/src/edit_select_multiple.png diff --git a/fluid/documentation/src/edit_snap_grid.png b/fluid/documentation/src/edit_snap_grid.png Binary files differnew file mode 100644 index 000000000..0a4a65d17 --- /dev/null +++ b/fluid/documentation/src/edit_snap_grid.png diff --git a/fluid/documentation/src/edit_snap_group.png b/fluid/documentation/src/edit_snap_group.png Binary files differnew file mode 100644 index 000000000..5638ee309 --- /dev/null +++ b/fluid/documentation/src/edit_snap_group.png diff --git a/fluid/documentation/src/edit_snap_sibling.png b/fluid/documentation/src/edit_snap_sibling.png Binary files differnew file mode 100644 index 000000000..c1b0cb4f0 --- /dev/null +++ b/fluid/documentation/src/edit_snap_sibling.png diff --git a/fluid/documentation/src/edit_snap_size.png b/fluid/documentation/src/edit_snap_size.png Binary files differnew file mode 100644 index 000000000..bcc4558ba --- /dev/null +++ b/fluid/documentation/src/edit_snap_size.png diff --git a/fluid/documentation/src/edit_window.png b/fluid/documentation/src/edit_window.png Binary files differnew file mode 100644 index 000000000..fcf325e6d --- /dev/null +++ b/fluid/documentation/src/edit_window.png diff --git a/fluid/documentation/src/flBox.png b/fluid/documentation/src/flBox.png Binary files differnew file mode 100644 index 000000000..acc3e7e4e --- /dev/null +++ b/fluid/documentation/src/flBox.png diff --git a/fluid/documentation/src/flClass.png b/fluid/documentation/src/flClass.png Binary files differnew file mode 100644 index 000000000..ed707b381 --- /dev/null +++ b/fluid/documentation/src/flClass.png diff --git a/fluid/documentation/src/flCode.png b/fluid/documentation/src/flCode.png Binary files differnew file mode 100644 index 000000000..f5510a346 --- /dev/null +++ b/fluid/documentation/src/flCode.png diff --git a/fluid/documentation/src/flCodeBlock.png b/fluid/documentation/src/flCodeBlock.png Binary files differnew file mode 100644 index 000000000..9092d6c0f --- /dev/null +++ b/fluid/documentation/src/flCodeBlock.png diff --git a/fluid/documentation/src/flComment.png b/fluid/documentation/src/flComment.png Binary files differnew file mode 100644 index 000000000..ed3dc5e0a --- /dev/null +++ b/fluid/documentation/src/flComment.png diff --git a/fluid/documentation/src/flData.png b/fluid/documentation/src/flData.png Binary files differnew file mode 100644 index 000000000..bf4848710 --- /dev/null +++ b/fluid/documentation/src/flData.png diff --git a/fluid/documentation/src/flDeclaration.png b/fluid/documentation/src/flDeclaration.png Binary files differnew file mode 100644 index 000000000..992133052 --- /dev/null +++ b/fluid/documentation/src/flDeclaration.png diff --git a/fluid/documentation/src/flDeclarationBlock.png b/fluid/documentation/src/flDeclarationBlock.png Binary files differnew file mode 100644 index 000000000..65f1b692b --- /dev/null +++ b/fluid/documentation/src/flDeclarationBlock.png diff --git a/fluid/documentation/src/flFunction.png b/fluid/documentation/src/flFunction.png Binary files differnew file mode 100644 index 000000000..9c5b7e969 --- /dev/null +++ b/fluid/documentation/src/flFunction.png diff --git a/fluid/documentation/src/flWidgetClass.png b/fluid/documentation/src/flWidgetClass.png Binary files differnew file mode 100644 index 000000000..92fd7d059 --- /dev/null +++ b/fluid/documentation/src/flWidgetClass.png diff --git a/fluid/documentation/src/flWindow.png b/fluid/documentation/src/flWindow.png Binary files differnew file mode 100644 index 000000000..84a8508bb --- /dev/null +++ b/fluid/documentation/src/flWindow.png diff --git a/fluid/documentation/src/fluid-128.png b/fluid/documentation/src/fluid-128.png Binary files differnew file mode 100644 index 000000000..cf9cf406e --- /dev/null +++ b/fluid/documentation/src/fluid-128.png diff --git a/fluid/documentation/src/fluid-title.tex.in b/fluid/documentation/src/fluid-title.tex.in new file mode 100644 index 000000000..f0036d417 --- /dev/null +++ b/fluid/documentation/src/fluid-title.tex.in @@ -0,0 +1,35 @@ +% +% FLUID PDF documentation title page (LaTeX) +% +\begin{titlepage} +\vspace*{4cm} +\begin{center}% +{\Huge FLUID for FLTK @FLTK_VERSION@ User Manual}\\ +\vspace*{2cm} +\begin{DoxyImageNoCaption} + \mbox{\includegraphics[width=4cm]{fluid-128.png}} +\end{DoxyImageNoCaption}\\ +\vspace*{2cm} +{\Large +By F. Costantini, D. Gibson, M. Melcher, \\ +A. Schlosser, B. Spitzak, and M. Sweet.}\\ +\vspace*{1.5cm} +{\large Copyright © 1998 - @YEAR@ by Bill Spitzak and others.}\\ +\vspace*{0.75cm} +{\small +This software and manual are provided under the terms of the GNU Library General Public License.}\\ +{\small +Permission is granted to reproduce this manual or any portion for any purpose,}\\ +{\small +provided this copyright and permission notice are preserved.}\\ +\vspace*{1.5cm} +{\large Generated by Doxygen @DOXY_VERSION@}\\ +\vspace*{0.5cm} +\today{}\\ +\vspace*{0.5cm} +{\small Git revision @GIT_REVISION@}\\ +\end{center} +\end{titlepage} +% +% end of FLUID PDF documentation title page (LaTeX) +% diff --git a/fluid/documentation/src/fluid1.png b/fluid/documentation/src/fluid1.png Binary files differnew file mode 100644 index 000000000..ddfd8ce48 --- /dev/null +++ b/fluid/documentation/src/fluid1.png diff --git a/fluid/documentation/src/fluid2.png b/fluid/documentation/src/fluid2.png Binary files differnew file mode 100644 index 000000000..04382938b --- /dev/null +++ b/fluid/documentation/src/fluid2.png diff --git a/fluid/documentation/src/fluid3-cxx.png b/fluid/documentation/src/fluid3-cxx.png Binary files differnew file mode 100644 index 000000000..5ac96a4b2 --- /dev/null +++ b/fluid/documentation/src/fluid3-cxx.png diff --git a/fluid/documentation/src/fluid4.png b/fluid/documentation/src/fluid4.png Binary files differnew file mode 100644 index 000000000..64b2548b4 --- /dev/null +++ b/fluid/documentation/src/fluid4.png diff --git a/fluid/documentation/src/fluid_flow_chart.png b/fluid/documentation/src/fluid_flow_chart.png Binary files differnew file mode 100644 index 000000000..71d50e21c --- /dev/null +++ b/fluid/documentation/src/fluid_flow_chart.png diff --git a/fluid/documentation/src/fluid_flow_chart_800.png b/fluid/documentation/src/fluid_flow_chart_800.png Binary files differnew file mode 100644 index 000000000..1e5bd7c8a --- /dev/null +++ b/fluid/documentation/src/fluid_flow_chart_800.png diff --git a/fluid/documentation/src/fluid_gui_overview_800.png b/fluid/documentation/src/fluid_gui_overview_800.png Binary files differnew file mode 100644 index 000000000..d61156a43 --- /dev/null +++ b/fluid/documentation/src/fluid_gui_overview_800.png diff --git a/fluid/documentation/src/index.dox b/fluid/documentation/src/index.dox new file mode 100644 index 000000000..984981de3 --- /dev/null +++ b/fluid/documentation/src/index.dox @@ -0,0 +1,118 @@ + + +/** + + \cond FL_HTML_INDEX + + \mainpage FLUID User Manual + + + <TABLE CELLPADDING="8" CELLSPACING="0" SUMMARY="TITLE BAR" WIDTH="100%" BORDER="0"> + <TR> + <TD><CENTER> + \image html fluid-128.png + \image latex fluid-128.png "" width=3cm + </CENTER></TD> + <TD><CENTER> + <B>FLUID 1.4.0 User Manual</B> + + By F. Costantini, D. Gibson, M. Melcher, + A. Schlosser, B. Spitzak and M. Sweet. + + Copyright © 1998 - 2024 by Bill Spitzak and others. + </CENTER></TD> + </TR> + </TABLE> + + <TABLE CELLPADDING="8" CELLSPACING="0" SUMMARY="TITLE BAR" WIDTH="100%" BORDER="0"> + <TR> + <TD style="text-align: center;"> + This software and manual are provided under the terms of the GNU + Library General Public License. Permission is granted to reproduce + this manual or any portion for any purpose, provided this copyright + and permission notice are preserved. + </TD> + </TR> + </TABLE> + + <TABLE CELLPADDING="8" CELLSPACING="0" SUMMARY="Table of Contents" WIDTH="100%" BORDER="0"> + <TR> + <TD ALIGN="LEFT" VALIGN="TOP"> + + \subpage page_introduction + - \ref introduction_workflow + + \subpage page_commandline + - \ref commandline_options + - \ref commandline_passive + - \ref commandline_windows + + \subpage page_interactive + + \subpage page_main_window + - \ref main_titlebar + - \ref main_menubar + - \ref main_widget_browser + - \ref main_menu_items + + \subpage page_widgetbin_panel + + \subpage page_edit_window + - \ref edit_selection + - \ref edit_layout + - \ref edit_snap + - \ref edit_resize + + \subpage page_widget_panel + - \ref widget_panel_gui + - \ref widget_panel_style + - \ref widget_panel_cpp + - \ref widget_panel_grid + - \ref widget_panel_gridc + + </TD> + <TD ALIGN="LEFT" VALIGN="TOP"> + + \subpage page_functional_nodes + - \ref functional_function + - \ref functional_code + - \ref functional_codeblock + - \ref functional_decl + - \ref functional_declblock + - \ref functional_class + - \ref functional_widgetclass + - \ref functional_comment + - \ref functional_data + + \subpage page_codeview_panel + - \ref codeview_find + - \ref codeview_settings + + \subpage page_setting_dialog + - \ref setting_general + - \ref setting_project + - \ref setting_layout + - \ref setting_shell + - \ref setting_i18n + - \ref setting_user + + \subpage page_tutorial + - \ref fluid_hello_world_tutorial + - \ref fluid_1of7guis_tutorial + - \ref fluid_cubeview_tutorial + - \ref fluid_cubeview_ui + - \ref fluid_addconst + - \ref fluid_gencode + + \subpage page_appendices + - \ref appendix_keyboard_shortcuts + - \ref appendix_fileformat + - \ref appendix_licenses + + </TD> + </TR> + </TABLE> + + \endcond + +*/ diff --git a/fluid/documentation/src/main_titlebar.png b/fluid/documentation/src/main_titlebar.png Binary files differnew file mode 100644 index 000000000..128ecddef --- /dev/null +++ b/fluid/documentation/src/main_titlebar.png diff --git a/fluid/documentation/src/page_appendices.dox b/fluid/documentation/src/page_appendices.dox new file mode 100644 index 000000000..4b352ce71 --- /dev/null +++ b/fluid/documentation/src/page_appendices.dox @@ -0,0 +1,92 @@ +/** + + \page page_appendices Appendices + + \tableofcontents + +<!-- ---------------------------------------------------------------------- --> +\section appendix_keyboard_shortcuts Keyboard Shortcuts + +On Apple computers, use the Apple Command key instead of Ctrl. + +| Key Combo | Function | +| :-------: | :------- | +| `F1` | open widget dialog | +| `F2` | move widget earlier in tree | +| `F3` | move widget later in tree | +| `F7` | move widgets into group | +| `F8` | ungroup widgets | +| `Delete` | delete selected widgets | +| `Ctrl-1..9` | load project from history | +| `Ctrl-A` | select all | +| `Shift-Ctrl-A` | select none | +| `Alt-B` | show or hide Widget Bin | +| `Ctrl-C` | copy widgets | +| `Alt-C` | show or hide Code View window | +| `Shift-Ctrl-C` | generate C++ code files | +| `Ctrl-G` | grid setting dialog | +| `Ctrl-I` | merge project file into current project | +| `Ctrl-N` | start a new project, close the current project | +| `Shift-Ctrl-N` | new project from template | +| `Ctrl-O` | open project file | +| `Shift-Ctrl-O` | toggle overlays | +| `Ctrl-P` | print all visible project windows | +| `Alt-P` | open FLUID settings dialog | +| `Ctrl-Q` | quit FLUID | +| `Ctrl-S` | save project | +| `Shift-Ctrl-S` | save project with new name | +| `Ctrl-U` | duplicate selected widgets | +| `Ctrl-V` | paste last copied widgets | +| `Shift-Ctrl-W` | write i18n translation file | +| `Ctrl-X` | cut selected widgets | +| `Alt-X` | show shell command settings | +| `Ctrl-Z` | undo | +| `Shift-Ctrl-Z` | redo | + +<!-- | `Alt-G` | rund last shell command again | --> + + +| Action | Function in Layout Editor | +| :----: | :------------------------ | +| `left mouse button (LMB)` | select one widget | +| `LMB-drag` | select multiple widgets with selection box | +| `Shift-LMB` | extend widget selection | +| `Shift-LMB-Drag` | toggle selection in selection box | +| `Shift-LMB-Drag` | resize window proportionally | +| `Tab` | select next widget | +| `Shift-Tab` | select previous widget | +| `Arrow` | move selected widgets by one unit | +| `Shift-Arrow` | resize by one unit | +| `Ctrl-Arrow` | move by grid units | +| `Shift-Ctrl-Arrow` | resize by grid units | + + +<!-- ---------------------------------------------------------------------- --> + +\section appendix_fileformat .fl File Format + +FLUID edits and saves its state in `.fl` project files. These files are text, +and you can (with care) edit them in a text editor, perhaps to get some special +effects. The `.fl` file format is described in detail in the file +`fluid/README_fl.txt` which is part of the FLTK source code repository. + +<!-- ---------------------------------------------------------------------- --> + +\section appendix_licenses External Licenses + +FLUID uses graphical images based on the Zendesk Garden Stroke icon set: + +[https://github.com/zendeskgarden](https://github.com/zendeskgarden) +Garden Stroke is licensed under the +[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html). + +FLUID includes templates based on 7GUIs: + +[7GUIs](https://7guis.github.io/7guis/) was created as a spin-off +of the master’s thesis Comparison of Object-Oriented and Functional +Programming for GUI Development by Eugen Kiss at the Human-Computer +Interaction group of the Leibniz Universität Hannover in 2014. + +With kind permission by Prof. Dr. Michael Rohs. + + */ diff --git a/fluid/documentation/src/page_codeview_panel.dox b/fluid/documentation/src/page_codeview_panel.dox new file mode 100644 index 000000000..2fac1a286 --- /dev/null +++ b/fluid/documentation/src/page_codeview_panel.dox @@ -0,0 +1,76 @@ +/** + + \page page_codeview_panel Code View Panel + + \tableofcontents + + # The Code View Panel # + + \image html codeview_panel.png "Code View Panel" + \image latex codeview_panel.png "Code View Panel" width=9cm + + The Code View panel shows all code files that can be generated by FLUID. + + The Code View window can be activated via the main + menu: *Edit* > *Show Source Code* . FLUID will remember the state and + dimensions of the Code View panel. + + If the Auto-Refresh option is selected, the code views will be updated + automatically while editing the project. + + Code View has four tabs. The first tab shows the source code. Inlined data + is omitted in the code view for brevity. + + The second tab shows the content of the header file. The size of inline data + is not calculated and shown as `-1`. + + The third tab shows the list of labels and tooltips as they would be written + to a translation file, using the selected project internationalization method. + + The fourth tab previews the contents of the `.fl` project file. + + <!-- ---------------------------------------------------------------------- --> + \section codeview_find Code View Find + + \image html cv_find_row.png + \image latex cv_find_row.png "Find in Code" width=9cm + + This group of buttons makes it easy to find any text in the Source, Header, or + Project file. Press *Reveal* to select the widget that generated the indicated + line of code. + + __Find__: enter any text you may want to find in the current tab + + __aA__: press this button to activate case sensitive search + + __<<__, __>>__: find the previous or next occurrence + + __Reveal__: clicking this button reveals the widget that generated the + selected code in the widget browser + + <!-- ---------------------------------------------------------------------- --> + \section codeview_settings Code View Settings + + \image html cv_settings_row.png + \image latex cv_settings_row.png "Code View Settings" width=9cm + + __Refresh__: preview the code in the selected tab as it would be generated + for the project in its current state + + __Auto-Refresh__: Automatically refresh the code view when the project changes. + The Auto Refresh is designed to use relatively little resources, even when + continuously updating the selected code tab. + The Code View window can usually stay open and auto refresh during the entire + design process, even for relatively complex GUIs. + + __Auto-Position__: highlight and reposition to the source code generated by + the currently selected widget whenever the selection changes + + __code...__: choose the type of code that is highlighted. In source + files, *static* code is generated by Menu Items, *code* refers to widget + creation code, *code1* is the part before possible children, *code2* is + code generated after children. In header files, *static* highlights + `#include` statements generated by a widget, *code* refers to + the widget declaration. + +*/ diff --git a/fluid/documentation/src/page_commandline.dox b/fluid/documentation/src/page_commandline.dox new file mode 100644 index 000000000..b89c5f3d4 --- /dev/null +++ b/fluid/documentation/src/page_commandline.dox @@ -0,0 +1,124 @@ +/** + + \page page_commandline Command Line + + \tableofcontents + + FLUID can be used in interactive and in command line mode. If launched with + `-c`, followed by a project filename, FLUID will convert the project file + into C++ source files without ever opening a window (or opening an X11 server + connection under Linux/X11). This makes FLUID a great command line tool + for build processes with complex project files that reference + external resources. For example, an image referenced by a `.fl` file can be + modified and recompiled into the application binary without the need to reload + it in an interactive FLUID session. + + <!-- ---------------------------------------------------------------------- --> + \section commandline_options Command Line Options + + To launch FLUID in interactive mode from the command line, you can give it an + optional name of a project file. If no name is given, it will launch with an + empty project, or with the last open project, if so selected in the + application setting dialog. + + The ampersand `&` is optional on Linux machines and lets FLUID run in its + own new process, giving the shell back to the caller. + + ``` + fluid filename.fl & + ``` + +If the file does not exist you will get an error pop-up, but if you dismiss it +you will be editing a blank file of that name. + +FLUID understands all of the standard FLTK switches before the filename: + +``` +-display host:n.n +-geometry WxH+X+Y +-title windowtitle +-name classname +-iconic +-fg color +-bg color +-bg2 color +-scheme schemename +``` + + <!-- ---------------------------------------------------------------------- --> + \section commandline_passive Compile Tool Options + +FLUID can also be called as a command-line only tool to create +the `.cxx` and `.h` file from a `.fl` file directly. To do this type: + +``` +fluid -c filename.fl +``` + +This is the same as the menu __File > Write Code...__ . +It will read the `filename.fl` file and write +`filename.cxx` and `filename.h`. Any leading +directory on `filename.fl` will be stripped, so they are +always written to the current directory. If there are any errors +reading or writing the files, FLUID will print the error and +exit with a non-zero code. You can use the following lines in a +Makefile to automate the creation of the source and header +files: + +``` +my_panels.h my_panels.cxx: my_panels.fl + fluid -c my_panels.fl +``` + +Most versions of "make" support rules that cause `.fl` files to be compiled: + +``` +.SUFFIXES: .fl .cxx .h +.fl.h .fl.cxx: + fluid -c $< +``` + +Check `README.CMake.txt` for examples on how to integrate FLUID into the +`CMake` build process. + +If you use + +\code +fluid -cs filename.fl +\endcode + +FLUID will also write the "strings" for internationalization into the file +'filename.txt', 'filename.po', or 'filename.msg', depending on the chosen type +of i18n (menu: 'File/Write Strings...'). + +Finally there is another option which is useful for program developers +who have many `.fl` files and want to upgrade them to the current FLUID +version. FLUID will read the `filename.fl` file, save it, and exit +immediately. This writes the file with current syntax and options and +the current FLTK version in the header of the file. Use + +``` +fluid -u filename.fl +``` + +to 'upgrade' `filename.fl` . You may combine this with `-c` or `-cs`. + +\note All these commands overwrite existing files w/o warning. You should +particularly take care when running `fluid -u` since this overwrites the +original `.fl` project file. + + <!-- ---------------------------------------------------------------------- --> + \section commandline_windows Windows Specifics + + FLTK uses Linux-style forward slashes to separate path segments in file names. + When running on Windows, FLUID will understand Microsoft drive names and + backward slashes as path separators and convert them internally into + forward slashes. + + Under Windows, binaries can only be defined either as command line tools, or + as interactive apps. FLTK generates two almost identical binaries under + Windows. `fluid.exe` is meant to be used in interactive mode, and + `fluid-cmd.exe` is generated for the command line. Both tools do exactly the + same thing, except `fluid-cmd.exe` can use stdio to output error messages. + +*/ diff --git a/fluid/documentation/src/page_edit_window.dox b/fluid/documentation/src/page_edit_window.dox new file mode 100644 index 000000000..7cbbf5de5 --- /dev/null +++ b/fluid/documentation/src/page_edit_window.dox @@ -0,0 +1,179 @@ +/** + + \page page_edit_window Layout Editor Window + + \tableofcontents + + \image html edit_window.png "Layout Editor Window" + \image latex edit_window.png "Layout Editor Window" width=7cm + + The Layout Editor window is used to interactively add groups and widgets, and + resize and align them. The editor window already looks very much like the + final product that will be built by the FLUID generated C++ source code. + + To create a user interface, first add a function to the project tree by either + clicking the Function icon in the widget bin, or by selecting __New* > Code > + Function/Method__ from the main menu. + + Now just drag the Window icon from the widget bin onto the desktop. FLUID + will generate code that instantiates this window when the function is called. + The return value of the function is a pointer to that window, unless changed + in the Function Panel. Widgets can be added to the window by dragging them from + the widget bin. If a widget is dropped on a group, it will automatically + become a child of that group. + + <!-- ---------------------------------------------------------------------- --> + \section edit_selection Selecting and Moving Widgets + + To move or resize a widget, it must be selected first by clicking on it. + Multiple widgets can be selected by holding down the Shift key when clicking + on them, or by dragging a selection box around widgets. Widgets can also be + selected in the widget browser the main window. Shift-click will select a + range of widgets, Ctrl-click will add widgets to the selection. + + \image html edit_select_multiple.png + \image latex edit_select_multiple.png "Select Multiple Widgets" width=5cm + + Menu items are selected by clicking on the menu button and selecting it from + the popup menu. Multiple menu items can only be selected in the widget browser + in the main application window. + + Once selected, widgets can be moved by clicking and dragging the center + of the selection box. The outer edges allow resizing in one direction, and + dragging the corners resizes widgets horizontally and vertically. + + Widgets can also be repositioned with the arrow keys. Without a shift key, + the selection moves by a single pixel. With the Meta key held down, they + move by the amount indicated in the *Gap* field in the *Widget* section of + the *Layout* setting panel. + + Holding down the Shift key resizes a selected widget by moving the bottom + right corner of the widget. Holding Shift and Meta while pressing arrow keys + resizes by the amount in the *Widget* *Gap* layout setting. + + Children of groups that reposition their contained widgets may behave + differently. Pressing the arrow keys on children of `Fl_Grid` will move + the widget from grid cell to grid cell instead. Resizing a child of `Fl_Flex` + will also mark the child size as `fixed`. + + The tab and shift+tab keys "navigate" the selection. Tab or shift+tab move to + the next or previous widgets in the hierarchy. If the navigation does not seem + to work you probably need to "Sort" the widgets. This is important if you have + input fields, as FLTK uses the same rules when using tab keys + to move between input fields. + + <!-- ---------------------------------------------------------------------- --> + \section edit_layout Layout Helpers + + \image html edit_overlap.png + \image latex edit_overlap.png "Overlapping Widgets" width=5cm + + In FLTK, the behavior of overlapping children of a group is undefined. If + enabled in the settings, FLUID will show overlapping widgets in a group + with a green hash pattern. + + \image html edit_outside.png + \image latex edit_outside.png "Out Of Bounds" width=5cm + + The behavior of widgets that reach outside the bounds of their parent group + is also undefined. They may be visible, but confuse the user when they don't + react to mouse clicks or don't redraw as expected. Outside widgets are marked + with a red hash pattern. + + Note that `Fl_Tile` requires that all children exactly fill the area of the + tile group to function properly. The hash patterns are great helpers to align + children correctly. + + <!-- ---------------------------------------------------------------------- --> + \section edit_snap Layout Alignment + + FLUID layouts are a handful of rules that help creating a clean and consistent + user interface. When repositioning widgets, the mouse pointer snaps to the + closest position based on those rules. A guide line is drawn for the rule that was + applied. Guides and snaps can be disabled with `Ctrl-Shift-G` or via the + *Edit* > *Hide Guides* menu. + + \image html edit_snap_group.png + \image latex edit_snap_group.png "Snap To Group" width=5cm + + If a horizontal or vertical outline snaps to the group, the + border of that group will highlight. If the outline snaps to the margin + of the parent window or group, an additional arrow is drawn. + + Children of `Fl_Tabs` use the top and bottom margin from the *Tabs* + section. If all children use this rule, the margin height will also be the + height of all tabs. + + \image html edit_snap_sibling.png + \image latex edit_snap_sibling.png "Snap To Sibling" width=5cm + + The selection can also snap to the outline of other widgets in the same group, + or to the outline plus the Widget Gap. The outline that triggers the snap + action is highlighted. + + Note that only the first snap guide found is drawn for horizontal and vertical + movement. Multiple rules may apply, but are not highlighted. + + \image html edit_snap_size.png + \image latex edit_snap_size.png "Snap To Size" width=7cm + + Widget size rules define a minimum size and an increment value that may + be applied multiple times to the size. For example, with a minimum width of 25 + and an increment of 10, the widget will snap horizontally to 25, 35, 45, + 55, etc. . + + \image html edit_snap_grid.png + \image latex edit_snap_grid.png "Snap To Grid" width=5cm + + The grid rule is the easiest to explain. All corners of a selection snap to + a fixed grid. If the selected widgets are children of a window, they will snap + to the window grid. If they are in a group, they snap to the group grid. + + <!-- ---------------------------------------------------------------------- --> + \section edit_resize Live Resize + + \image html edit_select_group.png + \image latex edit_select_group.png "Selected Group" width=9cm + + The Resizable system within FLTK is smart, but not always obvious. When + constructing a sophisticated GUI, it is helpful to organize widgets into + multiple levels of nested groups. Sometimes, incorporating an invisible + resizable box can improve the behavior of a group. FLUID offers a Live Resize + feature, allowing designers to experiment with resizing at each level within + the hierarchy independently. + + To test the resizing behavior of a group, begin by selecting it: + + \image html edit_live_resize.png + \image latex edit_live_resize.png "Live Resize" width=7cm + + Click on *Live Resize* in the widget panel. FLUID will generate a new window + with all the resizing attributes inherited from the original design. This + enables the designer to thoroughly test the behavior and limitations, + making adjustments until they are satisfied. This streamlined process makes + it significantly easier to address resizing behavior at a higher level, + particularly once the lower levels are behaving as intended. + + In the example above, the radio buttons are not fixed to the left side of + the group and the text snippet "of the bed" does not stay aligned + to "right side". To fix this, a thin hidden box could be added to the right + edge of the group that holds the radio button which is then marked `resizable`. + + <!-- ---------------------------------------------------------------------- --> + \section edit_limits Limitations + + Almost all FLTK widgets can be edited with FLUID. Notable exceptions include + + - FLUID does not support an `Fl_Window` inside another `Fl_Window` + - widgets inside `Fl_Scroll` can not be created in the hidden areas of the + scrollable rectangle. It is recommended to organize the children in + a separate Widget Class that is derived from `Fl_Scroll` and then inserted + as a single custom widget. + - children of `Fl_Pack` are not automatically reorganized to fit the packing + group. Again, a Widget Class is recommended here. + - if children of `Fl_Grid` are again some kind of group, their internal layout + may not follow changes in the grid widgets. It's best to complete the grid + first, then add children to the grid cells, size them correctly, and + then finally lay out the grid cell children. + +*/ diff --git a/fluid/documentation/src/page_functional_nodes.dox b/fluid/documentation/src/page_functional_nodes.dox new file mode 100644 index 000000000..4407f0e38 --- /dev/null +++ b/fluid/documentation/src/page_functional_nodes.dox @@ -0,0 +1,450 @@ +/** + + \page page_functional_nodes Functional Node Panels + + \tableofcontents + + <!-- ---------------------------------------------------------------------- --> + + \section functional_function Function and Method Panel + +  Functions and Methods + + Fluid can generate C functions, C++ functions, and methods in classes. + Functions can contain widgets to build windows and dialogs. *Code* nodes can + be used to add more source code to a function. + + ### Parents ### + + To generate a function, the function node must be created at the top level or + inside a declaration block. If added inside a class node, this node generates + a method inside that class. + + ### Children ### + + Function nodes can contain code nodes and windows that in turn contain widgets. + If the function node has no children, only a forward declaration will be + created in the header, but no source code will be generated. + + \image html function_panel.png "Function/Method Properties" + \image latex function_panel.png "Function/Method Properties" width=7cm + + ### Declaring a Function ### + + A function node at the top level or inside a declaration block generates a C + or C++ function. + + The *Name* field contains the function name and all arguments. + If the *Name* field is left empty, Fluid will generate a typical 'main()' function. + ``` + // .cxx + int main(int argc, char **argv) { + // code generated by children + w->show(argc, argv); // <-- code generated if function has a child widget + Fl::run(); + } + ``` + + If a function node has a name but no children, a forward declaration is + generated in the header, but the implementation in the source file is omitted. + This is used to reference functions in other modules. + ``` + // .h + void make_window(); + ``` + + If the function contains one or more Code nodes, the implementation code will + be generated. The default return type is `void`. Text in the *Return Type* field + overrides the default type. + ``` + // .cxx + void make_window() { + // code generated by children + } + ``` + + If the function contains one or more windows, a pointer to the first window + will be returned. The default return type will match the window class. + ``` + // .h + Fl_Window* make_window(); + ``` + + ``` + // .cxx + Fl_Window* make_window() { + Fl_Window* w; + // code generated by children: + // w = new Fl_Window(...) + return w; + } + ``` + + #### Options for Functions #### + + Choosing *static* in the pulldown menu will generate the function `static` in + the source file. No forward declaration will be generated in the header file. + ``` + // .cxx + static Fl_Window* make_window() { ... } + ``` + + Choosing *global* will generate a forward declaration of the function in the + header file and no `static` attribute in the source file. + ``` + // .h + void make_window(); + // .cxx + Fl_Window* make_window() { ... } + ``` + + Additionally, + if the *C* option is checked, the function will be declared as a plain C + function in the header file. + ``` + // .h + extern "C" { void my_plain_c_function(); } + // .cxx + void my_plain_c_function() { ... } + ``` + + The *local* option will generate a function in the source file with no `static` + attribute. No forward declaration will be generated in the header file. + ``` + // .cxx + Fl_Window* make_window() { ... } + ``` + + ### Declaring a Method ### + + A function node inside a class node generates a C++ method. If a method node has + no children, the declaration is generated in the header, but no implementation + in the source file. + ``` + // .h + class UserInterface { + public: + void make_window(); + }; + ``` + + If the method contains one or more Code nodes, an implementation will also be + generated. + + ``` + // .cxx + void UserInterface::make_window() { + printf("Hello, World!\n"); + } + ``` + + If the method contains at least one widget, a pointer to the topmost widget + will be returned and the return type will be generated accordingly. + ``` + // .h + class UserInterface { + public: + Fl_Double_Window* make_window(); + }; + ``` + + ``` + // .cxx + Fl_Double_Window* UserInterface::make_window() { + Fl_Double_Window* w; + // code generated by children + return w; + } + ``` + + #### Options for Methods #### + + Class access can be defined with the pulldown menu. It provides a choice of + `private`, `protected`, and `public`. + + Fluid recognizes the keyword `static` or `virtual` at the beginning of the + *return type* and will generate the declaration including the keyword, but will + omit it in the implementation. The return type defaults still apply if there + is no text after the keyword. + + #### Further Options #### + + Users can define a comment text in the *comment* field. The first line of the + comment will be shown in the widget browser. The comment text will be generated + in the source file before the function. + ``` + // .cxx + // + // My multilen comment will be here... . + // Fluid may actually use C style comment markers. + // + Fl_Window* make_window() { + ``` + + FLUID recognizes default values in the argument list and generates them in the + declaration, but omits them in the implementation. + + A short function body can be appended in the *Name* field. With no child, this + creates an inlined function in the header file. + + <!-- ---------------------------------------------------------------------- --> + + \section functional_code C Source Code + +  Code + + Code nodes hold arbitrary C++ code that is copied verbatim into the + source code file. They are commonly used inside Function nodes. + + ### Parents ### + + Code nodes can be added inside Functions, Code Blocks, and Widget Classes. + + \image html code_panel.png "Code Properties" + \image latex code_panel.png "Code Properties" width=9cm + + The Code Properties panel features a syntax-highlighting C++ code editor. + Some basic bracket and braces match checking is done when closing the dialog. + + When inside a Function or Code Block, the C++ code is inserted directly. + Inside a Widget Class, the code will be added to the constructor of the + widget class. + + <!-- ---------------------------------------------------------------------- --> + + \section functional_codeblock Code Block + +  Code Block + + Code Blocks are used when a single function generates different GUI elements + conditionally. + + ### Parents ### + + Code Blocks are used inside functions and methods. + + ### Children ### + + Code Blocks can contain widgets, code, or more code blocks. + + \image html codeblock_panel.png "Code Block Properties" + \image latex codeblock_panel.png "Code Block Properties" width=7cm + + The two fields expect the code before and after the `{ ... }` statements. The + second field can be empty. + + Two consecutive Code Blocks can be used to generate `else`/`else if` + statements by leaving the second field of the first node empty. + + <!-- ---------------------------------------------------------------------- --> + + \section functional_decl Declaration + +  Declaration + + ### Parents ### + + Declarations can be added at the top level or inside classes and widget classes. + + \image html decl_panel.png "Declaration Properties" + \image latex decl_panel.png "Declaration Properties" width=7cm + + Declaration nodes are quite flexible and can be a simple variable declaration + such as `int i;`. But include statements are also allowed, as are type + declarations, and comments. FLUID does its best to understand user intention, + but the generated code should be verified by the user. + + Declarations nodes at the top level can selectively generate code in the header + and /or in the source file. If a declaration is inside a class, the user can + select if the class member is *private*, *protected*, or *public* instead. + + <!-- ---------------------------------------------------------------------- --> + + \section functional_declblock Declaration Block + +  Declaration Block + + Declaration Blocks are a way to selectively compile child nodes via + preprocessor commands, typically `#ifdef TEST` and `#endif`. + + ### Parents ### + + Declaration Blocks can be created at the top level or inside classes. + + ### Children ### + + Declaration Blocks can contain classes, functions, methods, declarations, and + comments. + + \image html declblock_panel.png "Declaration Block Properties" + \image latex declblock_panel.png "Declaration Block Properties" width=7cm + + Users can select if the block is generated in the source file only, or in the + header file as well. The two input fields are used to enter the line of code + before and after the child nodes. Two consecutive Declaration Blocks can be + used to generate `#else`/`#elif` style code by leaving the second field of + the first node empty. + + \note Declaration Blocks are not smart, and child nodes may still generate + unexpected code outside the scope of this block. This may change in future + versions of FLUID. + + <!-- ---------------------------------------------------------------------- --> + + \section functional_class Classes + + Class + + FLUID can generate code to implement C++ classes. Classes can be used to keep + dialogs and groups of UI elements organized. See Widget Class nodes as an + alternative to implement compound widgets. + + ### Parents ### + + Class nodes can be created at top level or inside a Class or Widget + Class node. + + ### Children ### + + Class nodes can contain Functions, Declarations, Widgets, Data, and + other classes. + + \image html class_panel.png "Class Properties" + \image latex class_panel.png "Class Properties" width=7cm + + The *Name:* and *Subclass of:* fields should be set to standard C++ class + names. + + Function nodes inside classes are implemented as methods. Constructors and + destructors are recognized and implemented as such. Inlined data is declared + as a static class member. + + Note that methods without a code or widget node are only declared in the + header file, but no code is generated for them in the source file. + + <!-- ---------------------------------------------------------------------- --> + + \section functional_widgetclass Widget Class + +  Widget Class + + The Widget Class node creates a new widget type by deriving a class from another + widget class. These are often compound widgets derived from `Fl_Group`. A less + automated but more flexible way to implement compound widgets is the Class node. + + ### Parents ### + + Widget Class nodes can be created at top level or inside a Class or Widget + Class node. + + ### Children ### + + Widget Class nodes can contain Functions, Declarations, Widgets, Data, and + other classes. + + ### Properties ### + + Widget Class nodes use the Widget panel to edit their properties. The super + class can be set in the *C++* tab in the *Class* field. If that field is empty, + FLUID derives from `Fl_Group`. + + The Widget Class always creates a constructor with the common widget parameters: + ``` + MyWidget::MyWidget(int X, int Y, int W, int H, const char *L) + : Fl_Group(X, Y, W, H, L) { ... } + ``` + + If the super class name contains the text `Window`, two more constructors + and a common initializer method are created: + ``` + MyWidget::MyWidget(int W, int H, const char *L) : + Fl_Window(0, 0, W, H, L) { ... } + + MyWidget::MyWidget() : + Fl_Window(0, 0, 480, 320, 0) { ... } + + void MyWidget::_MyWidget() { ... } + ``` + + Code and Widget nodes are then added to the constructor. Function nodes are + added as methods to the class. Declarations are added as class members. + Data nodes generate static class members. + + It may be useful to design compound widgets with a variable size. The Widget + Panel provides a choice menu in the *GUI* tab's *Position* row under + *Children*. The options *resize* and *reposition* generate code to fix up + the coordinates of the widget after instantiation. + + Note that methods without a code or widget node are only declared in the + header file, but no code is generated for them in the source file. + + <!-- ---------------------------------------------------------------------- --> + + \section functional_comment Comments + +  Comment + + This node adds a comment block to the generated source code. + + ### Parents ### + + Comment nodes can be added inside Functions, Code Blocks, and Widget Classes. + If a Comment node is the top node in a tree, it will appear in the source + files even before the `// generated by FLUID ...` line. + + \image html comment_panel.png "Comment Properties" + \image latex comment_panel.png "Comment Properties" width=9cm + + Comment blocks are generated by adding `// ` to the start of each line unless + the first line of a comment starts with `/``*`. In that case, FLUID assumes + a correct block comment and will copy the text verbatim. + + Comments can be generated in the header file, the source file, or both. + + FLUID keeps a small database of predefined comments. Users can add reoccurring + comment blocks, license information for example, to this database via the + pulldown menu. + + Comments can also be imported from an external file. + + <!-- ---------------------------------------------------------------------- --> + + \section functional_data Inlined Data + +  Inlined Data + + The Data node makes it easy to inline data from an external file into the + source code. + + ### Parents ### + + Data nodes can be added at the top level or inside Widget Classes, Classes, + and Declaration Blocks. + + \image html data_panel.png "Data Properties" + \image latex data_panel.png "Data Properties" width=7cm + + At top level, or inside a Declaration Block, Data can be declared *in source + file only*, *static in source file*, or *in source and extern in header*. + + If Data is inside a Class node, it is always declared `static`. The user can + select *private*, *protected*, or *public*. + + Data in binary mode will be stored in an `unsigned char` array. The data size + can be queried with `sizeof()`. In Text mode, it will be stored as `const + char*` and terminated with a `NUL` character. + + In compressed mode, data will be compressed with zlib `compress()` and stored + in an `unsigned char` array. A second variable, holding the original data size, + is declared `int` by appending `_size` to the variable name. + + ``` + // .cxx + int myInlineData_size = 12034; + unsigned char myInlineData[380] = { 65, 128, ... }; + ``` + + The Variable Name should be a regular C++ name. The Filename field expects + the path and name of a file, relative to the location of the .fl file. + + */ diff --git a/fluid/documentation/src/page_interactive.dox b/fluid/documentation/src/page_interactive.dox new file mode 100644 index 000000000..58f46b130 --- /dev/null +++ b/fluid/documentation/src/page_interactive.dox @@ -0,0 +1,57 @@ +/** + + \page page_interactive Interactive Mode + + \tableofcontents + + <!-- ---------------------------------------------------------------------- --> + + In interactive mode, FLUID allows users to construct and modify their GUI + design by organizing widgets hierarchically through drag-and-drop actions. + The project windows provide a live preview of the final UI layout. + Most widget attributes can be adjusted in detail using the + \ref page_widget_panel. + + Users can also incorporate C++ coding elements such as functions, code blocks, + and classes. FLUID supports the integration of external sources, for + example images, text, or binary data, by embedding them directly into the + generated source code. + + \image html fluid_gui_overview_800.png + \image latex fluid_gui_overview_800.png "FLUID Overview" + + A typical FLUID session manages the widget hierarchy in the main application + window on the left. The project file name is shown in the title bar. In the + example above, we edit the FLTK _Preferences_ example file + `test/preferences.fl`. + + \see \ref page_main_window + + The layout editor window left of center, titled + "My Preferences" shows the GUI design as it will be generated by the C++ + source file. The widgets "shower", "shave", and "brush teeth" are shown + in their selected state and can now be resized or moved by grabbing any of + the red boxes around the selection frame. + + \see \ref page_edit_window + + To the right, we have the "Widget Properties" panel. We can use this to + edit many more parameters of the selected widget. If multiple widgets are + selected, changes are applied to all of them where appropriate. + + \see \ref page_widget_panel + + The Widget Bin at the top is an optional tool bar (__Edit > Show Widget Bin__, + Alt-B). It gives quick access to all widget and code types. Widgets can + be added by clicking onto the tool, or by dragging them out of the tool box + into the layout editor. + + \see \ref page_widgetbin_panel + + The optional panel on the right shows a live source code preview. This is + very helpful for verifying how changes in the GUI will be reflected in the + generated C++ code (__Edit > Show Code View__, Alt-C). + + \see \ref page_codeview_panel + +*/ diff --git a/fluid/documentation/src/page_introduction.dox b/fluid/documentation/src/page_introduction.dox new file mode 100644 index 000000000..890dc3718 --- /dev/null +++ b/fluid/documentation/src/page_introduction.dox @@ -0,0 +1,69 @@ +/** + + \page page_introduction Introduction + + \tableofcontents + +<!-- ---------------------------------------------------------------------- --> + + \image latex fluid-128.png "FLUID" width=3cm + + FLUID, short for Fast Light User Interface Designer, is a graphical editor + capable of generating C++ source code and header files ready for compilation. + These files ultimately create an FLTK based graphical user interface + for an application. + + The FLTK programming manual is available at https://www.fltk.org/documentation.php . + + This manual provides instructions on launching FLUID as a command line tool + and integrating `.fl` project files into the application build process. + FLTK utilizes _CMake_, but other build systems and IDEs capable of running + external tools can also build applications based on FLUID. + + The majority of the manual focuses on using FLUID as an interactive GUI + design tool. It covers an overview of windows, menu items, and dialog boxes, + detailing how to create visually appealing and consistent user experiences + through drag and drop functionality, a "what you see is what you get" editor, + and alignment tools. The \ref page_setting_dialog will detail the process of initiating + a new project, creating an alignment template, and incorporating + internationalization. + + Several tutorials will explain how to generate small apps in FLUID alone, + and how to create more complex user interfaces, followed by some advanced + subjects like creating integrated reusable widget classes. + + The appendices contain additional technical information for reference. + +<!-- ---------------------------------------------------------------------- --> + + \section introduction_workflow Workflow + + FLUID stores user interface designs within `.fl` project files. These files + are transformed into a binary application through a multi-step process. + Initially, FLUID converts `.fl` files into C++ source and header files. + Subsequently, these files are compiled into object files, which are then + linked with other object files to form an executable binary. + FLUID-generated header files give access to UI elements from other C++ modules + within the project. FLUID can also generate forward declarations to + variables and callback functions that are defined and implemented in other + C++ modules. + + \image html fluid_flow_chart_800.png "FLUID Workflow" + \image latex fluid_flow_chart.png "FLUID Workflow" + + Small applications can be fully designed and developed with FLUID alone. + Users have the option to include shell scripts in FLUID projects, enabling + them to directly call compilers and linkers to produce the binaries. + + For medium-sized projects, a build system such as _CMake_ or an IDE + with integrated build setup is recommended. FLUID in interactive mode + can pre-generate C++ code files for direct compilation by the IDE. + + In larger projects, FLUID projects frequently reference external resources + such as graphics, binary data, and internationalized text. + In such scenarios, it is very useful to distribute the `.fl` project files + instead of prebuilt source files. FLUID in command-line mode can then be + called as an external tool, dynamically generating C++ source code from all + external resources at build time. + + */ diff --git a/fluid/documentation/src/page_main_window.dox b/fluid/documentation/src/page_main_window.dox new file mode 100644 index 000000000..005ce01ec --- /dev/null +++ b/fluid/documentation/src/page_main_window.dox @@ -0,0 +1,371 @@ +/** + + \page page_main_window Main Application Window + + \tableofcontents + + \image html main_window.png "Main Application Window" + \image latex main_window.png "Main Application Window" width=5cm + + A FLUID project is a hierarchy of nodes. Each node holds information to + generate C++ source code which in turn generates the user interface that + is created in the layout editor windows. Projects usually define one or more + functions. These functions can generate one or more + FLTK windows and all the widgets that go inside those windows. + + The FLUID Main Window is split into three parts. The title bar shows the + status of the source and project files. The menu bar provides a wealth of + menu items for all major actions in FLUID. The biggest part of the + app window is the widget browser, a tree structure that lists every code + node and widget in the project. + + <!-- ---------------------------------------------------------------------- --> + \section main_titlebar Title Bar + + \image html main_titlebar.png + \image latex main_titlebar.png "Title Bar" width=5cm + + The title bar shows the status of the project file, _function_panel.fl_ in this + case, followed by an asterisk if the project was changed after it was saved. + If the asterisk shows, FLUID will ask the user to save changes before closing + the project, loading another project, or starting a new one. Pressing `Ctrl-S` + will save the project and make the asterisk disappear. + + The _.cxx_ in the title bar reflects the status of header and source files + in relation to the project. A trailing asterisk indicates that the project and code + files differ. Pressing `Ctrl-Shift-C` to write the code files will make this + asterisk go away. + + \note FLUID currently supports only one open project at a time. + + <!-- ---------------------------------------------------------------------- --> + \section main_menubar Application Menu Bar + + \image html main_menubar.png + \image latex main_menubar.png "Main Menu" width=5cm + + The menu bar is the true control center of FLUID. All actions start here. + + The *File* menu offers the common file operation for FLUID projects. Projects + can be loaded, merged, and saved. *Print* will print a snapshot of all open + project windows. + The *New From Template* item opens a dialog that provides access to a small + number of sample projects. More projects can be added using *Save as Template*. + + Use *Write Code* to write the header and source code files, and *Write Strings* + to write the translation file if one of the internationalization options + is active. + + The *Edit* menu is mainly used to manipulate widgets within the widget tree. + The bottom entries toggle various dialogs and pop up the settings panel. + + The *New* menu holds a list of all widgets that can be used in FLUID. They + are grouped by functionality, very similarly to the widget bin. New widgets are + added inside or right after the selected widget. If the parent widget is not + compatible, FLUID tries to find another location for the widget. If that also + fails, FLUID will pop up a dialog, describing the required parent type. + + The *Layout* menu is used to adjust the position and size of widgets in + relation to each other. + + The *Shell* menu gives quick access to user definable shell scripts. Note that + scripts can be stored inside `.fl` project files. + + \see \ref main_menu_items + + <!-- ---------------------------------------------------------------------- --> + \section main_widget_browser Widget Tree View + + \image html main_browser.png + \image latex main_browser.png "Widget Browser" width=5cm + + Widgets are stored in a hierarchy. You can open and close a level by clicking + the "triangle" at the left of a widget. The leftmost widgets are the + \e parents, and all the widgets listed below them are their \e children. + Parents don't have to have any children. + + The top level of the hierarchy is composed of \e functions and + \e classes. Each of these will produce a single C++ public function + or class in the output <tt>.cxx</tt> file. Calling the function or + instantiating the class will create all of the child widgets. + + The second level of the hierarchy contains the \e windows. + Each of these produces an instance of class Fl_Window. + + Below that are either \e widgets (subclasses of Fl_Widget) or + \e groups of widgets (including other groups). Plain groups are for + layout, navigation, and resize purposes. <i>Tab groups</i> provide the + well-known file-card tab interface. + + Widgets are shown in the browser by either their \e name (such + as "Button emergency_btn" in the example), or by their \e type + and \e label (such as "Double_Window "My Main Window""). + + You \e select widgets by clicking on their names, which highlights + them (you can also select widgets from any displayed window). You can + select many widgets by dragging the mouse across them, or by using + Shift+Click to toggle them on and off. To select no widgets, click in + the blank area under the last widget. Note that hidden children may + be selected even when there is no visual indication of this. + + You \e open widgets by double-clicking on them, or (to open several + widgets you have picked) by typing the F1 key. A control panel will appear + so you can change the widget(s). + + Nodes are moved within their group using + `F2` and `F3`. They can be grouped and ungrouped with `F7` and `F8`, and + relocated by selecting them and using cut, copy, and paste. + + Every line in the browser has the same basic format. The level of indentation + reflects the depth of a node within the tree. + + The triangle appears only in front of nodes that can have children. If it is + white, the group has no children. If it is black, there is at least one child. + If the triangle points to the right, the children are hidden in the tree view. + Click the triangle to reveal all children. + + The icon to the right is a small representation of the base type of the node. + Widgets are gray, windows have a blue title bar, and functional nodes are + green. If the widget is static or private, a padlock icon will appear in the + bottom right corner of the type icon. + + The content of text fields depends on the node type. If a comment is set, it + appears in green over the text. Widgets combine their type (bold black) and + label text (red), or their C++ name in black (not bold). + + All colors and font styles can be customized in the User tab of the + Settings panel. + + <!-- ---------------------------------------------------------------------- --> + \section main_menu_items The Main Menu + +The "New" menu of the main menu bar is duplicated as a pop-up menu on any +layout editor window. The shortcuts for all the menu items work in any +window. The menu items are: + +__File > New (Ctrl+n)__: Close the current project and start a new, empty project. + +__File > Open... (Ctrl+o)__: Discard the current editing session and read in a +different `.fl` project file. You are asked for confirmation if you have +changed the current file. + +FLUID can also read `.fd` files produced by the Forms and XForms "fdesign" +programs. It is best to _File > Merge_ them instead of opening them. FLUID does +not understand everything in a `.fd` file, and will print a warning message on +the controlling terminal for all data it does not understand. You will probably +need to edit the resulting setup to fix these errors. Be careful not to save +the file without changing the name, as FLUID will write over the `.fd` file +with its own format, which fdesign cannot read! + +__File > Insert... (Ctrl+i)__: Insert the contents of another `.fl` file +without changing the name of the current `.fl` file. All the functions (even if +they have the same names as the current ones) are added, and you will have to +use cut/paste to put the widgets where you want. + +__File > Save (Ctrl+s)__: Write the current data to the `.fl` file. If the +file is unnamed then FLUID will ask for a filename. + +__File > Save As... (Ctrl+Shift+S)__: Ask for a new filename and +save the file. + +__File > Save A Copy...__: Save a copy of the `.fl` data to a different file. + +__File > Revert...__: Revert the `.fl` data to the previously saved state. + +__File > New From Template...__: Create a new user interface design from a +previously saved template. This can be useful for including a predefined +enterprise copyright message for projects, or for managing boilerplate code +for repeating project code. + +__File > Save As Template...__: Save the current project as a starting point +for future projects. + +__File > Print... (Ctrl-P)__: Generate a printout containing all currently +open windows within your project. + +__File > Write Code (Ctrl+Shift+C)__: Write the GUI layout as a `.cxx` and +`.h` file. These are exactly the same as the files you get when you run +FLUID with the `-c` switch. + +The output file names are the same as the `.fl` file, with the leading directory +and trailing ".fl" stripped, and ".h" or ".cxx" appended. + +__File > Write Strings (Ctrl+Shift+W)__: Write a message file for all of the +text labels and tooltips defined in the current file. + +The output file name is the same as the `.fl` file, with the leading directory +and trailing ".fl" stripped, and ".txt", ".po", or ".msg" appended depending on +the \ref setting_i18n "Internationalization Mode". + +__File > Quit (Ctrl+q)__: Exit FLUID. You are asked for confirmation if you +have changed the current file. + +__Edit > Undo (Ctrl+z)__ and __Redo (Shift+Ctrl+z)__: FLUID saves the project +state for undo and redo operations after every major change. + +__Edit > Cut (Ctrl+x)__: Delete the selected widgets and all of their children. +These are saved to a "clipboard" file and can be pasted back into any +FLUID window. + +__Edit > Copy (Ctrl+c)__: Copy the selected widgets and all of their children +to the "clipboard" file. + +__Edit > Paste (Ctrl+v)__: Paste the widgets from the clipboard file. + +If the widget is a window, it is added to whatever function +is selected, or contained in the current selection. + +If the widget is a normal widget, it is added to whatever +window or group is selected. If none is, it is added to the +window or group that is the parent of the current selection. + +To avoid confusion, it is best to select exactly one widget +before doing a paste. + +Cut/paste is the only way to change the parent of a +widget. + +__Edit > Duplicate (Ctrl-u)__: Duplicate all currently selected widgets and +insert the duplicates after the last selected widget. + +__Edit > Delete__: Delete all selected widgets. + +__Edit > Select All (Ctrl+a)__: Select all widgets in the same group as the +current selection. + +If they are all selected already then this selects all +widgets in that group's parent. Repeatedly typing `Ctrl+a` will +select larger and larger groups of widgets until everything is +selected. + +__Edit > Properties... (F1 or double click)__: Display the current widget in +the widgets panel. If the widget is a window and it is not visible then the +window is shown instead. + +__Edit > Sort__: Sort the selected widgets into left to right, top to bottom +order. You need to do this to make navigation keys in FLTK work correctly. +You may then fine-tune the sorting with "Earlier" and "Later". This does not +affect the positions of windows or functions. + +__Edit > Earlier (F2)__: Move all of the selected widgets one earlier in order +among the children of their parent (if possible). This will affect navigation +order, and if the widgets overlap it will affect how they draw, as the later +widget is drawn on top of the earlier one. You can also use this to reorder +functions, classes, and windows within functions. + +__Edit > Later (F3)__: Move all of the selected widgets one later in order +among the children of their parent (if possible). + +__Edit > Group (F7)__: Create a new Fl_Group and make all the currently +selected widgets children of it. + +__Edit > Ungroup (F8)__: Delete the parent group if all the children of a +group are selected. + +__Edit > Show or Hide Overlays (Ctrl+Shift+O)__: Toggle the display of the +red overlays off, without changing the selection. This makes it easier to see +box borders and how the layout looks. The overlays will be forced back on if +you change the selection. + +__Edit > Show or Hide Guides (Ctrl+Shift+G)__: Guides can be used to arrange a +widget layout easily and consistently. They indicate preferred widget +positions and sizes with user definable margins, grids, and gap sizes. See +the "Layout" tab in the "Settings" dialog, \ref setting_layout. + +This menu item enables and disables guides and the snapping action when dragging +widgets and their borders. + +__Edit > Show or Hide Restricted (Ctrl+Shift+R)__: The behavior of overlapping +widgets in FLTK is undefined. By activating this button, a hatch pattern is +shown, highlighting areas where restricted or undefined behavior may occur. + +__Edit > Show or Hide Widget Bin (Alt+B)__: The widget bin provides quick +access to all widget types supported by FLUID. Layouts can be created by +clicking on elements in the widget bin, or by dragging them from the bin to +their position within the layout. This button shows or hides the widget bin. + +__Edit > Show or Hide Code View (Alt+C)__: Shows or hide +the source code preview window. Any changes to the layout or code in the layout +editor can be previewed and verified immediately in the Code View window. + +__Edit > Settings... (Alt+p)__: Open the application and project settings +dialog: \ref page_setting_dialog + +__New > Code > Function__: Create a new C function. You will be asked for a +name for the function. This name should be a legal C++ function +template, without the return type. You can pass arguments which +can be referred to by code you type into the individual widgets. + +If the function contains any unnamed windows, it will be +declared as returning an Fl_Window pointer. The unnamed window +will be returned from it (more than one unnamed window is +useless). If the function contains only named windows, it will +be declared as returning nothing (\c void ). + +It is possible to make the <tt>.cxx</tt> output be a +self-contained program that can be compiled and executed. This +is done by deleting the function name so +\p main(argc,argv) is used. The function will call +\p show() on all the windows it creates and then call +\p Fl::run(). This can also be used to test resize +behavior or other parts of the user interface. + +You can change the function name by double-clicking on the +function. + +\see \ref functional_function + +__New > Group > Window__: Create a new Fl_Window widget. The window is added +to the currently selected function, or to the function containing the currently +selected item. The window will appear, sized to 480x320. You can resize it to +whatever size you require. + +The widget panel will also appear and is described later in +this chapter. + +__New > ...__: All other items on the New menu are subclasses of +`Fl_Widget`. Creating them will add them to the +currently selected group or window, or the group or window +containing the currently selected widget. The initial +dimensions and position are chosen by copying the current +widget, if possible. + +When you create the widget you will get the widget's control +panel, which is described later in this chapter. + +__Layout > Align > ...__: Align all selected widgets to the first widget in +the selection. + +__Layout > Space Evenly > ...__: Space all selected widgets evenly inside the +selected space. Widgets will be sorted from first to last. + +__Layout > Make Same Size > ...__: Make all selected widgets the same size as +the first selected widget. + +__Layout > Center in Group > ...__: Center all selected widgets relative to +their parent widget + +__Layout > Grid and Size Settings... (Ctrl+g)__: Display the grid settings +panel. See \ref setting_layout . + +This panel controls dimensions 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. + +Layout preferences are defined using margins to parent groups and windows, gaps +between widget, and/or by overlaying a grid over a group or window. A layout +comes as a suite of three presets, one for the main application window, one +for dialog boxes, and one for toolboxes. + +FLUID comes with two included layout suites. `FLTK` was used to design FLUID and +other included apps, and `Grid` is a more rigid grid layout. Users can add +more suites, import and export them, and include them into their `.fl` +project files. + +__Shell > Customize... (Alt+x)__: Displays the shell command settings panel. +Shell commands are commonly used to run a 'make' script to compile the FLUID +output. See \ref setting_shell . + +__Help > About FLUID__: Pops up a panel showing the version of FLUID. + +*/ diff --git a/fluid/documentation/src/page_setting_dialog.dox b/fluid/documentation/src/page_setting_dialog.dox new file mode 100644 index 000000000..78b7282ee --- /dev/null +++ b/fluid/documentation/src/page_setting_dialog.dox @@ -0,0 +1,338 @@ +/** + + \page page_setting_dialog Settings Dialog + + \tableofcontents + + <img src="w_settings.png" align="left" hspace="10" vspace="10" /> + \image latex w_settings.png "Settings Dialog" width=7cm + + The *Settings* dialog combines application preferences + and project settings in a compact set of six tabs. + + The *General* tab contains a collection of application wide settings. They are + stored as user preferences. + + The *Project* tab holds settings for the current project. They are saved with + the `.fl` file. + + The *Layout* tab manages databases of preferred widget alignment. These + preferences can be saved per user, or as part of the project, or exported for + use in other projects. + + The *Shell* tab manages a database of quick access shell commands and scripts. + Shell commands can be saved as a user preference and also as part of the + `.fl` project file. + + The *Locale* tab sets the method of internationalizing texts in the project, + commonly used for labels and tooltips. + + The *User* tab manages customization of fonts and colors in the widget browser. + These settings are stored as user preferences. + + <div style="clear:both;"></div> + + <!-- ---------------------------------------------------------------------- --> + \section setting_general Application Settings + + <img src="w_settings_general_tab.png" align="left" hspace="10" vspace="10" /> + \image latex w_settings_general_tab.png "General Settings Tab" width=7cm + + __Scheme__: + + Select one of the graphics schemes built into FLTK. It's helpful + to verify the look of various schemes for an application design. + + __Options__: + + Various options to make life as a developer more convenient. + + __Recent Files__: + + FLUID keeps track of recently opened files. + + __External Editor__: + + Users that don't like the built-in FLUID code editor can enter a shell command + here that opens the content of Code nodes in an external editor. FLUID does + its best to pick up on changed content or when the editor is closed. + + __Overlays__: + + The *Position Guides* are little red arrows that indicate if snap points are + found. See the *Layout* tab for details. *Restricted Areas* are areas where + widgets from within the same group overlap. They are visible in the project + window as a diagonally hashed pattern. *Ghosted Group Outlines* show faint + frames around groups that would otherwise be invisible in the project window. + + <div style="clear:both;"></div> + + <!-- ---------------------------------------------------------------------- --> + \section setting_project Project Settings + + <img src="w_settings_project_tab.png" align="left" hspace="10" vspace="10" /> + \image latex w_settings_project_tab.png "Project Settings Tab" width=7cm + + __Header File__, __Code File__: + + These fields are used to build the file path and name of the generated header + and source file. If one field is empty the value defaults to `.h` and `.cxx` + respectively. If a name starts with a `.`, FLUID assumes that the rest of the + text is a file extension. The code file name is then generated by replacing + the extension of the `.fl` project file name. + + \todo Document the exact way the source and header file paths are calculated + for interactive FLUID, and for FLUID launched from the command line. + + __Include Header from Code__: + + If checked, the statement to include the header file is automatically + generated in one of the first lines of the source file. + + __Menu shortcuts use FL_COMMAND__: + + Setting this option will replace FL_CTRL and FL_META as a modifier for + shortcuts with the platform aware modifiers FL_COMMAND and FL_CONTROL, making + shortcuts more portable between macOS and Windows/Linux. + + __allow Unicode__: + + If unchecked, Unicode characters in strings are escaped. If checked, the Unicode + character is stored in the source code in UTF-8 encoding. + + __avoid early include__: + + FLUID by default includes `<FL/Fl.H>` early in the header file. If this option + is checked, users can include other files before including the FL header. The + user must then include `<FL/Fl.H>` later using a Declaration node. + + <div style="clear:both;"></div> + + <!-- ---------------------------------------------------------------------- --> + \section setting_layout Layout Preferences + + <img src="w_settings_layout_tab.png" align="left" hspace="10" vspace="10" /> + \image latex w_settings_layout_tab.png "Layout Settings Tab" width=7cm + + Layouts are a collection of hints that help when interactively positioning and + resizing widgets in the project window. Layouts come in a set of three for + the application window, for dialog boxes, and for toolboxes. + + __Layout__: + + The layout pulldown menu lets users choose from a list of existing layouts. + The plus button creates a new set of layouts based on the currently selected + layout. + The pulldown menu has items to rename, load, and save layouts. It can also + change the location where the layout is stored. The FLUID beaker is for + layouts that are predefined in FLUID, the portrait icon stores as user + preference, the document + icon stores the layout in the `.fl` file, and the disk icon lets users store + layout in external files. + + __Window Margin and Grid__: + + Snap widget position to that margin in relation to the window. The grid + snaps widgets to fixed intervals. + + __Group Margin and Grid__: + + Snap widget position to that margin in relation to the group. The grid + snaps widgets to fixed intervals relative to the top left of the group. + + __Tabs Margin__: + + Snap the tab inside `Fl_Tabs` to the tab border and the offset given in + Margins. + + __Widget Minimum, Increment, and Gap__: + + _Minimum_ sets the minimal width of a widget. _Increment_ is the size multiplier + added to the _Minimum_ value. _Gap_ is the preferred distance to other widgets + in the same group. + + __Label Font__, __Text Font__: + + The preferred label and text font and size for new widgets. + + <div style="clear:both;"></div> + + <!-- ---------------------------------------------------------------------- --> + \section setting_shell Shell Commands + + <img src="w_settings_shell_tab.png" align="left" hspace="10" vspace="10" /> + \image latex w_settings_shell_tab.png "Shell Settings Tab" width=7cm + + __Shell Command List__: + + A list of all currently available shell commands. The portrait symbol in front + of the name indicates that the script is stored in the user preferences. The + document symbol saves them within the `.fl` project file. + + `[+]` adds a fresh new script to the list, `[++]` duplicates the currently + selected script. `[DEL]` deletes it, and `[v]` offers import and export + functionality. The `[T]` button shows the terminal window, and finally the + `[Run]` button runs the selected shell script. + + Selecting a shell script will fill in the bottom half of the dialog. + + __Name__: + + This is the name of the script as it appears in the Shell Command List. + + __Menu Label__: + + Shell scripts that match the *Condition* flag are also available for quick + access in the *Shell* menu in the main window and via shortcut key + combinations. This is the text that is used for the menu entry. + + __Shortcut__: + + Assign a keyboard shortcut to this shell script for even faster access. FLUID + does not check if a shortcut is already used elsewhere. Try to avoid + collisions, especially when the script is part of a project file. + + __Store__: + + Choose where to store the settings of this shell script, either in the user + preferences or as part of the `.fl` project file. + + __Condition__: + + Shell scripts can be quite different for different platforms hosting FLUID. + This choice limits scripts to specific platforms. Multiple scripts can have + the same shortcut if they have different conditions. + + __Shell Script__: + + This is a text field for the shell script. The `[v]` pulldown menu has a list + of variables that are replaced with the corresponding value before running + the script. The zoom button gives access to a much larger shell script editor. + + The options below are a list of actions that can be executed before running + the script. + + <div style="clear:both;"></div> + + <!-- ---------------------------------------------------------------------- --> + \section setting_i18n Internationalization + + The *Locale* tab can be used to configure optional internationalization. + FLUID supports GNU `gettext` and POSIX `catgets`. + + FLUID supports internationalization (I18N for short) of label + strings and tooltips used by widgets. The GNU gettext option also + supports deferred translation of statically initialized menu item + labels. The setting panel (`Alt+p`) provides access + to the I18N options. + + \image html w_settings_i18n_gnu.png + \image latex w_settings_i18n_gnu.png "I18N With GNU gettext" width=7cm + + FLUID supports three methods of I18N: none, GNU + gettext, and POSIX catgets. The "none" method is the + default and just passes the label strings as-is to the widget + constructors. + + The "GNU gettext" method uses GNU gettext (or a similar + text-based I18N library) to retrieve a localized string before + calling the widget constructor. + + The GNU gettext option adds some preprocessor code to the source file: + ``` + #include <libintl.h> + #ifndef gettext_noop + # define gettext_noop(text) text + #endif + ``` + and the gettext call around strings in the source code: + ``` + new Fl_Button(50, 50, 54, 40, "Button"); + // -> + new Fl_Button(50, 50, 54, 40, gettext("Button")); + ``` + + FLUID's code support for GNU gettext is limited to calling a + function or macro to retrieve the localized label; you still + need to call \p setlocale() and \p textdomain() or + \p bindtextdomain() to select the appropriate language and + message file. + + __Include__: controls the header file to include for +I18N; by default this is \b <libintl.h>, the +standard I18N file for GNU gettext. + + __Conditional__: If this field contains a macro name, i18n will only be + compiled into the product if this macro is defined. The build system should + define the macro only if all required headers and libraries are available. If + the macro is not defined, no headers are included and `gettext` passes text + through untranslated. + + __Function__: controls the function (or macro) that will retrieve the localized + message; by default the \p gettext function will be called. + + __Static Function__: names a macro that will mark static text fields for + extraction with the `xgettext` tool. The default macro name is + \p gettext_noop and will be defined as `#define gettext_noop(text) text` + right after the `#include` statement. FLUID will call `gettext` on static + texts later, after the textdomain was set by the user. + + \see [GNU gettext special cases](https://www.gnu.org/software/gettext/manual/html_node/Special-cases.html) + + \image html w_settings_i18n_psx.png + \image latex w_settings_i18n_psx.png "I18N With POSIX catgets" width=7cm + + The "POSIX catgets" method uses the POSIX catgets function to + retrieve a numbered message from a message catalog before + calling the widget constructor. + + FLUID's code support for POSIX catgets allows you to use a + global message file for all interfaces or a file specific to + each <tt>.fl</tt> file; you still need to call + \p setlocale() to select the appropriate language. + + This option adds some preprocessor code to the source file: + ``` + #include <nl_types.h> + // Initialize I18N stuff now for menus... + #include <locale.h> + static char *_locale = setlocale(LC_MESSAGES, ""); + static nl_catd _catalog = catopen("", 0); + ``` + and the catgets call around strings in the source code: + ``` + new Fl_Button(50, 50, 54, 40, "Button"); + // -> + new Fl_Button(50, 50, 54, 40, catgets(_catalog,1,6,"Button")); + ``` + + __Include__: controls the header file to include for + I18N; by default this is \b <nl_types.h>, the + standard I18N file for POSIX catgets. + + __Conditional__: include the header file only if this preprocessor macro is + defined. + + __Catalog__: controls the name of the catalog file +variable to use when retrieving localized messages; by default +the file field is empty which forces a local (static) catalog +file to be used for all of the windows defined in your +<tt>.fl</tt> file. + + __Set__: controls the set number in the catalog file. +The default set is 1 and rarely needs to be changed. + + <!-- ---------------------------------------------------------------------- --> + \section setting_user User Interface Preferences + + <img src="w_settings_user_tab.png" align="left" hspace="10" vspace="10" /> + \image latex w_settings_user_tab.png "User Settings Tab" width=7cm + + This tab lets users change the font and color of text in the widget browser. + The settings are stored in the user preferences. + + All changes are directly visible in the widget browser. + + <div style="clear:both;"></div> + + */ diff --git a/fluid/documentation/src/page_tutorial.dox b/fluid/documentation/src/page_tutorial.dox new file mode 100644 index 000000000..3f0d48cae --- /dev/null +++ b/fluid/documentation/src/page_tutorial.dox @@ -0,0 +1,534 @@ +/** + + \page page_tutorial Tutorials + + \tableofcontents + +<!-- ---------------------------------------------------------------------- --> + + \section fluid_hello_world_tutorial Hello, World! + + The first FLUID tutorial explains the FLUID basics. It creates a single + `main()` function that opens an application window with a static text box + inside. + + After launching FLUID we want to make sure that two very useful tool windows + are open. + The "Widget Bin" gives quick access to all available widgets and functional + types. It can be opened via the main menu: __Edit > Show Widget Bin__, or + using the shortcut __Alt-B__. + + The second very helpful tool box is the "Code View". The Code View gives + a preview of the code as it will be generated by FLUID. All changes in the + layout or in attributes are reflected immediately in the Code View. + Choose __Edit > Show Code View__ or press __Alt-C__ to get this + toolbox. Make sure that _Auto-Refresh_ and _Auto-Position_ are active in + the Code View. + + Let's start Hello World from scratch. If there is already a previous project + loaded, select __File > New__ or __Ctrl-N__. + + Before we can create a window, we need a "C" function that can be called + when we run the program. Select __New > Code > Function/Method...__ or click on + the + \image{inline} html flFunction.png "Function/Method" + \image{inline} latex flFunction.png + image in the widget bin. + + A function is added as a first line to the widget tree in the main window, + and a "Function/Method Properties" dialog box will pop up. For our Hello World + program, delete all text in the top "Name(args)" text field. If this field + is left empty, FLUID will generate a `main(argc, argv)` function for us. + + \image html fluid4.png "Function/Method Properties Dialog" + \image latex fluid4.png "Function/Method Properties Dialog" width=7cm + + Click OK to apply the changes you made in the Function Properties dialog. + You can get this dialog back at any time by selecting the function in the + main window and pressing __F1__, or by double-clicking it. + + Note that the function will not show up in the Code View yet. FLUID will + not generate code for functions that don't have any content, and only create + a forward declaration in the header file, assuming that the function will + be implemented inside another module. + + Keep the `main` function selected and add an `Fl_Window` to the function by + selecting __New > Group > Window...__, by clicking the + \image{inline} html flWindow.png "Group/Window" + \image{inline} latex flWindow.png + image in the Widget Bin, or by dragging the Group/Window image from the + Widget Bin onto the desktop. + + A new application window will open up on the desktop. The thin red outline + around the window indicates that it is selected. Dragging the red line will + resize the window. Take a look at the Code View: the main function + is now generated, including code to instantiate our `Fl_Window`. + + To edit all the attributes of our window, make sure it is selected and press + __F1__, or double-click the entry in the main FLUID window, or double-click + the window itself. The "Widget Properties" dialog box will pop up. Enter + some text in the "Label:" text box and see how the label is updated immediately + in the window itself, in the widget list, and in the Code View. + + Adding a static text to our window is just as easy. Put an `Fl_Box` into our + window by selecting __New > Other > Box__, or by clicking on the + \image{inline} html flBox.png "Other/Box" + \image{inline} latex flBox.png + image in the Widget Bin, or by dragging the Other/Box image from the + Widget Bin into our newly created window. + + Most importantly, enter the text "Hello, World!" in the "Label:" field + of the Box Widget Properties panel to achieve the goal of this tutorial. Now + is also a great time to experiment with label styles, label fonts, sizes, + colors, etc. . + + Finally, we should save our project as an `.fl` project file somewhere. Once + the project is saved, select __File > Write Code__ or press __Shift-Ctrl-C__ + to write our source code and header file to the same directory. + + Compile the program using a Makefile, CMake file, or fltk-config as described + in the FLTK manual and the `README.txt` files in the FLTK source tree. + +<!-- ---------------------------------------------------------------------- --> + + \section fluid_1of7guis_tutorial 7GUIs, Task 1 + + In the first "Hello World" tutorial, we built an entire application in FLUID. + It's a boring application though that does nothing except quitting when the + close button in the window border is clicked. + + \image html 1of7GUIs.png "Task 1 of 7GUIs" + \image latex 1of7GUIs.png "Task 1 of 7GUIs" width=5cm + + The second tutorial will introduce callbacks by implementing task 1, "Counter", + of 7GUIs. 7GUIs has been created as a spin-off of my master’s thesis + Comparison of Object-Oriented and Functional Programming for GUI Development + at the Human-Computer Interaction group of the Leibniz Universität Hannover + in 2014. 7GUIs defines seven tasks that represent typical challenges in GUI + programming. https://eugenkiss.github.io/7guis/ . + + Task 1 requires "Understanding the basic ideas of a language/toolkit. The + task is to build a frame containing a label or read-only textfield T and a + button B. Initially, the value in T is “0” and each click of B increases the + value in T by one." + + Our knowledge from tutorial 1 is enough to generate the `main()` function, and + add an `Fl_Window`, an `Fl_Output`, and an `Fl_Button`. To make life easy, + FLUID comes with a built-in template for this tutorial. Just select + __File > New from Template...__ and double-click "1of7GUIs" in the Template + Panel. + + We will need to reference the output widget in our callback, so let's assign a + pointer to the widget to a global variable and give that variable a name. + Open the Widget Properties dialog by double-clicking the output widget. + Change to the "C++" tab, and enter "`counter_widget`" in the "Name:" field. + + The "Count" button is the active element in our application. To tell the + app what to do when the user clicks the button, we create a callback function + for that button. Open the widget properties dialog for the button. + In the "C++" tab, we find the input field "Callback:". + + The callback is called exactly once every time the user clicks the button. Our + strategy here is to read the current value from the `counter_widget`, + increment it by 1, and write it back to `counter_widget`. + The FLTK documentation tells us that we can use `Fl_Output::ivalue()` to get + text in `Fl_Output` as an integer, and we can write it back by calling + `Fl_Output::value(int)`. When the value is changed, FLTK will automatically + redraw the output widget for us. So here is the callback code: + + ``` + int i = counter_widget->ivalue(); + i++; + counter_widget->value(i); + ``` + + That's it. This is a complete interactive desktop application. Compile, link, + run, and test it to see how it works. + +<!-- ---------------------------------------------------------------------- --> + +\section fluid_cubeview_tutorial Cube View + +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 "CubeView demo" +\image latex cubeview.png "CubeView demo" width=7cm + +The window is of class CubeViewUI, and is completely generated by FLUID, +including class member functions. The central display of the cube is a +separate subclass of Fl_Gl_Window called CubeView. CubeViewUI manages +CubeView using callbacks from the various sliders and rollers to +manipulate the viewing angle and zoom of CubeView. + +At the completion of this tutorial you will (hopefully) understand how to: + +-# Use FLUID to create a complete user interface class, including + constructor and any member functions necessary. +-# Use FLUID to set callback member functions of custom widget classes. +-# Subclass an Fl_Gl_Window to suit your purposes. + +\subsection fluid_cubeview The CubeView Class + +The CubeView class is a subclass of Fl_Gl_Window. It has methods for +setting the zoom, the \e x and \e y pan, and the rotation angle +about the \e x and \e y axes. + +You can safely skip this section as long as you realize that CubeView +is a sublass of Fl_Gl_Window and will respond to calls from +CubeViewUI, generated by FLUID. + +\par The CubeView Class Definition + +Here is the CubeView class definition, as given by its header file +"test/CubeView.h": +<br> + +<!-- Code copied from test/CubeView.h --> +\code +#include <FL/Fl.H> +#include <FL/Fl_Gl_Window.H> +#include <FL/gl.h> + +class CubeView : public Fl_Gl_Window { + +public: + CubeView(int x, int y, int w, int h, const char *l = 0); + + // This value determines the scaling factor used to draw the cube. + double size; + + /* Set the rotation about the vertical (y) axis. + * + * This function is called by the horizontal roller in + * CubeViewUI and the initialize button in CubeViewUI. + */ + void v_angle(double angle) { vAng = angle; } + + // Return the rotation about the vertical (y) axis. + double v_angle() const { return vAng; } + + /* Set the rotation about the horizontal (x) axis. + * + * This function is called by the vertical roller in + * CubeViewUI and the initialize button in CubeViewUI. + */ + + void h_angle(double angle) { hAng = angle; } + + // The rotation about the horizontal (x) axis. + double h_angle() const { return hAng; } + + /* Sets the x shift of the cube view camera. + * + * This function is called by the slider in CubeViewUI + * and the initialize button in CubeViewUI. + */ + void panx(double x) { xshift = x; } + + /* Sets the y shift of the cube view camera. + * + * This function is called by the slider in CubeViewUI + * and the initialize button in CubeViewUI. + */ + void pany(double y) { yshift = y; } + + /* The widget class draw() override. + * + * The draw() function initializes Gl for another round of + * drawing, then calls specialized functions for drawing each + * of the entities displayed in the cube view. + */ + void draw(); + +private: + /* Draw the cube boundaries. + * + * Draw the faces of the cube using the boxv[] vertices, + * using GL_LINE_LOOP for the faces. + */ + void drawCube(); + + double vAng, hAng; + double xshift, yshift; + + float boxv0[3]; float boxv1[3]; + float boxv2[3]; float boxv3[3]; + float boxv4[3]; float boxv5[3]; + float boxv6[3]; float boxv7[3]; +}; +\endcode + +\par The CubeView Class Implementation + +Here is the CubeView implementation. It is very similar to the +"CubeView" demo included with FLTK. +<br> + +<!-- Code copied from test/CubeView.cxx --> +\code +#include "CubeView.h" +#include <math.h> + +CubeView::CubeView(int x, int y, int w, int h, const char *l) + : Fl_Gl_Window(x, y, w, h, l) +{ + Fl::use_high_res_GL(1); + vAng = 0.0; + hAng = 0.0; + size = 10.0; + xshift = 0.0; + yshift = 0.0; + + /* The cube definition. These are the vertices of a unit cube + * centered on the origin.*/ + + boxv0[0] = -0.5; boxv0[1] = -0.5; boxv0[2] = -0.5; + boxv1[0] = 0.5; boxv1[1] = -0.5; boxv1[2] = -0.5; + boxv2[0] = 0.5; boxv2[1] = 0.5; boxv2[2] = -0.5; + boxv3[0] = -0.5; boxv3[1] = 0.5; boxv3[2] = -0.5; + boxv4[0] = -0.5; boxv4[1] = -0.5; boxv4[2] = 0.5; + boxv5[0] = 0.5; boxv5[1] = -0.5; boxv5[2] = 0.5; + boxv6[0] = 0.5; boxv6[1] = 0.5; boxv6[2] = 0.5; + boxv7[0] = -0.5; boxv7[1] = 0.5; boxv7[2] = 0.5; +} + +void CubeView::drawCube() { +/* Draw a colored cube */ +#define ALPHA 0.5 + glShadeModel(GL_FLAT); + + glBegin(GL_QUADS); + glColor4f(0.0, 0.0, 1.0, ALPHA); + glVertex3fv(boxv0); + glVertex3fv(boxv1); + glVertex3fv(boxv2); + glVertex3fv(boxv3); + + glColor4f(1.0, 1.0, 0.0, ALPHA); + glVertex3fv(boxv0); + glVertex3fv(boxv4); + glVertex3fv(boxv5); + glVertex3fv(boxv1); + + glColor4f(0.0, 1.0, 1.0, ALPHA); + glVertex3fv(boxv2); + glVertex3fv(boxv6); + glVertex3fv(boxv7); + glVertex3fv(boxv3); + + glColor4f(1.0, 0.0, 0.0, ALPHA); + glVertex3fv(boxv4); + glVertex3fv(boxv5); + glVertex3fv(boxv6); + glVertex3fv(boxv7); + + glColor4f(1.0, 0.0, 1.0, ALPHA); + glVertex3fv(boxv0); + glVertex3fv(boxv3); + glVertex3fv(boxv7); + glVertex3fv(boxv4); + + glColor4f(0.0, 1.0, 0.0, ALPHA); + glVertex3fv(boxv1); + glVertex3fv(boxv5); + glVertex3fv(boxv6); + glVertex3fv(boxv2); + glEnd(); + + glColor3f(1.0, 1.0, 1.0); + glBegin(GL_LINES); + glVertex3fv(boxv0); + glVertex3fv(boxv1); + + glVertex3fv(boxv1); + glVertex3fv(boxv2); + + glVertex3fv(boxv2); + glVertex3fv(boxv3); + + glVertex3fv(boxv3); + glVertex3fv(boxv0); + + glVertex3fv(boxv4); + glVertex3fv(boxv5); + + glVertex3fv(boxv5); + glVertex3fv(boxv6); + + glVertex3fv(boxv6); + glVertex3fv(boxv7); + + glVertex3fv(boxv7); + glVertex3fv(boxv4); + + glVertex3fv(boxv0); + glVertex3fv(boxv4); + + glVertex3fv(boxv1); + glVertex3fv(boxv5); + + glVertex3fv(boxv2); + glVertex3fv(boxv6); + + glVertex3fv(boxv3); + glVertex3fv(boxv7); + glEnd(); +} // drawCube + +void CubeView::draw() { + if (!valid()) { + glLoadIdentity(); + glViewport(0, 0, pixel_w(), pixel_h()); + glOrtho(-10, 10, -10, 10, -20050, 10000); + glEnable(GL_BLEND); + glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA); + } + + glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT); + + glPushMatrix(); + + glTranslatef((GLfloat)xshift, (GLfloat)yshift, 0); + glRotatef((GLfloat)hAng, 0, 1, 0); + glRotatef((GLfloat)vAng, 1, 0, 0); + glScalef(float(size), float(size), float(size)); + + drawCube(); + + glPopMatrix(); +} +\endcode + +\subsection fluid_cubeview_ui The CubeViewUI Class + +We will completely construct a window to display and control the +CubeView defined in the previous section using FLUID. + +\par Defining the CubeViewUI Class + +Once you have started FLUID, the first step in defining a class is to +create a new class within FLUID using the <b>New->Code->Class</b> +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 "FLUID file for CubeView" +\image latex fluid1.png "FLUID file for CubeView" width=7cm + +\par Adding the Class Constructor + +Click on the CubeViewUI class in the FLUID window and add a new method +by selecting <b>New->Code->Function/Method.</b> The name of the +function will also be CubeViewUI. FLUID will understand that this will +be the constructor for the class and will generate the appropriate +code. Make sure you declare the constructor public. + +Then add a window to the CubeViewUI class. Highlight the name of +the constructor in the FLUID browser window and click on +<b>New->Group->Window</b>. In a similar manner add the +following to the CubeViewUI constructor: + +\li A horizontal roller named \p hrot +\li A vertical roller named \p vrot +\li A horizontal slider named \p xpan +\li A vertical slider named \p ypan +\li A horizontal value slider named \p zoom + +None of these additions need be public. And they shouldn't be +unless you plan to expose them as part of the interface for +CubeViewUI. + +When you are finished you should have something like this: + +\image html fluid2.png "FLUID window containing CubeView demo" +\image latex fluid2.png "FLUID window containing CubeView demo" width=7cm + +We will talk about the \p show() method that is highlighted +shortly. + +\par Adding the CubeView Widget + +What we have is nice, but does little to show our cube. We have already +defined the CubeView class and we would like to show it within the +CubeViewUI. + +The CubeView class inherits the Fl_Gl_Window class, which +is created in the same way as an Fl_Box widget. Use +<b>New->Other->Box</b> to add a square box to the main window. +This will be no ordinary box, however. + +The Box properties window will appear. The key to letting CubeViewUI +display CubeView is to enter CubeView in the <b>Class:</b> text +entry box. This tells FLUID that it is not an Fl_Box, but a +similar widget with the same constructor. + +In the <b>Extra Code:</b> field enter <tt>\#include "CubeView.h"</tt> + +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 "CubeView methods" +\image latex fluid3-cxx.png "CubeView methods" width=7cm + +\par Defining the Callbacks + +Each of the widgets we defined before adding CubeView can have +callbacks that call CubeView methods. You can call an external +function or put a short amount of code in the <b>Callback</b> +field of the widget panel. For example, the callback for the +\p ypan slider is: + +\code +cube->pany(((Fl_Slider *)o)->value()); +cube->redraw(); +\endcode + +We call <tt>cube->redraw()</tt> after changing the value to update +the CubeView window. CubeView could easily be modified to do this, but +it is nice to keep this exposed. In the case where you may want to do +more than one view change only redrawing once saves a lot of time. + +There is no reason to wait until after you have added CubeView to +enter these callbacks. FLUID assumes you are smart enough not to refer +to members or functions that don't exist. + +\par Adding a Class Method + +You can add class methods within FLUID that have nothing to do with the +GUI. As an example add a show function so that CubeViewUI can actually +appear on the screen. + +Make sure the top level CubeViewUI is selected and select +<b>New->Code->Function/Method</b>. Just use the name +\p show(). We don't need a return value here, and since we will +not be adding any widgets to this method FLUID will assign it a return +type of \p void. + +\image html fluid4.png "CubeView constructor" +\image latex fluid4.png "CubeView constructor" width=7cm + +Once the new method has been added, highlight its name and select +<b>New->Code->Code.</b> Enter the method's code in the code window. + +\subsection fluid_addconst Adding Constructor Initialization Code + +If you need to add code to initialize a class, for example setting +initial values of the horizontal and vertical angles in the +CubeView, you can simply highlight the constructor and select +<b>New->Code->Code</b>. Add any required code. + +\subsection fluid_gencode Generating the Code + +Now that we have completely defined the CubeViewUI, we have to generate +the code. There is one last trick to ensure this all works. Open the +preferences dialog from <b>Edit->Preferences</b>. + +At the bottom of the preferences dialog box is the key: +<b>"Include Header from Code"</b>. +Select that option and set your desired file +extensions and you are in business. You can include the CubeViewUI.h +(or whatever extension you prefer) as you would any other C++ class. + +*/ diff --git a/fluid/documentation/src/page_widget_panel.dox b/fluid/documentation/src/page_widget_panel.dox new file mode 100644 index 000000000..158f4663b --- /dev/null +++ b/fluid/documentation/src/page_widget_panel.dox @@ -0,0 +1,429 @@ +/** + + \page page_widget_panel Widget Properties Panel + + \tableofcontents + + # The Widget Properties Panel # + + \image html widget_panel.png "Widget Properties" + \image latex widget_panel.png "Widget Properties" width=9cm + + This panel is used to edit the properties of the currently selected widgets. + It can be opened by double-clicking on a widget or by pressing `F1`. + + When you change attributes using this panel, the changes are + reflected immediately in the window. It is useful to hit the + "Hide Overlays" button (or type Ctrl+Shift+O) to hide the + red overlay so you can see the widgets more accurately, + especially when setting the box type. + + One or more widgets can be selected at the same time, and most attribute + changes will be applied to the entire selection. + Depending on the selected widget types, some properties may + be grayed out or may not be visible. + + All changes in the widget panel are immediately applied to all selected + widgets and their effect can be seen in the project window. It can be very + useful to keep the *Code View* window open at all times. All code changes + appear instantly for all generated files if *Auto-Refresh* is active. + + FLUID generates only code for properties that differ from their default + setting. If a widget class is derived from another class, FLUID can't know + the defaults and will generate code for all attributes instead. + + \image html wLiveMode.png + \image latex wLiveMode.png "" width=9cm + + Correctly resizing a window can be a complex task. It is easier to check + resizing behavior on a more local level first. + To use *Live Resize*, select any group or window in your project. FLUID creates + a resizable clone of that part of your design to try out resizing behavior + of that group only. + + The widget panel itself is resizable to make more room for entering code + and long texts. + + <!-- ---------------------------------------------------------------------- --> + \section widget_panel_gui The GUI Tab + + \image html wp_gui_tab.png + \image latex wp_gui_tab.png "" width=9cm + + The widget panel has three standard tabs that apply to all widgets. Some widget + types, `Fl_Grid` and children of `Fl_Grid`, will create additional + tabs with more options. + + The GUI tab controls basic GUI settings, including label text and widget size. + + \image html wp_gui_label.png + \image latex wp_gui_label.png "" width=7cm + + The *Label* field can be any Unicode string and is stored as a static text. + If internationalization is enabled, the corresponding modifiers are + added. Labels can span multiple lines by pressing `Ctrl-J` to insert a newline + (NL) character. + + The `@` character adds a symbol to the label. See *Labels and Label Types* + in the FLTK documentation. + + The pulldown menu offers some additional rendering styles for the label. + + \image html wp_gui_image.png + \image latex wp_gui_image.png "" width=7cm + + Add an image to the widget label here. The second row takes an optional image + for rendering a deactivated widget. + + The image path must be relative to the location of the `.fl` file and not + necessarily the current directory. It is helpful to keep images in the same + directory as the `.fl` file. + + The image data is inlined into the source code. If many widgets share the same + image then only one copy is written. Since the image data is embedded in the + generated source code, you need only distribute the C++ code and not the + image files themselves. The `.fl` project files however store only the image + file name, so you will need the image files as well to read a project file. + + FLUID can read XBM bitmap files, XPM pixmaps with a transparency channel, and + all other types supported by the FLTK image extension. FLUID stores images + as bitmaps or RGB data by default. If *compressed* is selected in the image + properties field, the image is stored in its original format, and + the FLTK-images library must be linked to decompress the image at runtime. + + Images are stored at their original resolution. The image properties dialog + provides *Scale* settings to scale the image before rendering to screen. + To make full use of high-dpi screen support, images should be stored at double + resolution and then scaled to FLTK coordinates. This gives FLTK the chance to + fall back to the full size image for high-dpi screens. + + \image html wp_gui_alignment.png + \image latex wp_gui_alignment.png "" width=7cm + + Control alignment of the label in relation to the widget position and size as + well as the relation between the image and the label. The box on the right + toggles between inside and outside label alignment. + + \image html wp_gui_size.png + \image latex wp_gui_size.png "" width=7cm + + Control the size and position of a widget here. The input fields react to + vertical scroll wheel input for interactive positioning. + + All fields understand basic math. They are evaluated after the formula is + entered and the result is stored in the respective properties. Formulas can + also contain a number of variables. The *x* input can handle the variables + `x` for its own position, `px` for the parent position, `sx` for the previous + sibling, `cx` for the leftmost x position of all children, and `i`, which is a + counter through all selected widgets. + + The formula `x+10` in the *x* field moves all selected widgets 10 pixels to + the right. `100+25*i` in the *y* field arranges all widgets vertically + starting at 100 with 25 pixels distance. + +| Name | Value | +| ---- | ----- | +| `i` | zero based counter of selected widgets | +| `x`, `y`, `w`, `h` | position and size of the current widget | +| `px`, `py`, `pw`, `ph` | dimensions of the parent widget | +| `sx`, `sy`, `sw`, `sh` | dimensions of the previous sibling | +| `cx`, `cy`, `cw`, `ch` | bounding box of all children | + + \image html wp_gui_values.png + \image latex wp_gui_values.png "" width=7cm + + Activate for widgets that can take numerical values, these input fields take + floating point numbers. They generate lines like `o->minimum(2);` only if the + corresponding value differs from the default value for this property. + + \image html wp_gui_flexp.png + \image latex wp_gui_flexp.png "" width=7cm + + This row is only visible for children of `Fl_Flex` widgets. It sets the + width or height of a widget in a horizontal or vertical Flex widget. If *fixed* + is unchecked, this value is instead calculated by the Flex. + + \image html wp_gui_margins.png + \image latex wp_gui_margins.png "" width=7cm + + This row is only visible for `Fl_Flex` widgets. It sets the various margins + and the gap value for this widget. + + \image html wp_gui_sizerange.png + \image latex wp_gui_sizerange.png "" width=7cm + + This row is only visible for top level windows. The fields set the minimum + and maximum size range for windows. Use the *set* button to copy the current + size. Set width and height to `0` to disable that aspect of the size range. + + \image html wp_gui_shortcut.png + \image latex wp_gui_shortcut.png "" width=7cm + + This option is only visible for buttons and other widgets that can react to a + shortcut key combination. FLUID does not check if a shortcut was already used + elsewhere. + + If *shortcut use FL_COMMAND* is set in the project settings, modifiers are + created in a more compatible way across platforms. + + \image html wp_gui_xclass.png + \image latex wp_gui_xclass.png "" width=7cm + + This row is only visible for top level windows. Note that selecting *modal* + and *non modal* together is undefined. + + The string typed into the *X Class* field is passed to the X window manager + as the class. This can change the icon or window decorations. On most window + managers you will have to close the window and reopen it at runtime to + see the effect. + + \image html wp_gui_attributes.png + \image latex wp_gui_attributes.png "" width=7cm + + Some additional attributes for all widget types. + + The *Visible* button controls whether the widget is + visible (on) or hidden (off) initially. Don't change this for + windows or for the immediate children of a Tabs group. + + The *Active* button controls whether the widget is + activated (on) or deactivated (off) initially. Most widgets + appear grayed out when deactivated. + + The *Resizable* button controls whether the window or widget is + resizable. In addition all the size changes of a window or + group will go "into" the resizable child. If you have + a large data display surrounded by buttons, you probably want + that data area to be resizable. You can get more complex + behavior by making invisible boxes the resizable widget, or by + using hierarchies of groups. Resizing of a window or group can be tested + using the *live resize* button. + + The *Hotspot* button causes the parent window to be + positioned with that widget centered on the mouse. This + position is determined when the FLUID function is called, + so you should call it immediately before showing the window. If + you want the window to hide and then reappear at a new position, + you should have your program set the hotspot itself just before + `show()`. + + \image html wp_gui_tooltip.png + \image latex wp_gui_tooltip.png "" width=7cm + + The *Tooltip* field can be any Unicode string and is stored as a static text. + If internationalization is enabled, the corresponding modifiers are + added. + + <!-- ---------------------------------------------------------------------- --> + \section widget_panel_style The Style Tab + + \image html wp_style_tab.png + \image latex wp_style_tab.png "Style Tab" width=9cm + + The Style tab is used to edit font styles and sizes, and the color of elements + of the widget. + + \image html wp_style_label.png + \image latex wp_style_label.png "" width=7cm + + \image html wp_style_text.png + \image latex wp_style_text.png "" width=7cm + + The font pulldown menu provides a list of standard fonts. To enter the index + of a user loaded font, an *extra code* field must be used. The *label color* + and *text color* fields opens a color palette selector. The arrow pulldown + contains a list of the most commonly used colors. Again, user specific colors + can be defined using the *extra code* field. + + The *Text Font* row is only available for widgets that contain an additional + text area. + + \image html wp_style_box.png + \image latex wp_style_box.png "" width=7cm + + Select the up and down box for the given widget. The first six entries in the + box and frame style list are influenced by the FLTK Scheme setting. Other + box styles will always look the same, independently of the selected scheme. + + Many widgets will work, and draw faster, with a + "frame" instead of a "box". A frame does + not draw the colored interior, leaving whatever was already + there visible. Be careful, as FLUID may draw this ok but the + real program may leave unwanted stuff inside the widget. + + If a window is filled with child widgets, you can speed up + redrawing by changing the window's box type to + "NO_BOX". FLUID will display a checkerboard for any + areas that are not colored in by boxes. Note that this + checkerboard is not drawn by the resulting program. Instead + random garbage will be displayed. + + The *Down Box* row is only available for widgets that can be pressed down + by the user. + + Some widgets will use the *Select Color* for certain parts. FLUID + does not always show the result of this: this is the color + buttons draw in when pushed down, and the color of input fields + when they have the focus. + + <!-- ---------------------------------------------------------------------- --> + \section widget_panel_cpp The C++ Tab + + \image html wp_cpp_tab.png + \image latex wp_cpp_tab.png "C++ Tab" width=9cm + + The C++ tab has various input fields for adding C++ code at various places + in the source and header file. + + \image html wp_cpp_class.png + \image latex wp_cpp_class.png "" width=7cm + + If the class property is set, FLUID assumes that the user wants to instantiate + a widget that is derived from the selected widget. For a derived widget, the + default values of attribute can not be known. FLUID will generate code to + explicitly set every known attribute of the super class. + + FLUID generates "include" statements for known classes. Custom classes should + provide a \p \#include line as one of the "Extra Code" lines of the widget. + + If the selected widget is a Widget Class node, the Class property will instead + set the super class of the widget. + + The pulldown menu on the right side contains additional subtypes for some + widget types. `Fl_Button` widgets, for instance, can be further refined to + be an `Fl_Toggle_Button` or an `Fl_Radio_Button`. + + \image html wp_cpp_name.png + \image latex wp_cpp_name.png "" width=7cm + + The name field can be any valid C++ variable name. If the widget is inside + a class, the pulldown menu lets the user select between *private*, *protected*, + and *public*. If not in the group, the variable can be *global* or *static* + within the source file. + + Widgets created by FLUID are either "named", "complex named" or + "unnamed". A named widget has a legal C++ variable identifier as its + name (i.e. only alphanumeric and underscore). In this case FLUID + defines a global variable or class member that will point at the widget + after the function defining it is called. A complex named object has + punctuation such as <tt>'.'</tt> or <tt>'->'</tt> or any other symbols + in its name. In this case FLUID does not attempt to declare it. This can be + used to get the widgets into structures. An unnamed widget has a blank + name and no pointer is stored. + + You can name several widgets with "name[0]", "name[1]", "name[2]", etc.. + This will cause FLUID to declare an array of pointers. The array + is big enough that the highest number found can be stored. All widgets + in the array must be the same type. + + \image html v_input.png + \image latex v_input.png "" width=7cm + + These four input fields can be used to add arbitrary code to different parts + of the header and source file. A line can be divided into multiple lines + of code by inserting a `Ctrl-J`. + + All Extra Code fields are interpreted individually. If a field contains a `#` + character, or the words `extern`, `typedef`, or `using`, FLUID assumes that + the code is a declaration and writes it to the header file, and only if it + does not duplicate previously written code. This is great for creating a + `#include "MyWidgetType.H"` include statement in the header. + + If the code is not recognized as a declaration, it will instead be put after + the code that instantiates the widget and all its children. For menu items, + the code is added after the container `Fl_Menu_` is created, but before the + menu array is added to the container. + + FLUID will check for matching parentheses, braces, and + quotes, but does not do much other error checking. Be careful + here, as it may be hard to figure out what widget is producing + an error in the compiler. If you need more than four lines you + probably should call a function in your own `.cxx` + code. + + \image html wComment.png + \image latex wComment.png "" width=7cm + + Comments are added to the source code before the widget constructor by adding + `// ` in front of every line of the comment. The first few characters of a + comment are also visible in the widget browser in the main window. + + \image html wp_cpp_callback.png + \image latex wp_cpp_callback.png "" width=7cm + + The callback field can be interpreted in two ways. If the callback text is only + a single word, FLUID assumes that this is the name of an external callback + function and declares it in the header as + `extern void my_button_action(Fl_Button*, void*);`. + + Otherwise, FLUID assumes that the text is the body of a C++ callback function + and instead creates a local static callback function. The name of the callback + function is generated by FLUID and guaranteed to be unique within the file. + ``` + static void cb_input(Fl_Input *o, void *v) { + ... // my text from the Callback field here + } + ``` + You can refer to the widget as \p o and the \p user_data() + as \p v. FLUID will check for matching parentheses, braces, + and quotes, but does not do much other error checking. + + If the callback is blank then no callback is set. + + The *User Data* field can contain any valid C++ code and is copied as the + callback argument. If blank the default value of zero is used. + *Type* is currently limited to a pointer (a type name ending in `*`) or `long`. + + The *When* pulldown gives access to the `Fl_When` flags, including some + commonly used combinations. + + <!-- ---------------------------------------------------------------------- --> + \section widget_panel_grid The Grid Tab + + \image html wp_grid_tab.png + \image latex wp_grid_tab.png "Grid Tab" width=9cm + + This tab is only available if the selected widget is an `Fl_Grid`. When editing + a Grid widget, no other widgets should be selected. + + The *Grid Layout* fields adjust the number of rows and columns in the grid. + + The *Margins* fields describe the size of the margins around all children of + the grid. + + The *Gaps* fields set the gaps between individual children in the grid. + + The *Row* and *Column* groups can be used to set the size of individual rows + and columns within the grid. + + <!-- ---------------------------------------------------------------------- --> + \section widget_panel_gridc The Grid Child Tab + + \image html wp_gridc_tab.png + \image latex wp_gridc_tab.png "Grid Child Tab" width=9cm + + This tab is only available if the selected widget is a child of an `Fl_Grid`. + When editing a child of a Grid widget, no other widgets should be selected. + + Use the *Location* group to move a child around within the grid. Note that + every cell in a grid can only manage one single widget. When moving widgets + over occupied cells, they become "transient". Just continue and move them into + an available cell. If a layout is saved with a transient widget, all grid + attributes for that widget are lost, and it will remain unassigned in the + project file and in the source code. + + The *Align* fields provide a way to align a widget within its cell. + + The *Min. Size* fields define a minimum width and height for the widget + in the cell. + + The *Span* fields change the number of cells that a widget can span in x and y. + + \note Most attributes in this tab will also change the size of the widget. If + the child of the Grid is itself a group, the children of that group do not + follow changes in position or size. It is recommended to either lay out the + grid contents first and leave it unchanged, or to use widgets generated with + Widget Class that automatically adjust themselves to the size constraints + of the grid. + +*/ diff --git a/fluid/documentation/src/page_widgetbin_panel.dox b/fluid/documentation/src/page_widgetbin_panel.dox new file mode 100644 index 000000000..c9da9f9c9 --- /dev/null +++ b/fluid/documentation/src/page_widgetbin_panel.dox @@ -0,0 +1,34 @@ +/** + + \page page_widgetbin_panel Widget Bin Panel + + \tableofcontents + + # The Widget Bin Panel # + + \image html widgetbin_panel.png "Widget Bin" + \image latex widgetbin_panel.png "Widget Bin" width=9cm + + The Widget Bin can be activated via the main + menu: *Edit* > *Show Widget Bin* . FLUID will remember its + state and dimensions. + + The Widget Bin is a great way to quickly create a GUI project. Clicking + an icon in the bin will create the corresponding code or widget node inside + or right after the selected widget. If the parent widget is not supported + for this widget type, FLUID tries to find a better position. If that fails, + a dialog box will pop up, explaining what type of parent node is required. + + The Window and Widget Class icons can be dragged onto the desktop, + creating a new window or widget at the drop position. + + \image html widgetbin_action.png + \image latex widgetbin_action.png + + All other widget types can be dragged from the bin into a window, or a group + inside a window. When dropped, they will be positioned close to the drop point + and inserted into the widget tree as the last child of the chosen group. + The order of widgets within their group can be changed with + the `F2` and `F3` keys. + +*/ diff --git a/fluid/documentation/src/widgetbin_action.png b/fluid/documentation/src/widgetbin_action.png Binary files differnew file mode 100644 index 000000000..26463b6e9 --- /dev/null +++ b/fluid/documentation/src/widgetbin_action.png |
