// // "$Id$" // // Enumerations for the Fast Light Tool Kit (FLTK). // // Copyright 1998-2008 by Bill Spitzak and others. // // This library is free software; you can redistribute it and/or // modify it under the terms of the GNU Library General Public // License as published by the Free Software Foundation; either // version 2 of the License, or (at your option) any later version. // // This library is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // Library General Public License for more details. // // You should have received a copy of the GNU Library General Public // License along with this library; if not, write to the Free Software // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 // USA. // // Please report all bugs and problems on the following page: // // http://www.fltk.org/str.php // /** \file * This file contains type definitions and general enumerations. */ #ifndef Fl_Enumerations_H #define Fl_Enumerations_H # include "Fl_Export.H" /** \name Version Numbers FLTK defines some constants to help the programmer to find out, for which FLTK version a program is compiled. The following constants are defined: */ /*@{*/ /** * The major release version of this FLTK library. \sa FL_VERSION */ #define FL_MAJOR_VERSION 1 /** * The minor release version for this library. * * FLTK remains mostly source-code compatible between minor version changes. */ #define FL_MINOR_VERSION 3 /** * The patch version for this library. * * FLTK remains binary compatible between patches. */ #define FL_PATCH_VERSION 0 /** * The FLTK version number as a \em double. * * This is changed slightly from the beta versions * because the old "const double" definition would not allow for conditional * compilation... * * FL_VERSION is a double that describes the major and minor version numbers. * Version 1.1 is actually stored as 1.01 to allow for more than 9 minor * releases. * * The FL_MAJOR_VERSION, FL_MINOR_VERSION, and FL_PATCH_VERSION constants * give the integral values for the major, minor, and patch releases * respectively. */ #define FL_VERSION ((double)FL_MAJOR_VERSION + \ (double)FL_MINOR_VERSION * 0.01 + \ (double)FL_PATCH_VERSION * 0.0001) /*@}*/ // group: Version Numbers /** \name Miscellaneous */ /*@{*/ // group: Miscellaneous /** unsigned char */ typedef unsigned char uchar; /** unsigned long */ typedef unsigned long ulong; /** Flexible length utf8 Unicode text * * \todo FIXME: temporary (?) typedef to mark UTF8 and Unicode conversions */ typedef char *Fl_String; /** Flexible length utf8 Unicode read-only string * \sa Fl_String */ typedef const char *Fl_CString; /** 24-bit Unicode character + 8-bit indicator for keyboard flags */ typedef unsigned int Fl_Char; /*@}*/ // group: Miscellaneous /** * Every time a user moves the mouse pointer, clicks a button, * or presses a key, an event is generated and sent to your * application. Events can also come from other programs like the * window manager. * * Events are identified by the integer argument passed to the * Fl_Widget::handle() virtual method. Other information about the * most recent event is stored in static locations and acquired by * calling the Fl::event_*() methods. This static information remains * valid until the next event is read from the window system, so it * is ok to look at it outside of the handle() method. * * \sa Fl::event_text(), Fl::event_key(), class Fl:: */ enum Fl_Event { // events /** No event. */ FL_NO_EVENT = 0, /** A mouse button has gone down with the mouse pointing at this * widget. You can find out what button by calling Fl::event_button(). * You find out the mouse position by calling Fl::event_x() and * Fl::event_y(). * * A widget indicates that it "wants" the mouse click by returning non-zero * from its Fl_Widget::handle() method. It will then become the * Fl::pushed() widget and will get FL_DRAG and the matching FL_RELEASE events. * If Fl_Widget::handle() returns zero then FLTK will try sending the FL_PUSH * to another widget. */ FL_PUSH = 1, /** A mouse button has been released. You can find out what button by * calling Fl::event_button(). * * In order to receive the FL_RELEASE event, the widget must return * non-zero when handling FL_PUSH. */ FL_RELEASE = 2, /** The mouse has been moved to point at this widget. This can * be used for highlighting feedback. If a widget wants to * highlight or otherwise track the mouse, it indicates this by * returning non-zero from its handle() method. It then * becomes the Fl::belowmouse() widget and will receive * FL_MOVE and FL_LEAVE events. */ FL_ENTER = 3, /** The mouse has moved out of the widget. * In order to receive the FL_LEAVE event, the widget must * return non-zero when handling FL_ENTER. */ FL_LEAVE = 4, /** The mouse has moved with a button held down. The current button state * is in Fl::event_state(). The mouse position is in Fl::event_x() and * Fl::event_y(). * * In order to receive FL_DRAG events, the widget must return non-zero * when handling FL_PUSH. */ FL_DRAG = 5, /** This indicates an attempt to give a widget the keyboard focus. * * If a widget wants the focus, it should change itself to display the * fact that it has the focus, and return non-zero from its handle() method. * It then becomes the Fl::focus() widget and gets FL_KEYDOWN, FL_KEYUP, * and FL_UNFOCUS events. * * The focus will change either because the window manager changed which * window gets the focus, or because the user tried to navigate using tab, * arrows, or other keys. You can check Fl::event_key() to figure out why * it moved. For navigation it will be the key pressed and interaction * with the window manager it will be zero. */ FL_FOCUS = 6, /** This event is sent to the previous Fl::focus() widget when another * widget gets the focus or the window loses focus. */ FL_UNFOCUS = 7, /** A key was pressed or released. The key can be found in Fl::event_key(). * The text that the key should insert can be found with Fl::event_text() * and its length is in Fl::event_length(). If you use the key handle() * should return 1. If you return zero then FLTK assumes you ignored the * key and will then attempt to send it to a parent widget. If none of * them want it, it will change the event into a FL_SHORTCUT event. * * To receive FL_KEYBOARD events you must also respond to the FL_FOCUS * and FL_UNFOCUS events. * * If you are writing a text-editing widget you may also want to call * the Fl::compose() function to translate individual keystrokes into * foreign characters. * * FL_KEYUP events are sent to the widget that currently has focus. This * is not necessarily the same widget that received the corresponding * FL_KEYDOWN event because focus may have changed between events. */ FL_KEYDOWN = 8, /** Equvalent to FL_KEYDOWN. * \see FL_KEYDOWN */ FL_KEYBOARD = 8, /** Key release event. * \see FL_KEYDOWN */ FL_KEYUP = 9, /** The user clicked the close button of a window. * This event is used internally only to trigger the callback of * Fl_Window derived classed. The default callback closes the * window calling Fl_Window::hide(). */ FL_CLOSE = 10, /** The mouse has moved without any mouse buttons held down. * This event is sent to the Fl::belowmouse() widget. * * In order to receive FL_MOVE events, the widget must return * non-zero when handling FL_ENTER. */ FL_MOVE = 11, /** If the Fl::focus() widget is zero or ignores an FL_KEYBOARD * event then FLTK tries sending this event to every widget it * can, until one of them returns non-zero. FL_SHORTCUT is first * sent to the Fl::belowmouse() widget, then its parents and siblings, * and eventually to every widget in the window, trying to find an * object that returns non-zero. FLTK tries really hard to not to ignore * any keystrokes! * * You can also make "global" shortcuts by using Fl::add_handler(). A * global shortcut will work no matter what windows are displayed or * which one has the focus. */ FL_SHORTCUT = 12, /** This widget is no longer active, due to Fl_Widget::deactivate() * being called on it or one of its parents. Fl_Widget::active() may * still be true after this, the widget is only active if Fl_Widget::active() * is true on it and all its parents (use Fl_Widget::active_r() to check this). */ FL_DEACTIVATE = 13, /** This widget is now active, due to Fl_Widget::activate() being * called on it or one of its parents. */ FL_ACTIVATE = 14, /** This widget is no longer visible, due to Fl_Widget::hide() being * called on it or one of its parents, or due to a parent window being * minimized. Fl_Widget::visible() may still be true after this, but the * widget is visible only if visible() is true for it and all its * parents (use Fl_Widget::visible_r() to check this). */ FL_HIDE = 15, /** This widget is visible again, due to Fl_Widget::show() being called on * it or one of its parents, or due to a parent window being restored. * Child Fl_Windows respond to this by actually creating the window if not * done already, so if you subclass a window, be sure to pass FL_SHOW * to the base class Fl_Widget::handle() method! */ FL_SHOW = 16, /** You should get this event some time after you call Fl::paste(). * The contents of Fl::event_text() is the text to insert and the number * of characters is in Fl::event_length(). */ FL_PASTE = 17, /** The Fl::selection_owner() will get this event before the selection is * moved to another widget. This indicates that some other widget or program * has claimed the selection. Motif programs used this to clear the selection * indication. Most modern programs ignore this. */ FL_SELECTIONCLEAR = 18, /** The user has moved the mouse wheel. The Fl::event_dx() and Fl::event_dy() * methods can be used to find the amount to scroll horizontally and vertically. */ FL_MOUSEWHEEL = 19, /** The mouse has been moved to point at this widget. A widget that is * interested in receiving drag'n'drop data must return 1 to receive * FL_DND_DRAG, FL_DND_LEAVE and FL_DND_RELEASE events. */ FL_DND_ENTER = 20, /** The mouse has been moved inside a widget while dragging data. A * widget that is interested in receiving drag'n'drop data should * indicate the possible drop position. */ FL_DND_DRAG = 21, /** The mouse has moved out of the widget. */ FL_DND_LEAVE = 22, /** The user has released the mouse button dropping data into the widget. * If the widget returns 1, it will receive the data in the immediately * following FL_PASTE event. */ FL_DND_RELEASE = 23 }; /** \name When Conditions */ /*@{*/ /** These constants determine when a callback is performed. * * \sa Fl_Widget::when(); * \todo doxygen comments for values are incomplete and maybe wrong or unclear */ enum Fl_When { // Fl_Widget::when(): FL_WHEN_NEVER = 0, ///< Never call the callback FL_WHEN_CHANGED = 1, ///< Do the callback only when the widget value changes FL_WHEN_NOT_CHANGED = 2, ///< Do the callback whenever the user interacts with the widget FL_WHEN_RELEASE = 4, ///< Do the callback when the button or key is released and the value changes FL_WHEN_RELEASE_ALWAYS= 6, ///< Do the callback when the button or key is released, even if the value doesn't change FL_WHEN_ENTER_KEY = 8, ///< Do the callback when the user presses the ENTER key and the value changes FL_WHEN_ENTER_KEY_ALWAYS=10, ///< Do the callback when the user presses the ENTER key, even if the value doesn't change FL_WHEN_ENTER_KEY_CHANGED=11 ///< ? }; /*@}*/ // group: When Conditions /** \name Mouse and Keyboard Events This and the following constants define the non-ASCII keys on the keyboard for FL_KEYBOARD and FL_SHORTCUT events. \todo FL_Button and FL_key... constants could be structured better (use an enum or some doxygen grouping ?) \sa Fl::event_key() and Fl::get_key(n) (use ascii letters for all other keys): */ /*@{*/ #define FL_Button 0xfee8 ///< A mouse button; use Fl_Button + n for mouse button n. #define FL_BackSpace 0xff08 ///< The backspace key. #define FL_Tab 0xff09 ///< The tab key. #define FL_Enter 0xff0d ///< The enter key. #define FL_Pause 0xff13 ///< The pause key. #define FL_Scroll_Lock 0xff14 ///< The scroll lock key. #define FL_Escape 0xff1b ///< The escape key. #define FL_Home 0xff50 ///< The home key. #define FL_Left 0xff51 ///< The left arrow key. #define FL_Up 0xff52 ///< The up arrow key. #define FL_Right 0xff53 ///< The right arrow key. #define FL_Down 0xff54 ///< The down arrow key. #define FL_Page_Up 0xff55 ///< The page-up key. #define FL_Page_Down 0xff56 ///< The page-down key. #define FL_End 0xff57 ///< The end key. #define FL_Print 0xff61 ///< The print (or print-screen) key. #define FL_Insert 0xff63 ///< The insert key. #define FL_Menu 0xff67 ///< The menu key. #define FL_Help 0xff68 ///< The 'help' key on Mac keyboards #define FL_Num_Lock 0xff7f ///< The num lock key. #define FL_KP 0xff80 ///< One of the keypad numbers; use FL_KP + n for number n. #define FL_KP_Enter 0xff8d ///< The enter key on the keypad, same as Fl_KP+'\r'. #define FL_KP_Last 0xffbd ///< The last keypad key; use to range-check keypad. #define FL_F 0xffbd ///< One of the function keys; use FL_F + n for function key n. #define FL_F_Last 0xffe0 ///< The last function key; use to range-check function keys. #define FL_Shift_L 0xffe1 ///< The lefthand shift key. #define FL_Shift_R 0xffe2 ///< The righthand shift key. #define FL_Control_L 0xffe3 ///< The lefthand control key. #define FL_Control_R 0xffe4 ///< The righthand control key. #define FL_Caps_Lock 0xffe5 ///< The caps lock key. #define FL_Meta_L 0xffe7 ///< The left meta/Windows key. #define FL_Meta_R 0xffe8 ///< The right meta/Windows key. #define FL_Alt_L 0xffe9 ///< The left alt key. #define FL_Alt_R 0xffea ///< The right alt key. #define FL_Delete 0xffff ///< The delete key. /*@}*/ // group: Mouse and Keyboard Events /** \name Mouse Buttons These constants define the button numbers for FL_PUSH and FL_RELEASE events. \sa Fl::event_button() */ /*@{*/ #define FL_LEFT_MOUSE 1 ///< The left mouse button #define FL_MIDDLE_MOUSE 2 ///< The middle mouse button #define FL_RIGHT_MOUSE 3 ///< The right mouse button /*@}*/ // group: Mouse Buttons /** \name Event States The following constants define bits in the Fl::event_state() value. */ /*@{*/ // group: Event States #define FL_SHIFT 0x00010000 ///< One of the shift keys is down #define FL_CAPS_LOCK 0x00020000 ///< The caps lock is on #define FL_CTRL 0x00040000 ///< One of the ctrl keys is down #define FL_ALT 0x00080000 ///< One of the alt keys is down #define FL_NUM_LOCK 0x00100000 ///< The num lock is on // most X servers do this? #define FL_META 0x00400000 ///< One of the meta/Windows keys is down // correct for XFree86 #define FL_SCROLL_LOCK 0x00800000 ///< The scroll lock is on // correct for XFree86 #define FL_BUTTON1 0x01000000 ///< Mouse button 1 is pushed #define FL_BUTTON2 0x02000000 ///< Mouse button 2 is pushed #define FL_BUTTON3 0x04000000 ///< Mouse button 3 is pushed #define FL_BUTTONS 0x7f000000 ///< Any mouse button is pushed #define FL_BUTTON(n) (0x00800000<<(n)) ///< Mouse button n (n > 0) is pushed #ifdef __APPLE__ # define FL_COMMAND FL_META ///< An alias for FL_CTRL on WIN32 and X11, or FL_META on MacOS X #else # define FL_COMMAND FL_CTRL ///< An alias for FL_CTRL on WIN32 and X11, or FL_META on MacOS X #endif // __APPLE__ /*@}*/ // group: Event States /** \name Box Types \todo Description of boxtypes still missing */ /*@{*/ enum Fl_Boxtype { // boxtypes (if you change these you must fix fl_boxtype.C): FL_NO_BOX = 0, FL_FLAT_BOX, FL_UP_BOX, FL_DOWN_BOX, FL_UP_FRAME, FL_DOWN_FRAME, FL_THIN_UP_BOX, FL_THIN_DOWN_BOX, FL_THIN_UP_FRAME, FL_THIN_DOWN_FRAME, FL_ENGRAVED_BOX, FL_EMBOSSED_BOX, FL_ENGRAVED_FRAME, FL_EMBOSSED_FRAME, FL_BORDER_BOX, _FL_SHADOW_BOX, FL_BORDER_FRAME, _FL_SHADOW_FRAME, _FL_ROUNDED_BOX, _FL_RSHADOW_BOX, _FL_ROUNDED_FRAME, _FL_RFLAT_BOX, _FL_ROUND_UP_BOX, _FL_ROUND_DOWN_BOX, _FL_DIAMOND_UP_BOX, _FL_DIAMOND_DOWN_BOX, _FL_OVAL_BOX, _FL_OSHADOW_BOX, _FL_OVAL_FRAME, _FL_OFLAT_BOX, _FL_PLASTIC_UP_BOX, _FL_PLASTIC_DOWN_BOX, _FL_PLASTIC_UP_FRAME, _FL_PLASTIC_DOWN_FRAME, _FL_PLASTIC_THIN_UP_BOX, _FL_PLASTIC_THIN_DOWN_BOX, _FL_PLASTIC_ROUND_UP_BOX, _FL_PLASTIC_ROUND_DOWN_BOX, _FL_GTK_UP_BOX, _FL_GTK_DOWN_BOX, _FL_GTK_UP_FRAME, _FL_GTK_DOWN_FRAME, _FL_GTK_THIN_UP_BOX, _FL_GTK_THIN_DOWN_BOX, _FL_GTK_THIN_UP_FRAME, _FL_GTK_THIN_DOWN_FRAME, _FL_GTK_ROUND_UP_BOX, _FL_GTK_ROUND_DOWN_BOX, FL_FREE_BOXTYPE }; extern FL_EXPORT Fl_Boxtype fl_define_FL_ROUND_UP_BOX(); #define FL_ROUND_UP_BOX fl_define_FL_ROUND_UP_BOX() #define FL_ROUND_DOWN_BOX (Fl_Boxtype)(fl_define_FL_ROUND_UP_BOX()+1) extern FL_EXPORT Fl_Boxtype fl_define_FL_SHADOW_BOX(); #define FL_SHADOW_BOX fl_define_FL_SHADOW_BOX() #define FL_SHADOW_FRAME (Fl_Boxtype)(fl_define_FL_SHADOW_BOX()+2) extern FL_EXPORT Fl_Boxtype fl_define_FL_ROUNDED_BOX(); #define FL_ROUNDED_BOX fl_define_FL_ROUNDED_BOX() #define FL_ROUNDED_FRAME (Fl_Boxtype)(fl_define_FL_ROUNDED_BOX()+2) extern FL_EXPORT Fl_Boxtype fl_define_FL_RFLAT_BOX(); #define FL_RFLAT_BOX fl_define_FL_RFLAT_BOX() extern FL_EXPORT Fl_Boxtype fl_define_FL_RSHADOW_BOX(); #define FL_RSHADOW_BOX fl_define_FL_RSHADOW_BOX() extern FL_EXPORT Fl_Boxtype fl_define_FL_DIAMOND_BOX(); #define FL_DIAMOND_UP_BOX fl_define_FL_DIAMOND_BOX() #define FL_DIAMOND_DOWN_BOX (Fl_Boxtype)(fl_define_FL_DIAMOND_BOX()+1) extern FL_EXPORT Fl_Boxtype fl_define_FL_OVAL_BOX(); #define FL_OVAL_BOX fl_define_FL_OVAL_BOX() #define FL_OSHADOW_BOX (Fl_Boxtype)(fl_define_FL_OVAL_BOX()+1) #define FL_OVAL_FRAME (Fl_Boxtype)(fl_define_FL_OVAL_BOX()+2) #define FL_OFLAT_BOX (Fl_Boxtype)(fl_define_FL_OVAL_BOX()+3) extern FL_EXPORT Fl_Boxtype fl_define_FL_PLASTIC_UP_BOX(); #define FL_PLASTIC_UP_BOX fl_define_FL_PLASTIC_UP_BOX() #define FL_PLASTIC_DOWN_BOX (Fl_Boxtype)(fl_define_FL_PLASTIC_UP_BOX()+1) #define FL_PLASTIC_UP_FRAME (Fl_Boxtype)(fl_define_FL_PLASTIC_UP_BOX()+2) #define FL_PLASTIC_DOWN_FRAME (Fl_Boxtype)(fl_define_FL_PLASTIC_UP_BOX()+3) #define FL_PLASTIC_THIN_UP_BOX (Fl_Boxtype)(fl_define_FL_PLASTIC_UP_BOX()+4) #define FL_PLASTIC_THIN_DOWN_BOX (Fl_Boxtype)(fl_define_FL_PLASTIC_UP_BOX()+5) #define FL_PLASTIC_ROUND_UP_BOX (Fl_Boxtype)(fl_define_FL_PLASTIC_UP_BOX()+6) #define FL_PLASTIC_ROUND_DOWN_BOX (Fl_Boxtype)(fl_define_FL_PLASTIC_UP_BOX()+7) extern FL_EXPORT Fl_Boxtype fl_define_FL_GTK_UP_BOX(); #define FL_GTK_UP_BOX fl_define_FL_GTK_UP_BOX() #define FL_GTK_DOWN_BOX (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+1) #define FL_GTK_UP_FRAME (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+2) #define FL_GTK_DOWN_FRAME (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+3) #define FL_GTK_THIN_UP_BOX (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+4) #define FL_GTK_THIN_DOWN_BOX (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+5) #define FL_GTK_THIN_UP_FRAME (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+6) #define FL_GTK_THIN_DOWN_FRAME (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+7) #define FL_GTK_ROUND_UP_BOX (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+8) #define FL_GTK_ROUND_DOWN_BOX (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+9) // conversions of box types to other boxtypes: inline Fl_Boxtype fl_box(Fl_Boxtype b) { return (Fl_Boxtype)((b1)?b:(b-2)); } inline Fl_Boxtype fl_down(Fl_Boxtype b) { return (Fl_Boxtype)((b