From 8416a4012ecb985d150fad566659cf59ee1dc3aa Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Sat, 13 Sep 2008 15:55:32 +0000 Subject: Doxygen documentation - WP12 and WP13 - first step. Converted the descriptive chapters of the html docs to doxygen format and modified index.dox accordingly. This checkin includes only trivial reformatting, no major rewriting. Added a chapter "Migrating Code from FLTK 1.1 to 1.3". All links on the main page are working now. Todo: - Check doxygen error messages, rewrite pages (html tags, contents). - Fill the new "Migrating..." chapter. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6224 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/enumerations.dox | 304 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 304 insertions(+) create mode 100644 documentation/enumerations.dox (limited to 'documentation/enumerations.dox') diff --git a/documentation/enumerations.dox b/documentation/enumerations.dox new file mode 100644 index 000000000..10ed628f5 --- /dev/null +++ b/documentation/enumerations.dox @@ -0,0 +1,304 @@ +/** + + \page enumerations C - FLTK Enumerations + +

This appendix lists the enumerations provided in the +<FL/Enumerations.H> header file, organized by +section. Constants whose value is zero are marked with "(0)", +this is often useful to know when programming. + +

Version Numbers

+ The FLTK version number is stored in a number of compile-time +constants: + +

Events

+ Events are identified by an Fl_Event enumeration value. The +following events are currently defined: + +

Callback "When" Conditions

+ The following constants determine when a callback is performed: + +

Fl::event_button() Values

+ +

The following constants define the button numbers for FL_PUSH and +FL_RELEASE events: + +

+ +

Fl::event_key() Values

+ The following constants define the non-ASCII keys on the keyboard for +FL_KEYBOARD and FL_SHORTCUT events: + +

Fl::event_state() Values

+ The following constants define bits in the Fl::event_state() + value: + + +

Alignment Values

+ The following constants define bits that can be used with +Fl_Widget::align() to control the positioning of the +label: + +

Fonts

+ The following constants define the standard FLTK fonts: + + +

Colors

+ +

The Fl_Color enumeration type holds a FLTK color value. +Colors are either 8-bit indexes into a virtual colormap or 24-bit RGB +color values. Color indices occupy the lower 8 bits of the value, while +RGB colors occupy the upper 24 bits, for a byte organization of RGBI. + +

Color Constants

+ +

Constants are defined for the user-defined foreground and background +colors, as well as specific colors and the start of the grayscale ramp +and color cube in the virtual colormap. Inline functions are provided to +retrieve specific grayscale, color cube, or RGB color values. + +

The following color constants can be used to access the user-defined +colors: + +

+ +

The following color constants can be used to access the colors from the +FLTK standard color cube: + +

+ +

The inline methods for getting a grayscale, color cube, or +RGB color value are described in Appendix B - Function +Reference. + +

Cursors

+ +

The following constants define the mouse cursors that are available in +FLTK. The double-headed arrows are bitmaps +provided by FLTK on X, the others are provided by system-defined +cursors.

+ + + +

FD "When" Conditions

+ + + +

Damage Masks

+ The following damage mask bits are used by the standard FLTK widgets: + + +*/ -- cgit v1.2.3