From 1fc269b0d4c79b256cc57740d318f95dded8c340 Mon Sep 17 00:00:00 2001 From: Matthias Melcher Date: Sat, 21 Jan 2023 17:14:41 +0100 Subject: Move global FLTK options into new app fltk-admin (#560) --- documentation/src/fltk-options.dox | 85 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 documentation/src/fltk-options.dox (limited to 'documentation/src/fltk-options.dox') diff --git a/documentation/src/fltk-options.dox b/documentation/src/fltk-options.dox new file mode 100644 index 000000000..c9603fc6d --- /dev/null +++ b/documentation/src/fltk-options.dox @@ -0,0 +1,85 @@ +/** + + \page fltk-options FLTK Runtime Options + +In this chapter, we will cover how to access and alter settings for +applications created using FLTK, both as an administrator and as +a regular user. + +Subchapters: + +\li \ref fltk-options_basics +\li \ref fltk-options_access +\li \ref fltk-options_app +\li \ref fltk-options_options + +\section fltk-options_basics Runtime Options + +FLTK keeps track of various aspects of the user interface in a system-wide +database. Users have the ability to set their own preferences and override +default or system settings. For instance, FLTK will display a dotted +rectangle around the widget with current focus. This might not be desirable +for users who do not use keyboard navigation and do not need the rectangle. +This can be turned off by setting the OPTION_VISIBLE_FOCUS option to 'off' +for that user, which will disable the focus rectangle in all FLTK-based +applications. + +\section fltk-options_access Obtaining Current Settings + +Options are kept in preference files using the signature +`Fl_Preferences::CORE_SYSTEM, "fltk.org", "fltk"` for system-wide settings +and `Fl_Preferences::CORE_USER, "fltk.org", "fltk"` for individual users. +They can be accessed by using the function `bool Fl::option(Fl_Option opt)`. +If an application needs to temporarily override user or system settings, +it can use the function `void option(Fl_Option opt, bool val)`. + +To make changes to options permanently, FLTK provides an administrative +tool called fltk-options. + +\section fltk-options_app Administrative Tool + +`fltk-options` is a hybrid app that is part of FLTK and can be installed on +the target system. It includes an up-to-date man page. + +When fltk-options is called without any command-line arguments, it opens in +interactive mode and provides a user interface to view and alter all +system and current user options. + +Starting the tool from a shell, the command-line options `-S` and `-U` can be +used to display or change system or user options. On MS-Windows, `fltk-options` +is also available as `fltk-options-cmd.exe`. + +\section fltk-options_options List of Options + +Calling `fltk-options --help` gives a list of all available commands, and +options and their values. `fltk-options --help OPTION` prints more detailed +information for OPTION if available. In interactive mode, tooltips provide +this additional information. + +A full list of options can be found in the maunal at \ref Fl_Option . + + +\htmlonly +
+ + + + + + +
+ + [Prev] + Programming with FLUID + + + [Index] + + + Advanced FLTK + [Next] + +
+\endhtmlonly + +*/ -- cgit v1.2.3