diff options
| author | Matthias Melcher <fltk@matthiasm.com> | 2008-04-08 00:09:16 +0000 |
|---|---|---|
| committer | Matthias Melcher <fltk@matthiasm.com> | 2008-04-08 00:09:16 +0000 |
| commit | 97b806e5800da62734ba2913881d96a353e3e313 (patch) | |
| tree | f6bb73185bdbfa63ff151f99782e9396ca3a6e68 | |
| parent | 7d013249f7456d4568a39679c3cad948e1000353 (diff) | |
Added two UTF-8 support headers which can not be used just yet. Added sample implementation of Doxygen documentation, including a Doxygen config file, two copied doc pages documentation/index.do and documentation/preface.dox, and sample headers fro Fl_Preferences and Fl_Clock.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6089 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
| -rw-r--r-- | Doxyfile | 1262 | ||||
| -rw-r--r-- | FL/Fl_Clock.H | 93 | ||||
| -rw-r--r-- | FL/Fl_Preferences.H | 374 | ||||
| -rw-r--r-- | FL/Xutf8.h | 193 | ||||
| -rw-r--r-- | FL/fl_utf8.H | 248 | ||||
| -rw-r--r-- | documentation/FL200.gif | bin | 0 -> 2722 bytes | |||
| -rw-r--r-- | documentation/index.dox | 101 | ||||
| -rw-r--r-- | documentation/preface.dox | 108 |
8 files changed, 2373 insertions, 6 deletions
diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 000000000..7bc78f659 --- /dev/null +++ b/Doxyfile @@ -0,0 +1,1262 @@ +# Doxyfile 1.5.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a 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 +#--------------------------------------------------------------------------- + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = FLTK + +# 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 = 1.3.x + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# 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 = doc + +# 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 cause performance problems for the file system. + +CREATE_SUBDIRS = 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. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, +# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, +# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, +# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. + +OUTPUT_LANGUAGE = English + +# This tag can be used to specify the encoding used in the generated output. +# The encoding is not always determined by the language that is chosen, +# but also whether or not the output is meant for Windows or non-Windows users. +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES +# forces the Windows encoding (this is the default for the Windows binary), +# whereas setting the tag to NO uses a Unix-style encoding (the default for +# all platforms other than Windows). + +USE_WINDOWS_ENCODING = NO + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) 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. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) 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. + +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" "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. + +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. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then 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. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then 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. + +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 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. + +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 +# comments will behave just like the Qt-style comments (thus requiring an +# explicit @brief command for a brief description. + +JAVADOC_AUTOBRIEF = YES + +# 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 behaviour. +# 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 behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +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. + +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. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# 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. + +ALIASES = + +# 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. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for Java. +# For instance, namespaces will be presented as packages, qualified scopes +# will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# 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); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# 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. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) 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. + +SUBGROUPING = YES + +#--------------------------------------------------------------------------- +# 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 and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +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. + +EXTRACT_LOCAL_CLASSES = NO + +# This flag is only useful for Objective-C code. When 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 (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) 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. + +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 (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +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 (the default) these declarations will be included in the +# documentation. + +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 (the default) these blocks will be appended to the +# function's detailed documentation block. + +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 (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +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. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) 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. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = 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 default), 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. + +SORT_BY_SCOPE_NAME = 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. + +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. + +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. + +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. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of 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 initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +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. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# 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. See the manual for examples. + +FILE_VERSION_FILTER = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED 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. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR 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. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = 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) + +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 stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be 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. + +INPUT = FL \ + documentation + +# If the value of the INPUT tag contains directories, you can use the +# FILE_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 the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py + +FILE_PATTERNS = *.H \ + *.h \ + *.c \ + *.cxx \ + *.dox + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should +# 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. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +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 = + +# 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 = test + +# 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. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = documentation + +# 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. + +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 +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# 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 also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# 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 documentstion. + +REFERENCES_LINK_SOURCE = 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 http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) 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. + +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. + +ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +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 one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = fl_ \ + FL_ \ + Fl_ + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# 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. If left blank `html' will be used as the default path. + +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). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +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 the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, 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. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, 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. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, 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). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, 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. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# If the GENERATE_TREEVIEW tag 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 (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# 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. + +TREEVIEW_WIDTH = 250 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# 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. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +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. + +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, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +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. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). 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. + +PDF_HYPERLINKS = NO + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = NO + +# 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. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = 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 very pretty with +# other RTF readers or editors. + +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. If left blank `rtf' will be used as the default path. + +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. + +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 other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +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. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +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. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# 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 is NO. + +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. + +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. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# 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. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +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. + +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. + +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. + +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. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +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 (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# 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. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +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. + +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. + +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 +# 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. + +PREDEFINED = FL_EXPORT:= + +# 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. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all 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. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. 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. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that 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. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +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. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = YES + +# 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. + +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, 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) + +HAVE_DOT = NO + +# If the CLASS_GRAPH and HAVE_DOT tags are 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 +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are 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. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +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. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# 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. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT tags are 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. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are 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. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are 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. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH 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. + +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). + +DOTFILE_DIRS = + +# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_WIDTH = 1024 + +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_HEIGHT = 1024 + +# 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 a graph may be further truncated if the graph's +# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH +# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), +# the graph is not depth-constrained. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, which results in a white background. +# 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). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES 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. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/FL/Fl_Clock.H b/FL/Fl_Clock.H index 56962a2f5..da98bdcf8 100644 --- a/FL/Fl_Clock.H +++ b/FL/Fl_Clock.H @@ -25,6 +25,10 @@ // http://www.fltk.org/str.php // +/** \file + * Fl_Clock widget definitions for the Fast Light Tool Kit (FLTK). + */ + #ifndef Fl_Clock_H #define Fl_Clock_H @@ -40,6 +44,15 @@ // a Fl_Clock_Output can be used to display a program-supplied time: +/** + * This widget can be used to display a program-supplied time. + * The time shown on the clock is not updated. + * To display the current time, use <TT>Fl_Clock</A></TT> instead. + * + * \image html clock.gif + * + * \image html round_clock.gif + */ class FL_EXPORT Fl_Clock_Output : public Fl_Widget { int hour_, minute_, second_; ulong value_; @@ -48,23 +61,101 @@ protected: void draw(int, int, int, int); void draw(); public: + + /** + * Creates a new <tt>Fl_Clock_Output</tt> widget. + * Create an <tt>Fl_Clock_Output</tt> widget using the given position, + * size, and label string. The default boxtype is <tt>FL_NO_BOX</tt>. + * + * \param[in] x, y, w, h position and size of the widget + * \param[in] label widget label, default is no label + */ Fl_Clock_Output(int x,int y,int w,int h, const char *l = 0); + + /** + * Set the displayed time. + * Set the time in seconds since the UNIX epoch (January 1, 1970). + * \see value() + */ void value(ulong v); // set to this Unix time - void value(int,int,int); // set hour, minute, second + + /** + * Set the displayed time. + * Set the time in hours, minutes, and seconds. + * \param[in] hour, minute, second displayed time + * \see hour(), minute(), second() + */ + void value(int hour, int minute, int second); + + /** + * Returns the displayed time. + * Returns the time in seconds since the UNIX epoch (January 1, 1970). + * \see value(ulong) + */ ulong value() const {return value_;} + + /** + * Returns the displayed time. + * Returns the displayed hour (0 to 23). + * \see value(), minute(), second() + */ int hour() const {return hour_;} + + /** + * Returns the displayed time. + * Returns the displayed minute (0 to 59). + * \see value(), hour(), second() + */ int minute() const {return minute_;} + + /** + * Returns the displayed time. + * Returns the displayed second (0 to 60, 60=leap second). + * \see value(), hour(), minute() + */ int second() const {return second_;} }; // a Fl_Clock displays the current time always by using a timeout: +/** + * This widget provides a round analog clock display. + * <tt>Fl_Clock</tt> is provided for Forms compatibility. + * It installs a 1-second timeout callback using <tt>Fl::add_timeout()</tt>. + * + * \image html clock.gif + * + * \image html round_clock.gif + */ class FL_EXPORT Fl_Clock : public Fl_Clock_Output { public: int handle(int); void update(); + + /** + * Creates a new <tt>Fl_Clock</tt> widget. + * Create an <tt>Fl_Clock</tt> widget using the given position, + * size, and label string. The default boxtype is <tt>FL_NO_BOX</tt>. + * + * \param[in] x, y, w, h position and size of the widget + * \param[in] label widget label, default is no label + */ Fl_Clock(int x,int y,int w,int h, const char *l = 0); + + /** + * Creates a new <tt>Fl_Clock</tt> widget. + * Create an <tt>Fl_Clock</tt> widget using the given position, + * size, and label string. + * + * \param[in] t boxtype + * \param[in] x, y, w, h position and size of the widget + * \param[in] label widget label, default is no label + */ Fl_Clock(uchar t,int x,int y,int w,int h, const char *l); + + /** + * The destructor removes the clock. + */ ~Fl_Clock(); }; diff --git a/FL/Fl_Preferences.H b/FL/Fl_Preferences.H index b16a9f18b..1f7438a5f 100644 --- a/FL/Fl_Preferences.H +++ b/FL/Fl_Preferences.H @@ -25,6 +25,10 @@ // http://www.fltk.org/str.php // +/** \file + * Preferences definitions for the Fast Light Tool Kit (FLTK). + */ + #ifndef Fl_Preferences_H # define Fl_Preferences_H @@ -37,61 +41,421 @@ /** - * Preferences are a data tree containing a root, branches and leafs + * <tt>Fl_Preferences </tt>provides methods to store user + * setting between application starts. It is similar to the + * Registry on WIN32 and Preferences on MacOS, and provides a + * simple configuration mechanism for UNIX. + * + * <tt>Fl_Preferences </tt>uses a hierarchy to store data. It + * bundles similar data into groups and manages entries into those + * groups as name/value pairs. + * + * Preferences are stored in text files that can be edited + * manually. The file format is easy to read and relatively + * forgiving. Preferences files are the same on all platforms. User + * comments in preference files are preserved. Filenames are unique + * for each application by using a vendor/application naming + * scheme. The user must provide default values for all entries to + * ensure proper operation should preferences be corrupted or not + * yet exist. + * + * Entries can be of any length. However, the size of each + * preferences file should be kept under 100k for performance + * reasons. One application can have multiple preferences files. + * Extensive binary data however should be stored in seperate + * files; see getUserdataPath() */ class FL_EXPORT Fl_Preferences { public: - enum Root { SYSTEM=0, USER }; + /** + * Define the scope of the preferences. + */ + enum Root { + SYSTEM=0, ///< Preferences are uses system-wide + USER ///< Preferences apply only to the current user + }; // enum Type { win32, macos, fltk }; + /** + * The constructor creates a group that manages name/value pairs and + * child groups. Groups are ready for reading and writing at any time. + * The <tt>root</tt> argument is either <tt>Fl_Preferences::USER</tt> + * or <tt>Fl_Preferences::SYSTEM</tt>. + * + * This constructor creates the <i>base</i> instance for all + * following entries and reads existing databases into memory. The + * <tt>vendor</tt> argument is a unique text string identifying the + * development team or vendor of an application. A domain name or + * an EMail address are great unique names, e.g. + * "researchATmatthiasm.com" or "fltk.org". The + * <tt>application</tt> argument can be the working title or final + * name of your application. Both <tt>vendor</tt> and + * <tt>application</tt> must be valid relative UNIX pathnames and + * may contain '/'s to create deeper file structures. + * + * \param[in] root can be USER or SYSTEM for user specific or system wide preferences + * \param[in] vendor unique text describing the company or author of this file + * \param[in] application unique text describing application + */ Fl_Preferences( Root root, const char *vendor, const char *application ); + + /** + * This constructor is used to create or read a preferences file at an + * arbitrary position in the file system. The file name is generated + * as <tt><i>path</i>/<i>application</i>.prefs</tt>. If <i>application</i> + * is 0, <i>path</i> must contain the full file name. + * + * \param[in] path path to the directory that contains the preferences file + * \param[in] vendor unique text describing the company or author of this file + * \param[in] application unique text describing application + */ Fl_Preferences( const char *path, const char *vendor, const char *application ); - Fl_Preferences( Fl_Preferences&, const char *group ); + + /** + * This constructor generates a new group of preference entries + * inside the group or file <i>p</i>. The <tt>groupname</tt> argument + * identifies a group of entries. It can contain '/'s to get quick + * access to individual elements inside the hierarchy. + * + * \param[in] parent reference object for the new group + * \param[in] group name of the group to access (may contain '/'s) + */ + Fl_Preferences( Fl_Preferences &parent, const char *group ); + + /** + * \see Fl_Preferences( Fl_Preferences&, const char *group ) + */ Fl_Preferences( Fl_Preferences*, const char *group ); + + /** + * The destructor removes allocated resources. When used on the + * <i>base</i> preferences group, the destructor flushes all + * changes to the preferences file and deletes all internal + * databases. + */ ~Fl_Preferences(); + + /** + * Returns the number of groups that are contained within a + * group. + * + * \return 0 for no groups at all + */ int groups(); - const char *group( int ); + + /** + * Returns the name of the Nth group. There is no guaranteed + * order of group names. The index must be within the range given + * by <tt>groups()</tt>. + * + * \param[in] index number indexing the requested group + * \return cstring pointer to the group name + */ + const char *group( int index ); + + /** + * Returns non-zero if a group with this name exists. + * Groupnames are relative to the Preferences node and can contain a path. + * <tt>"."</tt> describes the current node, <tt>"./"</tt> describes the topmost node. + * By preceding a groupname with a <tt>"./"</tt>, its path becomes relative to the topmost node. + * + * \param[in] group name of group that is searched for + * \return 0 if group was not found + */ char groupExists( const char *group ); + + /** + * Deletes a group. + * + * \param[in] group name of the group to delete + * \return 0 if call failed + */ char deleteGroup( const char *group ); + + /** + * Return the number of entries (name/value) pairs in a group. + * + * \return number of entries + */ int entries(); - const char *entry( int ); + + /** + * Returns the name of an entry. There is no guaranteed order of + * entry names. The index must be within the range given by + * <tt>entries()</tt>. + * + * \param[in] index number indexing the requested entry + * \return pointer to value cstring + */ + const char *entry( int index ); + + /** + * Returns non-zero if an entry with this name exists. + * + * \param[in] entry name of entry that is searched for + * \return 0 if entry was not found + */ char entryExists( const char *entry ); + + /** + * Removes a single entry (name/value pair). + * + * \param[in] entry name of entry to delete + * \return 0 if deleting the entry failed + */ char deleteEntry( const char *entry ); + /** + * Sets an entry (name/value pair). The return value indicates if there + * was a problem storing the data in memory. However it does not + * reflect if the value was actually stored in the preferences + * file. + * + * \param[in] entry name of entry + * \param[in] value set this entry to \a value + * \return 0 if setting the value failed + */ char set( const char *entry, int value ); + + /** + * Sets an entry (name/value pair). The return value indicates if there + * was a problem storing the data in memory. However it does not + * reflect if the value was actually stored in the preferences + * file. + * + * \param[in] entry name of entry + * \param[in] value set this entry to \a value + * \return 0 if setting the value failed + */ char set( const char *entry, float value ); + + /** + * Sets an entry (name/value pair). The return value indicates if there + * was a problem storing the data in memory. However it does not + * reflect if the value was actually stored in the preferences + * file. + * + * \param[in] entry name of entry + * \param[in] value set this entry to \a value + * \param[in] precision number of decimal digits to represent value + * \return 0 if setting the value failed + */ char set( const char *entry, float value, int precision ); + + /** + * Sets an entry (name/value pair). The return value indicates if there + * was a problem storing the data in memory. However it does not + * reflect if the value was actually stored in the preferences + * file. + * + * \param[in] entry name of entry + * \param[in] value set this entry to \a value + * \return 0 if setting the value failed + */ char set( const char *entry, double value ); + + /** + * Sets an entry (name/value pair). The return value indicates if there + * was a problem storing the data in memory. However it does not + * reflect if the value was actually stored in the preferences + * file. + * + * \param[in] entry name of entry + * \param[in] value set this entry to \a value + * \param[in] precision number of decimal digits to represent value + * \return 0 if setting the value failed + */ char set( const char *entry, double value, int precision ); + + /** + * Sets an entry (name/value pair). The return value indicates if there + * was a problem storing the data in memory. However it does not + * reflect if the value was actually stored in the preferences + * file. + * + * \param[in] entry name of entry + * \param[in] value set this entry to \a value + * \return 0 if setting the value failed + */ char set( const char *entry, const char *value ); + + /** + * Sets an entry (name/value pair). The return value indicates if there + * was a problem storing the data in memory. However it does not + * reflect if the value was actually stored in the preferences + * file. + * + * \param[in] entry name of entry + * \param[in] value set this entry to \a value + * \param[in] size of data array + * \return 0 if setting the value failed + */ char set( const char *entry, const void *value, int size ); + + /** + * Reads an entry from the group. A default value must be + * supplied. The return value indicates if the value was available + * (non-zero) or the default was used (0). + * + * \param[in] entry name of entry + * \param[out] value returned from preferences or default value if none was set + * \param[in] defaultValue default value to be used if no preference was set + * \return 0 if the default value was used + */ char get( const char *entry, int &value, int defaultValue ); + + /** + * Reads an entry from the group. A default value must be + * supplied. The return value indicates if the value was available + * (non-zero) or the default was used (0). + * + * \param[in] entry name of entry + * \param[out] value returned from preferences or default value if none was set + * \param[in] defaultValue default value to be used if no preference was set + * \return 0 if the default value was used + */ char get( const char *entry, float &value, float defaultValue ); + + /** + * Reads an entry from the group. A default value must be + * supplied. The return value indicates if the value was available + * (non-zero) or the default was used (0). + * + * \param[in] entry name of entry + * \param[out] value returned from preferences or default value if none was set + * \param[in] defaultValue default value to be used if no preference was set + * \return 0 if the default value was used + */ char get( const char *entry, double &value, double defaultValue ); + + /** + * Reads an entry from the group. A default value must be + * supplied. The return value indicates if the value was available + * (non-zero) or the default was used (0). get() allocates memory of + * sufficient size to hold the value. The buffer must be free'd by + * the developer using '<tt>free(value)</tt>'. + * + * \param[in] entry name of entry + * \param[out] value returned from preferences or default value if none was set + * \param[in] defaultValue default value to be used if no preference was set + * \return 0 if the default value was used + */ char get( const char *entry, char *&value, const char *defaultValue ); + + /** + * Reads an entry from the group. A default value must be + * supplied. The return value indicates if the value was available + * (non-zero) or the default was used (0). + * '<tt>maxSize</tt>' is the maximum length of text that will be read. + * The text buffer must allow for one additional byte for a trailling zero. + * + * \param[in] entry name of entry + * \param[out] value returned from preferences or default value if none was set + * \param[in] defaultValue default value to be used if no preference was set + * \param[in] maxSize maximum length of value plus one byte for a trailing zero + * \return 0 if the default value was used + */ char get( const char *entry, char *value, const char *defaultValue, int maxSize ); + + /** + * Reads an entry from the group. A default value must be + * supplied. The return value indicates if the value was available + * (non-zero) or the default was used (0). get() allocates memory of + * sufficient size to hold the value. The buffer must be free'd by + * the developer using '<tt>free(value)</tt>'. + * + * \param[in] entry name of entry + * \param[out] value returned from preferences or default value if none was set + * \param[in] defaultValue default value to be used if no preference was set + * \param[in] defaultSize size of default value array + * \return 0 if the default value was used + */ char get( const char *entry, void *&value, const void *defaultValue, int defaultSize ); + + /** + * Reads an entry from the group. A default value must be + * supplied. The return value indicates if the value was available + * (non-zero) or the default was used (0). + * '<tt>maxSize</tt>' is the maximum length of text that will be read. + * + * \param[in] entry name of entry + * \param[out] value returned from preferences or default value if none was set + * \param[in] defaultValue default value to be used if no preference was set + * \param[in] defaultSize size of default value array + * \param[in] maxSize maximum length of value + * \return 0 if the default value was used + * + * \todo maxSize should receive the number of bytes that were read. + */ char get( const char *entry, void *value, const void *defaultValue, int defaultSize, int maxSize ); + + /** + * Returns the size of the value part of an entry. + * + * \return size of value + */ int size( const char *entry ); + + /** + * Creates a path that is related to the preferences file and + * that is usable for application data beyond what is covered by + * Fl_Preferences. + * + * \param[out] path buffer for user data path + * \param[in] pathlen size of path buffer + * \return 0 if path was not created or pathname can't fit into buffer + */ char getUserdataPath( char *path, int pathlen ); + + /** + * Write all preferences to disk. This function works only with + * the base preference group. This function is rarely used as + * deleting the base preferences flushes automatically. + */ void flush(); // char export( const char *filename, Type fileFormat ); // char import( const char *filename ); + /** + * 'Name' provides a simple method to create numerical or more complex + * procedural names for entries and groups on the fly. + * + * Example: <tt>prefs.set(Fl_Preferences::Name("File%d",i),file[i]);</tt>. + * + * See <tt>test/preferences.cxx</tt> as a sample for writing arrays into preferences.<p> + * 'Name' is actually implemented as a class inside Fl_Preferences. It casts + * into <tt>const char*</tt> and gets automatically destroyed after the enclosing call + * ends. + */ class FL_EXPORT Name { + char *data_; + public: + + /** + * Create a numerical name. + */ Name( unsigned int n ); + + /** + * Create a name using 'printf' style formatting. + */ Name( const char *format, ... ); + + /** + * Return the Name as a c-string. + * \internal + */ operator const char *() { return data_; } ~Name(); }; diff --git a/FL/Xutf8.h b/FL/Xutf8.h new file mode 100644 index 000000000..2b79ede30 --- /dev/null +++ b/FL/Xutf8.h @@ -0,0 +1,193 @@ +/* + * "$Id: $" + * + * X11 UTF-8 text drawing functions. + * + * Copyright (c) 2000-2003, OksiD Software, Jean-Marc Lienher + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * Neither the name of OksiD Software nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER + * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * + * Author: Jean-Marc Lienher ( http://oksid.ch ) + */ + + +#ifndef _Xutf8_h +#define _Xutf8_h + +# ifdef __cplusplus +extern "C" { +# endif + +#include <X11/X.h> +#include <X11/Xlib.h> +#include <X11/Xlocale.h> +#include <X11/Xutil.h> + +typedef struct { + int nb_font; + char **font_name_list; + int *encodings; + XFontStruct **fonts; + Font fid; + int ascent; + int descent; + int *ranges; +} XUtf8FontStruct; + +XUtf8FontStruct * +XCreateUtf8FontStruct ( + Display *dpy, + const char *base_font_name_list); + +void +XUtf8DrawString( + Display *display, + Drawable d, + XUtf8FontStruct *font_set, + GC gc, + int x, + int y, + const char *string, + int num_bytes); + +void +XUtf8DrawRtlString( + Display *display, + Drawable d, + XUtf8FontStruct *font_set, + GC gc, + int x, + int y, + const char *string, + int num_bytes); + +void +XUtf8DrawImageString( + Display *display, + Drawable d, + XUtf8FontStruct *font_set, + GC gc, + int x, + int y, + const char *string, + int num_bytes); + +int +XUtf8TextWidth( + XUtf8FontStruct *font_set, + const char *string, + int num_bytes); +int +XUtf8UcsWidth( + XUtf8FontStruct *font_set, + unsigned int ucs); + +int +XGetUtf8FontAndGlyph( + XUtf8FontStruct *font_set, + unsigned int ucs, + XFontStruct **fnt, + unsigned short *id); + +void +XFreeUtf8FontStruct( + Display *dpy, + XUtf8FontStruct *font_set); + + +int +XConvertUtf8ToUcs( + const unsigned char *buf, + int len, + unsigned int *ucs); + +int +XConvertUcsToUtf8( + unsigned int ucs, + char *buf); + +int +XUtf8CharByteLen( + const unsigned char *buf, + int len); + +int +XCountUtf8Char( + const unsigned char *buf, + int len); + +int +XFastConvertUtf8ToUcs( + const unsigned char *buf, + int len, + unsigned int *ucs); + +long +XKeysymToUcs( + KeySym keysym); + +int +XUtf8LookupString( + XIC ic, + XKeyPressedEvent* event, + char* buffer_return, + int bytes_buffer, + KeySym* keysym, + Status* status_return); + +unsigned short +XUtf8IsNonSpacing( + unsigned int ucs); + +unsigned short +XUtf8IsRightToLeft( + unsigned int ucs); + + +int +XUtf8Tolower( + int ucs); + +int +XUtf8Toupper( + int ucs); + + +# ifdef __cplusplus +} +# endif + +#endif + +/* + * End of "$Id: $". + */ + diff --git a/FL/fl_utf8.H b/FL/fl_utf8.H new file mode 100644 index 000000000..7f93e1059 --- /dev/null +++ b/FL/fl_utf8.H @@ -0,0 +1,248 @@ +// +// Copyright 1998-2005 by Bill Spitzak and others. +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Library General Public +// License as published by the Free Software Foundation; either +// version 2 of the License, or (at your option) any later version +// with exceptions that allow sub-classing and static linking in +// non-LGPL compliant software. These exceptions are subject to +// conditions, see the FLTK License for more details. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the FLTK +// License for more details. +// +// You should have received a copy of the FLTK License along with +// this library; if not, write to OksiD Software, Jean-Marc Lienher, +// Rue de la Cheminee 1, CH-2065 Savagnier, Switzerland. +// +// Please report all bugs and problems to "oksid@bluewin.ch". +// + +// Merged in some functionality from the fltk-2 version. IMM. +// The following code is an attempt to merge the functions incorporated in FLTK2 +// with the functions provided in OksiD's fltk-1.1.6-utf8 port + +/*** NOTE : all functions are LIMITED to 24 bits Unicode values !!! ***/ + +#ifndef _HAVE_FL_UTF8_HDR_ +# define _HAVE_FL_UTF8_HDR_ +# include <stdio.h> +# include <string.h> +# include <stdlib.h> + +# ifndef FL_EXPORT +# if defined(FL_DLL) && defined(_MSC_VER) +# ifdef FL_LIBRARY +# define FL_EXPORT __declspec(dllexport) +# else +# define FL_EXPORT __declspec(dllimport) +# endif /* FL_LIBRARY */ +# else +# define FL_EXPORT +# endif /* FL_DLL && _MSC_VER */ +# endif /* FL_EXPORT */ + + + +# if __APPLE__ +# include <wchar.h> +# include <sys/stat.h> +# else +# include <sys/types.h> +# include <sys/stat.h> +# ifndef _WIN32 +# include "Xutf8.h" +# include <X11/Xlocale.h> +# include <X11/Xlib.h> +# endif +# include <locale.h> +# endif + + + +# if defined(WIN32) +# include <ctype.h> +# define xchar wchar_t +# else +# if __APPLE__ +# define xchar wchar_t +# else +# define xchar unsigned short +# endif +# endif + +# if defined(WIN32) && !defined(FL_DLL) +# undef strdup +# define strdup _strdup +# undef putenv +# define putenv _putenv +# undef stricmp +# define stricmp _stricmp +# undef strnicmp +# define strnicmp _strnicmp +# undef hypot +# define hypot _hypot +# undef chdir +# define chdir _chdir +# endif + +# ifdef __cplusplus +extern "C" { +# endif + +/* F2: comes from FLTK2 */ +/* OD: comes from OksiD */ + +/* F2: How many bytes will be used to encode this wide character as UTF8? */ +FL_EXPORT int fl_utf8bytes(unsigned ucs); + +/* OD: returns the byte length of the first UTF-8 char sequence (returns -1 if not valid) */ +FL_EXPORT int fl_utf8len(char c); + +/* OD: returns the number of Unicode chars in the UTF-8 string */ +FL_EXPORT int fl_utf_nb_char(const unsigned char *buf, int len); + +/* F2: Convert the next UTF8 char-sequence into a Unicode value (and say how many bytes were used) */ +FL_EXPORT unsigned fl_utf8decode(const char* start, const char* end, int* len); + +/* F2: Encode a Unicode value into a UTF8 sequence, return the number of bytes used */ +FL_EXPORT int fl_utf8encode(unsigned ucs, char* buf); + +/* F2: Move forward to the next valid UTF8 sequence start betwen start and end */ +FL_EXPORT const char* fl_utf8fwd(const char* pos, const char* start, const char* end); + +/* F2: Move backward to the previous valid UTF8 sequence start */ +FL_EXPORT const char* fl_utf8back(const char* pos, const char* start, const char* end); + +/* F2: Convert a UTF8 string into UTF16 */ +FL_EXPORT unsigned fl_utf8toUtf16(const char* src, unsigned srclen, unsigned short* dst, unsigned dstlen); + +/* F2: Convert a UTF8 string into a wide character string - makes UTF16 on win32, "UCS4" elsewhere */ +FL_EXPORT unsigned fl_utf8towc(const char *src, unsigned srclen, wchar_t *dst, unsigned dstlen); + +/* F2: Convert a wide character string to UTF8 - takes in UTF16 on win32, "UCS4" elsewhere */ +FL_EXPORT unsigned fl_utf8fromwc(char *dst, unsigned dstlen, const wchar_t *src, unsigned srclen); + +/* F2: Convert a UTF8 string into ASCII, eliding untranslatable glyphs */ +FL_EXPORT unsigned fl_utf8toa (const char *src, unsigned srclen, char *dst, unsigned dstlen); +/* OD: convert UTF-8 string to latin1 */ +//FL_EXPORT int fl_utf2latin1(const unsigned char *src, int srclen, char *dst); + +/* F2: Convert 8859-1 string to UTF8 */ +FL_EXPORT unsigned fl_utf8froma (char *dst, unsigned dstlen, const char *src, unsigned srclen); +/* OD: convert latin1 str to UTF-8 */ +//FL_EXPORT int fl_latin12utf(const unsigned char *src, int srclen, char *dst); + +/* F2: Returns true if the current O/S locale is UTF8 */ +FL_EXPORT int fl_utf8locale(); + +/* F2: Examine the first len characters of src, to determine if the input text is UTF8 or not + * NOTE: The value returned is not simply boolean - it contains information about the probable + * type of the src text. */ +FL_EXPORT int fl_utf8test(const char *src, unsigned len); + +/* OD: Return true if the character is non-spacing */ +FL_EXPORT unsigned int fl_nonspacing(unsigned int ucs); + +/* F2: Convert UTF8 to a local multi-byte encoding - mainly for win32? */ +FL_EXPORT unsigned fl_utf8to_mb(const char *src, unsigned srclen, char *dst, unsigned dstlen); +/* OD: Convert UTF8 to a local multi-byte encoding */ +FL_EXPORT char* fl_utf2mbcs(const char *src); + +/* F2: Convert a local multi-byte encoding to UTF8 - mainly for win32? */ +FL_EXPORT unsigned fl_utf8from_mb(char *dst, unsigned dstlen, const char *src, unsigned srclen); +/* OD: Convert a local multi-byte encoding to UTF8 */ +//FL_EXPORT char* fl_mbcs2utf(const char *src); + +/*****************************************************************************/ +#ifdef WIN32 +/* OD: Attempt to convert the UTF8 string to the current locale */ +FL_EXPORT char *fl_utf8_to_locale(const char *s, int len, unsigned int codepage); + +/* OD: Attempt to convert a string in the current locale to UTF8 */ +FL_EXPORT char *fl_locale_to_utf8(const char *s, int len, unsigned int codepage); +#endif + +/*****************************************************************************/ +// The following functions are intended to provide portable, UTF8 aware +// versions of standard functions + +/* OD: UTF8 aware strncasecmp - converts to lower case Unicode and tests */ +FL_EXPORT int fl_utf_strncasecmp(const char *s1, const char *s2, int n); + +/* OD: UTF8 aware strcasecmp - converts to Unicode and tests */ +FL_EXPORT int fl_utf_strcasecmp(const char *s1, const char *s2); + +/* OD: return the Unicode lower case value of ucs */ +FL_EXPORT int fl_tolower(unsigned int ucs); + +/* OD: return the Unicode upper case value of ucs */ +FL_EXPORT int fl_toupper(unsigned int ucs); + +/* OD: converts the UTF8 string to the lower case equivalent */ +FL_EXPORT int fl_utf_tolower(const unsigned char *str, int len, char *buf); + +/* OD: converts the UTF8 string to the upper case equivalent */ +FL_EXPORT int fl_utf_toupper(const unsigned char *str, int len, char *buf); + +/* OD: Portable UTF8 aware chmod wrapper */ +FL_EXPORT int fl_chmod(const char* f, int mode); + +/* OD: Portable UTF8 aware access wrapper */ +FL_EXPORT int fl_access(const char* f, int mode); + +/* OD: Portable UTF8 aware stat wrapper */ +FL_EXPORT int fl_stat( const char *path, struct stat *buffer ); + +/* OD: Portable UTF8 aware getcwd wrapper */ +FL_EXPORT char* fl_getcwd( char *buf, int maxlen); + +/* OD: Portable UTF8 aware fopen wrapper */ +FL_EXPORT FILE *fl_fopen(const char *f, const char *mode); + +/* OD: Portable UTF8 aware system wrapper */ +FL_EXPORT int fl_system(const char* f); + +/* OD: Portable UTF8 aware execvp wrapper */ +FL_EXPORT int fl_execvp(const char *file, char *const *argv); + +/* OD: Portable UTF8 aware open wrapper */ +FL_EXPORT int fl_open(const char* f, int o, ...); + +/* OD: Portable UTF8 aware unlink wrapper */ +FL_EXPORT int fl_unlink(const char *f); + +/* OD: Portable UTF8 aware rmdir wrapper */ +FL_EXPORT int fl_rmdir(const char *f); + +/* OD: Portable UTF8 aware getenv wrapper */ +FL_EXPORT char* fl_getenv(const char *name); + +/* OD: Portable UTF8 aware execvp wrapper */ +FL_EXPORT int fl_mkdir(const char* f, int mode); + +/* OD: Portable UTF8 aware rename wrapper */ +FL_EXPORT int fl_rename(const char* f, const char *t); + + +/* OD: Given a full pathname, this will create the directory path needed to hold the file named */ +FL_EXPORT void fl_make_path_for_file( const char *path ); + +/* OD: recursively create a path in the file system */ +FL_EXPORT char fl_make_path( const char *path ); + +/*****************************************************************************/ + +#ifdef __cplusplus +} +#endif /* __cplusplus */ + + +#endif // _HAVE_FL_UTF8_HDR_ + +// +// End of "$Id: $". +// diff --git a/documentation/FL200.gif b/documentation/FL200.gif Binary files differnew file mode 100644 index 000000000..9df861dc7 --- /dev/null +++ b/documentation/FL200.gif diff --git a/documentation/index.dox b/documentation/index.dox new file mode 100644 index 000000000..528bf3b0e --- /dev/null +++ b/documentation/index.dox @@ -0,0 +1,101 @@ +/** + +\mainpage FLTK Programming Manual + +<TABLE BGCOLOR="#9f9f9f" CELLPADDING="8" CELLSPACING="0" SUMMARY="TITLE BAR" WIDTH="700"> +<TR> + <TD VALIGN="MIDDLE"> + \image html FL200.gif + <TD ALIGN="CENTER" VALIGN="MIDDLE"> + <H1>FLTK 1.3.0 Programming Manual</H1> + <P>Revision 8 by Michael Sweet, Craig P. Earls,<br>Matthias Melcher, and Bill Spitzak<BR> + Copyright 1998-2008 by Bill Spitzak and others.</P> + </TD> +</TR> +<TR> + <TH COLSPAN=2>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.</TH> +</TR> +</TABLE> + +<TABLE BGCOLOR="#9f9fef" CELLPADDING="8" CELLSPACING="0" SUMMARY="Table of Contents" WIDTH="700"> +<TR> + <TD ALIGN="LEFT" VALIGN="TOP"><B> + \subpage preface + </B> + <BR> + <BR> + <B><A HREF="intro.html#intro">1 - Introduction to FLTK</A></B> + <BR> + <BR> + <B><A HREF="basics.html#basics">2 - FLTK Basics</A></B> + <BR> + <BR> + <B><A HREF="common.html#common">3 - Common Widgets and Attributes</A></B> + <UL> + <LI><A HREF="drawing.html#colors">Colors</A></LI> + <LI><A HREF="common.html#boxtypes">Box Types</A></LI> + <LI><A HREF="common.html#labels">Labels and Label Types</A></LI> + <LI><A HREF="drawing.html#images">Images</A></LI> + <LI><A HREF="Fl_Pixmap.html#Fl_Pixmap">class Fl_Pixmap</A></LI> + </UL> + <B><A HREF="editor.html#editor">4 - Designing a Simple Text Editor</A></B> + <BR> + <BR> + <B><A HREF="drawing.html#drawing">5 - Drawing Things in FLTK</A></B> + <BR> + <BR> + <B><A HREF="events.html#events">6 - Handling Events</A></B> + <UL> + <LI><A HREF="events.html#event_xxx">Fl::event_*() methods</A></LI> + <LI><A HREF="events.html#propagation">Event Propagation</A></LI> + </UL> + <B><A HREF="subclassing.html#subclassing">7 - Adding and Extending + Widgets</A></B> + <BR> + <BR> + <B><A HREF="opengl.html#opengl">8 - Using OpenGL</A></B> + </TD> + <TD ALIGN=LEFT VALIGN=TOP> + <B><A HREF="fluid.html#FLUID">9 - Programming with FLUID</A></B> + <UL> + <LI><A HREF="fluid.html#widget_attributes">Widget Attributes</A></LI> + <LI><A HREF="fluid.html#widget_attributes">Selecting Moving Widgets</A></LI> + <LI><A HREF="fluid.html#images">Image Labels</A></LI> + </UL> + <B><A HREF="advanced.html#advanced">10 - Advanced FLTK</A></B> + <BR> + <BR> + <B><A HREF="classes.html">A - Class Reference</A></B> + <BR> + <BR> + <B><A HREF="globals_func.html">B - Function Reference</A></B> + <BR> + <BR> + <B><A HREF="enumerations.html#Enumerations">C - FLTK Enumerations.H</A> + </B> + <BR> + <BR> + <B><A HREF="glut.html#glut">D - GLUT Compatibility</A></B> + <UL> + <LI><A HREF="glut.html#Fl_Glut_Window">class Fl_Glut_Window</A></LI> + </UL> + <B><A HREF="forms.html#forms">E - Forms Compatibility</A></B> + <BR> + <BR> + <B><A HREF="osissues.html#osissues">F - Operating System Issues</A></B> + <BR> + <BR> + <B><A HREF="migration.html">G - Migrating Code from FLTK 1.0.x</A></B> + <BR> + <BR> + <B><A HREF="license.html#license">H - Software License</A></B> + <BR> + <BR> + <B><A HREF="examples.html#examples">I - Example Source Code</A></B> + </TD> +</TR> +</TABLE> + +*/ + + diff --git a/documentation/preface.dox b/documentation/preface.dox new file mode 100644 index 000000000..4c004ba44 --- /dev/null +++ b/documentation/preface.dox @@ -0,0 +1,108 @@ +/** + + \page preface Preface + +<P>This manual describes the Fast Light Tool Kit ("FLTK") +version 1.1.8, a C++ Graphical User Interface +("GUI") toolkit for UNIX, Microsoft Windows and MacOS. Each +of the chapters in this manual is designed as a tutorial for +using FLTK, while the appendices provide a convenient reference +for all FLTK widgets, functions, and operating system +interfaces.</P> + +<P><B>This manual may be printed, modified, and/or used under +the terms of the FLTK license provided in <A +HREF="license.html">Appendix A</A>.</B> + +<H2>Organization</H2> + +<P>This manual is organized into the following chapters and appendices:</P> + +<UL> + + <LI><A HREF="intro.html#intro">Chapter 1 - Introduction to FLTK</A></LI> + + <LI><A HREF="basics.html#basics">Chapter 2 - FLTK Basics</A></LI> + + <LI><A HREF="common.html#common">Chapter 3 - Common Widgets and Attributes</A></LI> + + <LI><A HREF="editor.html#editor">Chapter 4 - Designing a Simple Text + Editor</A></LI> + + <LI><A HREF="drawing.html#drawing">Chapter 5 - Drawing Things in FLTK</A></LI> + + <LI><A HREF="events.html#events">Chapter 6 - Handling Events</A></LI> + + <LI><A HREF="subclassing.html#subclassing">Chapter 7 - Extending and + Adding Widgets</A></LI> + + <LI><A HREF="opengl.html#opengl">Chapter 8 - Using OpenGL</A></LI> + + <LI><A HREF="fluid.html#FLUID">Chapter 9 - Programming With FLUID</A></LI> + + <LI><A HREF="widgets.html#widgets">Appendix A - Class Reference</A></LI> + + <LI><A HREF="functions.html#functions">Appendix B - Function Reference</A></LI> + + <LI><A HREF="enumerations.html#Enumerations">Appendix C - Enumeration + Reference</A></LI> + + <LI><A HREF="glut.html#glut">Appendix D - GLUT Compatibility</A></LI> + + <LI><A HREF="forms.html#forms">Appendix E - Forms Compatibility</A></LI> + + <LI><A HREF="osissues.html#osissues">Appendix F - Operating System Issues</A></LI> + + <LI><A HREF="migration.html">Appendix G - Migrating from FLTK 1.0.x to FLTK 1.1.x</A></LI> + + <LI><A HREF="license.html#license">Appendix H - Software License</A></LI> + + <LI><A HREF="examples.html#examples">Appendix I - Example Source Code</A></LI> + +</UL> + +<H2>Conventions</H2> + +<P>The following typeface conventions are used in this manual:</P> + +<UL> + <LI>Function and constant names are shown in <B><TT>bold courier type</TT></B></LI> + + <LI>Code samples and commands are shown in <TT>regular courier type</TT></LI> + +</UL> + +<H2>Abbreviations</H2> + +<P>The following abbreviations are used in this manual:</P> + +<DL> + + <DT>X11</DT> + <DD>The X Window System version 11.</DD> + + <DT>Xlib</DT> + <DD>The X Window System interface library.</DD> + + <DT>WIN32</DT> + <DD>The Microsoft Windows 32-bit Application Programmer's Interface.</DD> + + <DT>MacOS</DT> + <DD>The Apple Macintosh OS 8.6 and later, including OS X.</DD> + +</DL> + +<H2>Copyrights and Trademarks</H2> + +<P>FLTK is Copyright 1998-2006 by Bill Spitzak and others. Use and +distribution of FLTK is governed by the GNU Library General Public +License, located in <A HREF="license.html#license">Appendix H</A>.</P> + +<P>UNIX is a registered trademark of the X Open Group, Inc. +Microsoft and Windows are registered trademarks of Microsoft +Corporation. OpenGL is a registered trademark of Silicon +Graphics, Inc. Apple, Macintosh, MacOS, and Mac OS X are +registered trademarks of Apple Computer, Inc.</P> + +*/ + |
