diff options
author | Simon Howard | 2009-03-12 22:20:07 +0000 |
---|---|---|
committer | Simon Howard | 2009-03-12 22:20:07 +0000 |
commit | 6e2c404f64f39e059848bc66b707dfe979f044ff (patch) | |
tree | cd0aba502696ceef12bd311d4576fd46c4dd5c02 /textscreen | |
parent | 20cb00076d39bcb8a5c2e82912af8200c97034cb (diff) | |
parent | 535c64b336ce59b4e18819544cd2a1129ae97c61 (diff) | |
download | chocolate-doom-6e2c404f64f39e059848bc66b707dfe979f044ff.tar.gz chocolate-doom-6e2c404f64f39e059848bc66b707dfe979f044ff.tar.bz2 chocolate-doom-6e2c404f64f39e059848bc66b707dfe979f044ff.zip |
Update from trunk.
Subversion-branch: /branches/raven-branch
Subversion-revision: 1467
Diffstat (limited to 'textscreen')
-rw-r--r-- | textscreen/Doxyfile | 1366 | ||||
-rw-r--r-- | textscreen/Makefile.am | 3 | ||||
-rw-r--r-- | textscreen/txt_button.h | 41 | ||||
-rw-r--r-- | textscreen/txt_checkbox.h | 41 | ||||
-rw-r--r-- | textscreen/txt_desktop.h | 37 | ||||
-rw-r--r-- | textscreen/txt_dropdown.h | 30 | ||||
-rw-r--r-- | textscreen/txt_inputbox.h | 38 | ||||
-rw-r--r-- | textscreen/txt_label.h | 43 | ||||
-rw-r--r-- | textscreen/txt_radiobutton.h | 43 | ||||
-rw-r--r-- | textscreen/txt_scrollpane.c | 8 | ||||
-rw-r--r-- | textscreen/txt_scrollpane.h | 24 | ||||
-rw-r--r-- | textscreen/txt_separator.h | 23 | ||||
-rw-r--r-- | textscreen/txt_spinctrl.h | 36 | ||||
-rw-r--r-- | textscreen/txt_strut.h | 26 | ||||
-rw-r--r-- | textscreen/txt_table.h | 124 | ||||
-rw-r--r-- | textscreen/txt_widget.h | 55 | ||||
-rw-r--r-- | textscreen/txt_window.h | 101 | ||||
-rw-r--r-- | textscreen/txt_window_action.h | 50 |
18 files changed, 2060 insertions, 29 deletions
diff --git a/textscreen/Doxyfile b/textscreen/Doxyfile new file mode 100644 index 00000000..49116fed --- /dev/null +++ b/textscreen/Doxyfile @@ -0,0 +1,1366 @@ +# Doxyfile 1.5.5 + +# 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 +#--------------------------------------------------------------------------- + +# 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 +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = "libtextscreen" + +# 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 = + +# 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 = . + +# 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, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, +# and Ukrainian. + +OUTPUT_LANGUAGE = English + +# 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 = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# 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 = NO + +# 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 = src/ + +# 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 regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +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 comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +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 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 = YES + +# 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 + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +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. + +OPTIMIZE_OUTPUT_VHDL = 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 you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip 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. + +SIP_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 + +# When TYPEDEF_HIDES_STRUCT 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. + +TYPEDEF_HIDES_STRUCT = NO + +#--------------------------------------------------------------------------- +# 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 = YES + +# 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 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. + +EXTRACT_ANON_NSPACES = 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 = YES + +# 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 = YES + +# 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 = YES + +# 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_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +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 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 = . + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +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 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 *.f90 + +FILE_PATTERNS = *.h + +# 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 = NO + +# 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 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 + +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 = + +# 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 = * + +# 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 = + +# 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 = NO + +# 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 = NO + +# 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 = NO + +#--------------------------------------------------------------------------- +# 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 = NO + +# 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 = + +#--------------------------------------------------------------------------- +# 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 compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# 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, 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. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# 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. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, 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. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# 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. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = 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 = 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. + +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 = YES + +# 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 = YES + +#--------------------------------------------------------------------------- +# 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 = 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. + +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 = DOXYGEN + +# 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 = NO + +# 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 = + +# 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 options 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_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. + +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. + +MAX_DOT_GRAPH_DEPTH = 1000 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is enabled by default, which results in a transparent +# 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/textscreen/Makefile.am b/textscreen/Makefile.am index d09538fd..7730e930 100644 --- a/textscreen/Makefile.am +++ b/textscreen/Makefile.am @@ -30,3 +30,6 @@ libtextscreen_a_SOURCES = \ txt_window_action.c txt_window_action.h \ txt_font.h +doc: + doxygen + diff --git a/textscreen/txt_button.h b/textscreen/txt_button.h index 11040f2f..7c16c01b 100644 --- a/textscreen/txt_button.h +++ b/textscreen/txt_button.h @@ -22,6 +22,19 @@ #ifndef TXT_BUTTON_H #define TXT_BUTTON_H +/** + * @file txt_button.h + * + * Button widget. + */ + +/** + * Button widget. + * + * A button is a widget that can be selected to perform some action. + * When a button is pressed, it emits the "pressed" signal. + */ + typedef struct txt_button_s txt_button_t; #include "txt_widget.h" @@ -32,9 +45,35 @@ struct txt_button_s char *label; }; +/** + * Create a new button widget. + * + * @param label The label to use on the new button. + * @return Pointer to the new button widget. + */ + txt_button_t *TXT_NewButton(char *label); -txt_button_t *TXT_NewButton2(char *label, TxtWidgetSignalFunc func, + +/** + * Create a new button widget, binding the "pressed" signal to a + * specified callback function. + * + * @param label The label to use on the new button. + * @param func The callback function to invoke. + * @param user_data User-specified pointer to pass to the callback. + * @return Pointer to the new button widget. + */ + +txt_button_t *TXT_NewButton2(char *label, TxtWidgetSignalFunc func, void *user_data); + +/** + * Change the label used on a button. + * + * @param button The button. + * @param label The new label. + */ + void TXT_SetButtonLabel(txt_button_t *button, char *label); #endif /* #ifndef TXT_BUTTON_H */ diff --git a/textscreen/txt_checkbox.h b/textscreen/txt_checkbox.h index 1b34c3a0..d9ba8d02 100644 --- a/textscreen/txt_checkbox.h +++ b/textscreen/txt_checkbox.h @@ -22,6 +22,25 @@ #ifndef TXT_CHECKBOX_H #define TXT_CHECKBOX_H +/** + * @file txt_checkbox.h + * + * Checkbox widget. + */ + +/** + * Checkbox widget. + * + * A checkbox is used to control boolean values that may be either on + * or off. The widget has a label that is displayed to the right of + * the checkbox indicator. The widget tracks an integer variable; + * if the variable is non-zero, the checkbox is checked, while if it + * is zero, the checkbox is unchecked. It is also possible to + * create "inverted" checkboxes where this logic is reversed. + * + * When a checkbox is changed, it emits the "changed" signal. + */ + typedef struct txt_checkbox_s txt_checkbox_t; #include "txt_widget.h" @@ -34,7 +53,29 @@ struct txt_checkbox_s int inverted; }; +/** + * Create a new checkbox. + * + * @param label The label for the new checkbox. + * @param variable Pointer to the variable containing this checkbox's + * value. + * @return Pointer to the new checkbox. + */ + txt_checkbox_t *TXT_NewCheckBox(char *label, int *variable); + +/** + * Create a new inverted checkbox. + * + * An inverted checkbox displays the opposite of a normal checkbox; + * where it would be checked, it appears unchecked, and vice-versa. + * + * @param label The label for the new checkbox. + * @param variable Pointer to the variable containing this checkbox's + * value. + * @return Pointer to the new checkbox. + */ + txt_checkbox_t *TXT_NewInvertedCheckBox(char *label, int *variable); #endif /* #ifndef TXT_CHECKBOX_H */ diff --git a/textscreen/txt_desktop.h b/textscreen/txt_desktop.h index 40c89a48..95343977 100644 --- a/textscreen/txt_desktop.h +++ b/textscreen/txt_desktop.h @@ -22,18 +22,47 @@ #ifndef TXT_DESKTOP_H #define TXT_DESKTOP_H +/** + * @file txt_desktop.h + * + * Textscreen desktop. + */ + #include "txt_window.h" void TXT_AddDesktopWindow(txt_window_t *win); void TXT_RemoveDesktopWindow(txt_window_t *win); -void TXT_SetDesktopTitle(char *title); void TXT_DrawDesktop(void); -void TXT_GUIMainLoop(void); void TXT_DispatchEvents(void); -void TXT_ExitMainLoop(void); void TXT_DrawWindow(txt_window_t *window, int selected); void TXT_WindowKeyPress(txt_window_t *window, int c); -#endif /* #ifndef TXT_DESKTOP_T */ +/** + * Set the title displayed at the top of the screen. + * + * @param title The title to display. + */ + +void TXT_SetDesktopTitle(char *title); + +/** + * Exit the currently-running main loop and return from the + * @ref TXT_GUIMainLoop function. + */ + +void TXT_ExitMainLoop(void); + +/** + * Start the main event loop. At least one window must have been + * opened prior to running this function. When no windows are left + * open, the event loop exits. + * + * It is possible to trigger an exit from this function using the + * @ref TXT_ExitMainLoop function. + */ + +void TXT_GUIMainLoop(void); + +#endif /* #ifndef TXT_DESKTOP_H */ diff --git a/textscreen/txt_dropdown.h b/textscreen/txt_dropdown.h index 1a142b73..19b931d0 100644 --- a/textscreen/txt_dropdown.h +++ b/textscreen/txt_dropdown.h @@ -22,6 +22,22 @@ #ifndef TXT_DROPDOWN_H #define TXT_DROPDOWN_H +/** + * @file txt_dropdown.h + * + * Dropdown list widget. + */ + +/** + * Dropdown list widget. + * + * A dropdown list allows the user to select from a list of values, + * which appears when the list is selected. + * + * When the value of a dropdown list is changed, the "changed" signal + * is emitted. + */ + typedef struct txt_dropdown_list_s txt_dropdown_list_t; #include "txt_widget.h" @@ -38,6 +54,20 @@ struct txt_dropdown_list_s int num_values; }; +/** + * Create a new dropdown list widget. + * + * The parameters specify a list of string labels, and a pointer to an + * integer variable. The variable contains the current "value" of the + * list, as an index within the list of labels. + * + * @param variable Pointer to the variable containing the + * list's value. + * @param values Pointer to an array of strings containing + * the labels to use for the list. + * @param num_values The number of variables in the list. + */ + txt_dropdown_list_t *TXT_NewDropdownList(int *variable, char **values, int num_values); diff --git a/textscreen/txt_inputbox.h b/textscreen/txt_inputbox.h index fa610485..6237bc91 100644 --- a/textscreen/txt_inputbox.h +++ b/textscreen/txt_inputbox.h @@ -22,6 +22,21 @@ #ifndef TXT_INPUTBOX_H #define TXT_INPUTBOX_H +/** + * @file txt_inputbox.h + * + * Input box widget. + */ + +/** + * Input box widget. + * + * An input box is a widget that displays a value, which can be + * selected to enter a new value. + * + * Input box widgets can be of an integer or string type. + */ + typedef struct txt_inputbox_s txt_inputbox_t; #include "txt_widget.h" @@ -35,7 +50,30 @@ struct txt_inputbox_s void *value; }; +/** + * Create a new input box widget for controlling a string value. + * + * @param value Pointer to a string variable that contains + * a pointer to the current value of the + * input box. The value should be allocated + * dynamically; when the string is changed it + * will be freed and the variable set to point + * to the new string value. + * @param size Width of the input box, in characters. + * @return Pointer to the new input box widget. + */ + txt_inputbox_t *TXT_NewInputBox(char **value, int size); + +/** + * Create a new input box widget for controlling an integer value. + * + * @param value Pointer to an integer variable containing + * the value of the input box. + * @param size Width of the input box, in characters. + * @return Pointer to the new input box widget. + */ + txt_inputbox_t *TXT_NewIntInputBox(int *value, int size); #endif /* #ifndef TXT_INPUTBOX_H */ diff --git a/textscreen/txt_label.h b/textscreen/txt_label.h index c8e002e0..16395c93 100644 --- a/textscreen/txt_label.h +++ b/textscreen/txt_label.h @@ -22,6 +22,18 @@ #ifndef TXT_LABEL_H #define TXT_LABEL_H +/** + * @file txt_label.h + * + * Text label widget. + */ + +/** + * Label widget. + * + * A label widget does nothing except show a text label. + */ + typedef struct txt_label_s txt_label_t; #include "txt_main.h" @@ -37,9 +49,40 @@ struct txt_label_s txt_color_t bgcolor; }; +/** + * Create a new label widget. + * + * @param label String to display in the widget. + * @return Pointer to the new label widget. + */ + txt_label_t *TXT_NewLabel(char *label); + +/** + * Set the string displayed in a label widget. + * + * @param label The widget. + * @param value The string to display. + */ + void TXT_SetLabel(txt_label_t *label, char *value); + +/** + * Set the background color of a label widget. + * + * @param label The widget. + * @param color The background color to use. + */ + void TXT_SetBGColor(txt_label_t *label, txt_color_t color); + +/** + * Set the foreground color of a label widget. + * + * @param label The widget. + * @param color The foreground color to use. + */ + void TXT_SetFGColor(txt_label_t *label, txt_color_t color); #endif /* #ifndef TXT_LABEL_H */ diff --git a/textscreen/txt_radiobutton.h b/textscreen/txt_radiobutton.h index d668254c..858f1bb3 100644 --- a/textscreen/txt_radiobutton.h +++ b/textscreen/txt_radiobutton.h @@ -22,6 +22,30 @@ #ifndef TXT_RADIOBUTTON_H #define TXT_RADIOBUTTON_H +/** + * @file txt_radiobutton.h + * + * Radio button widget. + */ + +/** + * A radio button widget. + * + * Radio buttons are typically used in groups, to allow a value to be + * selected from a range of options. Each radio button corresponds + * to a particular option that may be selected. A radio button + * has an indicator to indicate whether it is the currently-selected + * value, and a text label. + * + * Internally, a radio button tracks an integer variable that may take + * a range of different values. Each radio button has a particular + * value associated with it; if the variable is equal to that value, + * the radio button appears selected. If a radio button is pressed + * by the user through the GUI, the variable is set to its value. + * + * When a radio button is selected, the "selected" signal is emitted. + */ + typedef struct txt_radiobutton_s txt_radiobutton_t; #include "txt_widget.h" @@ -34,7 +58,26 @@ struct txt_radiobutton_s int value; }; +/** + * Create a new radio button widget. + * + * @param label The label to display next to the radio button. + * @param variable Pointer to the variable tracking whether this + * radio button is selected. + * @param value If the variable is equal to this value, the + * radio button appears selected. + * @return Pointer to the new radio button widget. + */ + txt_radiobutton_t *TXT_NewRadioButton(char *label, int *variable, int value); + +/** + * Set the label on a radio button. + * + * @param radiobutton The radio button. + * @param value The new label. + */ + void TXT_SetRadioButtonLabel(txt_radiobutton_t *radiobutton, char *value); #endif /* #ifndef TXT_RADIOBUTTON_H */ diff --git a/textscreen/txt_scrollpane.c b/textscreen/txt_scrollpane.c index e9989f19..ef6e4fb3 100644 --- a/textscreen/txt_scrollpane.c +++ b/textscreen/txt_scrollpane.c @@ -233,8 +233,8 @@ static void ShowSelectedWidget(txt_scrollpane_t *scrollpane) { scrollpane->y -= scrollpane->widget.y - selected->y; } - else if (selected->y + selected->h > - scrollpane->widget.y + scrollpane->h) + else if ((signed) (selected->y + selected->h) > + (signed) (scrollpane->widget.y + scrollpane->h)) { scrollpane->y += (selected->y + selected->h) - (scrollpane->widget.y + scrollpane->h); @@ -246,8 +246,8 @@ static void ShowSelectedWidget(txt_scrollpane_t *scrollpane) { scrollpane->x -= scrollpane->widget.x - selected->x; } - else if (selected->x + selected->w > - scrollpane->widget.x + scrollpane->w) + else if ((signed) (selected->x + selected->w) > + (signed) (scrollpane->widget.x + scrollpane->w)) { scrollpane->x += (selected->x + selected->w) - (scrollpane->widget.x + scrollpane->w); diff --git a/textscreen/txt_scrollpane.h b/textscreen/txt_scrollpane.h index 661542a3..94f81dc1 100644 --- a/textscreen/txt_scrollpane.h +++ b/textscreen/txt_scrollpane.h @@ -22,6 +22,20 @@ #ifndef TXT_SCROLLPANE_H #define TXT_SCROLLPANE_H +/** + * @file txt_scrollpane.h + * + * Scrollable pane widget. + */ + +/** + * Scrollable pane widget. + * + * A scrollable pane widget is a widget that contains another widget + * that is larger than it. Scroll bars appear on the side to allow + * different areas of the contained widget to be seen. + */ + typedef struct txt_scrollpane_s txt_scrollpane_t; #include "txt_widget.h" @@ -35,6 +49,16 @@ struct txt_scrollpane_s txt_widget_t *child; }; +/** + * Create a new scroll pane widget. + * + * @param w Width of the scroll pane, in characters. + * @param h Height of the scroll pane, in lines. + * @param target The target widget that the scroll pane will + * contain. + * @return Pointer to the new scroll pane widget. + */ + txt_scrollpane_t *TXT_NewScrollPane(int w, int h, TXT_UNCAST_ARG(target)); #endif /* #ifndef TXT_SCROLLPANE_H */ diff --git a/textscreen/txt_separator.h b/textscreen/txt_separator.h index c8691171..2f2331da 100644 --- a/textscreen/txt_separator.h +++ b/textscreen/txt_separator.h @@ -22,6 +22,21 @@ #ifndef TXT_SEPARATOR_H #define TXT_SEPARATOR_H +/** + * @file txt_separator.h + * + * Horizontal separator widget. + */ + +/** + * Horizontal separator. + * + * A horizontal separator appears as a horizontal line divider across + * the length of the window in which it is added. An optional label + * allows the separator to be used as a section divider for grouping + * related controls. + */ + typedef struct txt_separator_s txt_separator_t; #include "txt_widget.h" @@ -34,6 +49,14 @@ struct txt_separator_s extern txt_widget_class_t txt_separator_class; +/** + * Create a new horizontal separator widget. + * + * @param label Label to display on the separator. If this is + * set to NULL, no label is displayed. + * @return The new separator widget. + */ + txt_separator_t *TXT_NewSeparator(char *label); #endif /* #ifndef TXT_SEPARATOR_H */ diff --git a/textscreen/txt_spinctrl.h b/textscreen/txt_spinctrl.h index 2fdd2a62..5a815319 100644 --- a/textscreen/txt_spinctrl.h +++ b/textscreen/txt_spinctrl.h @@ -22,7 +22,22 @@ #ifndef TXT_SPINCONTROL_H #define TXT_SPINCONTROL_H +/** + * @file txt_spinctrl.h + * + * Spin control widget. + */ + +/** + * Spin control widget. + * + * A spin control widget works as an input box that can be used to + * set numeric values, but also has buttons that allow its value + * to be increased or decreased. + */ + typedef struct txt_spincontrol_s txt_spincontrol_t; + typedef enum { TXT_SPINCONTROL_INT, @@ -40,7 +55,28 @@ struct txt_spincontrol_s char *buffer; }; +/** + * Create a new spin control widget tracking an integer value. + * + * @param value Pointer to the variable containing the value + * displayed in the widget. + * @param min Minimum value that may be set. + * @param max Maximum value that may be set. + * @return Pointer to the new spin control widget. + */ + txt_spincontrol_t *TXT_NewSpinControl(int *value, int min, int max); + +/** + * Create a new spin control widget tracking a float value. + * + * @param value Pointer to the variable containing the value + * displayed in the widget. + * @param min Minimum value that may be set. + * @param max Maximum value that may be set. + * @return Pointer to the new spin control widget. + */ + txt_spincontrol_t *TXT_NewFloatSpinControl(float *value, float min, float max); #endif /* #ifndef TXT_SPINCONTROL_H */ diff --git a/textscreen/txt_strut.h b/textscreen/txt_strut.h index 7d9e7650..3dc8db9a 100644 --- a/textscreen/txt_strut.h +++ b/textscreen/txt_strut.h @@ -22,15 +22,24 @@ #ifndef TXT_STRUT_H #define TXT_STRUT_H +/** + * @file txt_strut.h + * + * Strut widget. + */ + +/** + * Strut widget. + * + * A strut is a widget that takes up a fixed amount of space. It can + * be visualised as a transparent box. Struts are used to provide + * spacing between widgets. + */ + typedef struct txt_strut_s txt_strut_t; #include "txt_widget.h" -// -// A strut is used to force a table to a minimum width/height. It is not -// visible but it takes up space. -// - struct txt_strut_s { txt_widget_t widget; @@ -38,6 +47,13 @@ struct txt_strut_s int height; }; +/** + * Create a new strut. + * + * @param width Width of the strut, in characters. + * @param height Height of the strut, in characters. + */ + txt_strut_t *TXT_NewStrut(int width, int height); #endif /* #ifndef TXT_STRUT_H */ diff --git a/textscreen/txt_table.h b/textscreen/txt_table.h index dee6f4bb..0e7fbe94 100644 --- a/textscreen/txt_table.h +++ b/textscreen/txt_table.h @@ -22,9 +22,29 @@ #ifndef TXT_TABLE_H #define TXT_TABLE_H +/** + * @file txt_table.h + * + * Table widget. + */ + +/** + * Table widget. + * + * A table is a widget that contains other widgets. It may have + * multiple columns, in which case the child widgets are laid out + * in a grid. Columns automatically grow as necessary, although + * minimum column widths can be set using @ref TXT_SetColumnWidths. + * + * To create a new table, use @ref TXT_NewTable. It is also + * possible to use @ref TXT_NewHorizBox to create a table, specifying + * widgets to place inside a horizontal list. A vertical list is + * possible simply by creating a table containing a single column. + */ + typedef struct txt_table_s txt_table_t; -#include "txt_widget.h" +#include "txt_widget.h" struct txt_table_s { @@ -48,14 +68,114 @@ struct txt_table_s extern txt_widget_class_t txt_table_class; +void TXT_InitTable(txt_table_t *table, int columns); + +/** + * Create a new table. + * + * @param columns The number of columns in the new table. + * @return Pointer to the new table structure. + */ + txt_table_t *TXT_NewTable(int columns); + +/** + * Create a table containing the specified widgets packed horizontally, + * from left to right. + * + * The arguments to this function are variable. Each argument must + * be a pointer to a widget, and the list is terminated with a + * NULL. + * + * @return Pointer to the new table structure. + */ + txt_table_t *TXT_NewHorizBox(TXT_UNCAST_ARG(first_widget), ...); -void TXT_InitTable(txt_table_t *table, int columns); + +/** + * Get the currently selected widget within a table. + * + * This function will recurse through subtables if necessary. + * + * @param table The table. + * @return Pointer to the widget that is currently selected. + */ + txt_widget_t *TXT_GetSelectedWidget(TXT_UNCAST_ARG(table)); + +/** + * Add a widget to a table. + * + * Widgets are added to tables horizontally, from left to right. + * For example, for a table with three columns, the first call + * to this function will add a widget to the first column, the second + * call to the second column, the third call to the third column, + * and the fourth will return to the first column, starting a new + * row. + * + * For adding many widgets, it may be easier to use + * @ref TXT_AddWidgets. + * + * @param table The table. + * @param widget The widget to add. + */ + void TXT_AddWidget(TXT_UNCAST_ARG(table), TXT_UNCAST_ARG(widget)); + +/** + * Add multiple widgets to a table. + * + * Widgets are added as described in the documentation for the + * @ref TXT_AddWidget function. This function adds multiple + * widgets. The number of arguments is variable, and the argument + * list must be terminated by a NULL pointer. + * + * @param table The table. + */ + void TXT_AddWidgets(TXT_UNCAST_ARG(table), ...); + +/** + * Select the given widget that is contained within the specified + * table. + * + * This function will recursively search through subtables if + * necessary. + * + * @param table The table. + * @param widget The widget to select. + * @return Non-zero (true) if it has been selected, + * or zero (false) if it was not found within + * this table. + */ + int TXT_SelectWidget(TXT_UNCAST_ARG(table), TXT_UNCAST_ARG(widget)); + +/** + * Set the widths of the columns of the table. + * + * The arguments to this function are variable, and correspond + * to the number of columns in the table. For example, if a table + * has five columns, the width of each of the five columns must be + * specified. + * + * The width values are in number of characters. + * + * Note that this function only sets the minimum widths for columns; + * if the columns contain widgets that are wider than the widths + * specified, they will be larger. + * + * @param table The table. + */ + void TXT_SetColumnWidths(TXT_UNCAST_ARG(table), ...); + +/** + * Remove all widgets from a table. + * + * @param table The table. + */ + void TXT_ClearTable(TXT_UNCAST_ARG(table)); #endif /* #ifndef TXT_TABLE_T */ diff --git a/textscreen/txt_widget.h b/textscreen/txt_widget.h index 0e80f3c1..63cc5f35 100644 --- a/textscreen/txt_widget.h +++ b/textscreen/txt_widget.h @@ -19,15 +19,27 @@ // 02111-1307, USA. // -// Base GUI "widget" class that all widgets inherit from. - #ifndef TXT_WIDGET_H #define TXT_WIDGET_H +/** + * @file txt_widget.h + * + * Base "widget" GUI component class. + */ + +#ifndef DOXYGEN + #define TXT_UNCAST_ARG_NAME(name) uncast_ ## name #define TXT_UNCAST_ARG(name) void * TXT_UNCAST_ARG_NAME(name) #define TXT_CAST_ARG(type, name) type *name = (type *) uncast_ ## name +#else + +#define TXT_UNCAST_ARG(name) txt_widget_t *name + +#endif + typedef enum { TXT_VERT_TOP, @@ -42,8 +54,20 @@ typedef enum TXT_HORIZ_RIGHT, } txt_horiz_align_t; -typedef struct txt_widget_class_s txt_widget_class_t; +/** + * A GUI widget. + * + * A widget is an individual component of a GUI. Various different widget + * types exist. + * + * Widgets may emit signals. The types of signal emitted by a widget + * depend on the type of the widget. It is possible to be notified + * when a signal occurs using the @ref TXT_SignalConnect function. + */ + typedef struct txt_widget_s txt_widget_t; + +typedef struct txt_widget_class_s txt_widget_class_t; typedef struct txt_callback_table_s txt_callback_table_t; typedef void (*TxtWidgetSizeCalc)(TXT_UNCAST_ARG(widget)); @@ -82,15 +106,34 @@ struct txt_widget_s void TXT_InitWidget(TXT_UNCAST_ARG(widget), txt_widget_class_t *widget_class); void TXT_CalcWidgetSize(TXT_UNCAST_ARG(widget)); void TXT_DrawWidget(TXT_UNCAST_ARG(widget), int selected); -void TXT_SignalConnect(TXT_UNCAST_ARG(widget), char *signal_name, - TxtWidgetSignalFunc func, void *user_data); void TXT_EmitSignal(TXT_UNCAST_ARG(widget), char *signal_name); int TXT_WidgetKeyPress(TXT_UNCAST_ARG(widget), int key); void TXT_WidgetMousePress(TXT_UNCAST_ARG(widget), int x, int y, int b); void TXT_DestroyWidget(TXT_UNCAST_ARG(widget)); -void TXT_SetWidgetAlign(TXT_UNCAST_ARG(widget), txt_horiz_align_t horiz_align); void TXT_LayoutWidget(TXT_UNCAST_ARG(widget)); +/** + * Set a callback function to be invoked when a signal occurs. + * + * @param widget The widget to watch. + * @param signal_name The signal to watch. + * @param func The callback function to invoke. + * @param user_data User-specified pointer to pass to the callback function. + */ + +void TXT_SignalConnect(TXT_UNCAST_ARG(widget), char *signal_name, + TxtWidgetSignalFunc func, void *user_data); + +/** + * Set the policy for how a widget should be aligned within a table. + * By default, widgets are aligned to the left of the column. + * + * @param widget The widget. + * @param horiz_align The alignment to use. + */ + +void TXT_SetWidgetAlign(TXT_UNCAST_ARG(widget), txt_horiz_align_t horiz_align); + #endif /* #ifndef TXT_WIDGET_H */ diff --git a/textscreen/txt_window.h b/textscreen/txt_window.h index 3659ed29..e183cf6d 100644 --- a/textscreen/txt_window.h +++ b/textscreen/txt_window.h @@ -22,6 +22,31 @@ #ifndef TXT_WINDOW_H #define TXT_WINDOW_H +/** + * @file txt_window.h + * + * Windows. + */ + +/** + * A window. + * + * A window contains widgets, and may also be treated as a table + * (@ref txt_table_t) containing a single column. + * + * Windows can be created using @ref TXT_NewWindow and closed using + * @ref TXT_CloseWindow. When a window is closed, it emits the + * "closed" signal. + * + * In addition to the widgets within a window, windows also have + * a "tray" area at their bottom containing window action widgets. + * These widgets allow keyboard shortcuts to trigger common actions. + * Each window has three slots for keyboard shortcuts. By default, + * the left slot contains an action to close the window when the + * escape button is pressed, while the right slot contains an + * action to activate the currently-selected widget. + */ + typedef struct txt_window_s txt_window_t; #include "txt_widget.h" @@ -68,18 +93,86 @@ struct txt_window_s unsigned int window_w, window_h; }; +/** + * Open a new window. + * + * @param title Title to display in the titlebar of the new window. + * @return Pointer to a new @ref txt_window_t structure + * representing the new window. + */ + txt_window_t *TXT_NewWindow(char *title); + +/** + * Close a window. + * + * @param window Tine window to close. + */ + void TXT_CloseWindow(txt_window_t *window); -void TXT_SetWindowPosition(txt_window_t *window, + +/** + * Set the position of a window on the screen. + * + * The window is specified as coordinates relative to a predefined + * position on the screen (eg. center of the screen, top left of the + * screen, etc). + * + * @param window The window. + * @param horiz_align Horizontal position on the screen to which the + * coordinates are relative (left side, right side + * or center). + * @param vert_align Vertical position on the screen to which the + * coordinates are relative (top, bottom or center). + * @param x X coordinate (horizonal axis) for window position. + * @param y Y coordinate (vertical axis) for window position. + */ + +void TXT_SetWindowPosition(txt_window_t *window, txt_horiz_align_t horiz_align, txt_vert_align_t vert_align, int x, int y); + +/** + * Set a window action for a given window. + * + * Each window can have up to three window actions, which provide + * keyboard shortcuts that can be used within a given window. + * + * @param window The window. + * @param position The window action slot to set (left, center or right). + * @param action The window action widget. If this is NULL, any + * current window action in the given slot is removed. + */ + void TXT_SetWindowAction(txt_window_t *window, txt_horiz_align_t position, txt_window_action_t *action); -void TXT_SetKeyListener(txt_window_t *window, - TxtWindowKeyPress key_listener, + +/** + * Set a callback function to be invoked whenever a key is pressed within + * a window. + * + * @param window The window. + * @param key_listener Callback function. + * @param user_data User-specified pointer to pass to the callback + * function. + */ + +void TXT_SetKeyListener(txt_window_t *window, + TxtWindowKeyPress key_listener, void *user_data); -void TXT_SetMouseListener(txt_window_t *window, + +/** + * Set a callback function to be invoked whenever a mouse button is pressed + * within a window. + * + * @param window The window. + * @param mouse_listener Callback function. + * @param user_data User-specified pointer to pass to the callback + * function. + */ + +void TXT_SetMouseListener(txt_window_t *window, TxtWindowMousePress mouse_listener, void *user_data); diff --git a/textscreen/txt_window_action.h b/textscreen/txt_window_action.h index 56f5a1b6..ab87f72c 100644 --- a/textscreen/txt_window_action.h +++ b/textscreen/txt_window_action.h @@ -22,6 +22,22 @@ #ifndef TXT_WINDOW_ACTION_H #define TXT_WINDOW_ACTION_H +/** + * @file txt_window_action.h + * + * Window action widget. + */ + +/** + * Window action widget. + * + * A window action is attached to a window and corresponds to a + * keyboard shortcut that is active within that window. When the + * key is pressed, the action is triggered. + * + * When a window action is triggered, the "pressed" signal is emitted. + */ + typedef struct txt_window_action_s txt_window_action_t; #include "txt_widget.h" @@ -34,17 +50,45 @@ struct txt_window_action_s int key; }; +/** + * Create a new window action. + * + * @param key The keyboard key that triggers this action. + * @param label Label to display for this action in the tray + * at the bottom of the window. + * @return Pointer to the new window action widget. + */ + txt_window_action_t *TXT_NewWindowAction(int key, char *label); -// Creates an "escape" button that closes the window +/** + * Create a new window action that closes the window when the + * escape key is pressed. The label "Close" is used. + * + * @param window The window to close. + * @return Pointer to the new window action widget. + */ txt_window_action_t *TXT_NewWindowEscapeAction(txt_window_t *window); -// Same as above, but the button is named "abort" +/** + * Create a new window action that closes the window when the + * escape key is pressed. The label "Abort" is used. + * + * @param window The window to close. + * @return Pointer to the new window action widget. + */ txt_window_action_t *TXT_NewWindowAbortAction(txt_window_t *window); -// Accept button that does nothing +/** + * Create a new "select" window action. This does not really do + * anything, but reminds the user that "enter" can be pressed to + * activate the currently-selected widget. + * + * @param window The window. + * @return Pointer to the new window action widget. + */ txt_window_action_t *TXT_NewWindowSelectAction(txt_window_t *window); |