From 09daf20b81cdae78772f07c0af22a571d7cc73eb Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Thu, 29 Nov 2001 19:24:00 +0000 Subject: Documentation updates galore (up to chapter 7, still need to do chapter 8 and 9, tweek the appendices, and recapture the screenshots...) git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@1786 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/enumerations.html | 68 ++++++++++++++++++++--------------------- 1 file changed, 34 insertions(+), 34 deletions(-) (limited to 'documentation/enumerations.html') diff --git a/documentation/enumerations.html b/documentation/enumerations.html index 736090295..e9e67e002 100644 --- a/documentation/enumerations.html +++ b/documentation/enumerations.html @@ -1,22 +1,22 @@

C - FLTK Enumerations

This appendix lists the enumerations provided in the -<FL/Enumerations.H> header file, organized by section. +<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: + The FLTK version number is stored in a number of compile-time +constants:

FL_MAJOR_VERSION - The major release number, currently 1.
FL_MINOR_VERSION - The minor release number, currently 1.
FL_PATCH_VERSION - The patch release number, currently 0.
FL_VERSION - A combined floating-point version number for +
FL_VERSION - A combined floating-point version number for the major, minor, and patch release numbers, currently 1.0100.

Events

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

FL_NO_EVENT - No event (or an event fltk does not understand) occurred (0).
FL_RELEASE - A mouse button was released.
FL_ENTER - The mouse pointer entered a widget.
FL_LEAVE - The mouse pointer left a widget.
FL_DRAG - The mouse pointer was moved with a button +
FL_DRAG - The mouse pointer was moved with a button pressed.
FL_FOCUS - A widget should receive keyboard focus.
FL_UNFOCUS - A widget loses keyboard focus.
FL_KEYBOARD - A key was pressed.
FL_CLOSE - A window was closed.
FL_MOVE - The mouse pointer was moved with no buttons +
FL_MOVE - The mouse pointer was moved with no buttons pressed.
FL_SHORTCUT - The user pressed a shortcut key.
FL_DEACTIVATE - The widget has been deactivated.
FL_ACTIVATE - The widget has been activated.
FL_HIDE - The widget has been hidden.
FL_SHOW - The widget has been shown.
FL_PASTE - The widget should paste the contents of the +
FL_PASTE - The widget should paste the contents of the clipboard.
FL_SELECTIONCLEAR - The widget should clear any selections +
FL_SELECTIONCLEAR - The widget should clear any selections made for the clipboard.

Callback "When" Conditions

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

FL_WHEN_NEVER - Never call the callback (0).
FL_WHEN_CHANGED - Do the callback only when the widget +
FL_WHEN_CHANGED - Do the callback only when the widget value changes.
FL_WHEN_NOT_CHANGED - Do the callback whenever the user +
FL_WHEN_NOT_CHANGED - Do the callback whenever the user interacts with the widget.
FL_WHEN_RELEASE - Do the callback when the button or key +
FL_WHEN_RELEASE - Do the callback when the button or key is released and the value changes.
FL_WHEN_ENTER_KEY - Do the callback when the user presses +
FL_WHEN_ENTER_KEY - Do the callback when the user presses the ENTER key and the value changes.
FL_WHEN_RELEASE_ALWAYS - Do the callback when the button +
FL_WHEN_RELEASE_ALWAYS - Do the callback when the button or key is released, even if the value doesn't change.
FL_WHEN_ENTER_KEY_ALWAYS - Do the callback when the user +
FL_WHEN_ENTER_KEY_ALWAYS - Do the callback when the user presses the ENTER key, even if the value doesn't change.

Fl::event_button() Values

@@ -72,7 +72,7 @@ is released and the value changes.

Fl::event_key() Values

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

FL_Button - A mouse button; use Fl_Button + n for mouse button n.

FL_SHORTCUT

Fl::event_state() Values

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

FL_SHIFT - One of the shift keys is down.
FL_CAPS_LOCK - The caps lock is on.

FL_SHORTCUT

Alignment Values

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

FL_ALIGN_CENTER - The label is centered (0).
FL_ALIGN_TOP - The label is top-aligned.

Fonts

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

FL_HELVETICA - Helvetica (or Arial) normal (0).
FL_HELVETICA_BOLD - Helvetica (or Arial) bold.
FL_HELVETICA_ITALIC - Helvetica (or Arial) oblique.
FL_HELVETICA_BOLD_ITALIC - Helvetica (or Arial) +
FL_HELVETICA_BOLD_ITALIC - Helvetica (or Arial) bold-oblique.
FL_COURIER - Courier normal.
FL_COURIER_BOLD - Courier bold.
FL_SYMBOL - Standard symbol font.
FL_SCREEN - Default monospaced screen font.
FL_SCREEN_BOLD - Default monospaced bold screen font.
FL_ZAPF_DINGBATS - Zapf-dingbats font. +
FL_ZAPF_DINGBATS - Zapf-dingbats font.

Colors

- The following color constants can be used to access the colors in the -FLTK standard color palette: + The following color constants can be used to access the colors in the +FLTK standard color palette:

FL_BLACK - the default label color (0)
FL_RED

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 +

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.

FL_CURSOR_DEFAULT - the default cursor, usually an arrow (0)

FD "When" Conditions

FL_READ - Call the callback when there is data to be +
FL_READ - Call the callback when there is data to be read.
FL_WRITE - Call the callback when data can be written +
FL_WRITE - Call the callback when data can be written without blocking.
FL_EXCEPT - Call the callback if an exception occurs on +
FL_EXCEPT - Call the callback if an exception occurs on the file.

Damage Masks

FL_DAMAGE_CHILD - A child needs to be redrawn.
FL_DAMAGE_EXPOSE - The window was exposed.
FL_DAMAGE_SCROLL - The Fl_Scroll widget was +
FL_DAMAGE_SCROLL - The Fl_Scroll widget was scrolled.
FL_DAMAGE_OVERLAY - The overlay planes need to be redrawn.
FL_DAMAGE_ALL - Everything needs to be redrawn.