---

guidefines.h File Reference

More...

Compounds
struct	screen_mode
Enumerations
enum	alignment {   ALIGN_LEFT,   ALIGN_RIGHT,   ALIGN_TOP,   ALIGN_BOTTOM,   ALIGN_CENTER }
enum	orientation {   HORIZONTAL,   VERTICAL }
enum	color_space {   CS_NO_COLOR_SPACE,   CS_RGB32,   CS_RGBA32,   CS_RGB24,   CS_RGB16,   CS_RGB15,   CS_RGBA15,   CS_CMAP8,   CS_GRAY8,   CS_GRAY1,   CS_YUV422,   CS_YUV411,   CS_YUV420,   CS_YUV444,   CS_YUV9,   CS_YUV12 }
enum	mouse_ptr_mode {   MPTR_MONO = 0x01,   MPTR_CMAP8 = 0x02,   MPTR_RGB32 = 0x04 }
enum	{   TRANSPARENT_CMAP8 = 0xff,   TRANSPARENT_RGB32 = 0xffffffff }
enum	drawing_mode {   DM_COPY,   DM_OVER,   DM_INVERT,   DM_ERASE,   DM_BLEND,   DM_ADD,   DM_SUBTRACT,   DM_MIN,   DM_MAX,   DM_SELECT }
enum	{   MOUSE_BUT_LEFT = 0x01,   MOUSE_BUT_MID = 0x02,   MOUSE_BUT_RIGHT = 0x04 }
enum	{   QUAL_LSHIFT = 0x01,   QUAL_RSHIFT = 0x02,   QUAL_SHIFT = QUAL_LSHIFT | QUAL_RSHIFT,   QUAL_LCTRL = 0x04,   QUAL_RCTRL = 0x08,   QUAL_CTRL = QUAL_LCTRL | QUAL_RCTRL,   QUAL_LALT = 0x10,   QUAL_RALT = 0x20,   QUAL_ALT = QUAL_LALT | QUAL_RALT,   QUAL_REPEAT = 0x40 }
enum	{   VK_BACKSPACE = 0x08,   VK_ENTER = 0x0a,   VK_RETURN = 0x0a,   VK_SPACE = 0x20,   VK_TAB = 0x09,   VK_ESCAPE = 0x1b,   VK_LEFT_ARROW = 0x1c,   VK_RIGHT_ARROW = 0x1d,   VK_UP_ARROW = 0x1e,   VK_DOWN_ARROW = 0x1f,   VK_INSERT = 0x05,   VK_DELETE = 0x7f,   VK_HOME = 0x01,   VK_END = 0x04,   VK_PAGE_UP = 0x0b,   VK_PAGE_DOWN = 0x0c,   VK_FUNCTION_KEY = 0x10 }
	Predefined ASCII values for the various special keys. More...
enum	{   MBI_LEFT = 1,   MBI_RIGHT = 2,   MBI_MIDDLE = 3,   MBI_FIRST_EXTRA = 4 }
enum	{   MBM_LEFT = 0x01,   MBM_RIGHT = 0x02,   MBM_MIDDLE = 0x04 }
enum	{   M_LAST_USER_MSG = 9999999,   M_ABOUT_REQUESTED = 10000000,   M_WINDOW_ACTIVATED,   M_APP_ACTIVATED,   M_ARGV_RECEIVED,   M_QUIT_REQUESTED,   M_CLOSE_REQUESTED,   M_KEY_DOWN,   M_KEY_UP,   M_MINIMIZE,   M_MOUSE_DOWN,   M_MOUSE_UP,   M_MOUSE_MOVED,   M_WHEEL_MOVED,   M_READY_TO_RUN,   M_PATHS_RECEIVED,   M_SCREEN_CHANGED,   M_VALUE_CHANGED,   M_VIEW_MOVED,   M_VIEW_RESIZED,   M_WINDOW_MOVED,   M_WINDOW_RESIZED,   M_DESKTOP_ACTIVATED,   M_SCREENMODE_CHANGED,   M_ZOOM,   M_PAINT,   M_COLOR_CONFIG_CHANGED,   M_FONT_CHANGED,   M_MENU_EVENT,   _M_UNUSED2,   _M_UNUSED3,   M_QUIT,   M_TERMINATE,   _M_UNUSED4,   _M_UNUSED5,   _M_UNUSED6,   _M_UNUSED7,   _M_UNUSED8,   _M_UNUSED9,   M_MOVE_WINDOW,   M_RESIZE_WINDOW,   M_WINDOW_FRAME_CHANGED,   M_SET_PROPERTY = 20000000,   M_GET_PROPERTY,   M_CREATE_PROPERTY,   M_DELETE_PROPERTY,   M_GET_SUPPORTED_SUITES,   M_CUT,   M_COPY,   M_PASTE,   M_LOAD_REQUESTED,   M_SAVE_REQUESTED,   M_FILE_REQUESTER_CANCELED,   M_MESSAGE_NOT_UNDERSTOOD,   M_NO_REPLY,   M_REPLY,   M_SIMPLE_DATA,   M_MIME_DATA,   M_ARCHIVED_OBJECT,   M_UPDATE_STATUS_BAR,   M_RESET_STATUS_BAR,   M_NODE_MONITOR,   M_FIRST_EVENT = 1000000000 }
	This is the various messages that is sent by the system. More...

---

Detailed Description

Description:

Verious global defines used throughout the GUI toolkit.

Author:

Kurt Skauen ([email protected])

---

Enumeration Type Documentation

anonymous enum

Most of these are handled internally by the various GUI classes but every now and then you might have to deal with them on your own. Input event messages like M_MOUSE_DOWN/M_MOUSE_UP/M_MOUSE_MOVED/M_KEY_DOWN, etc etc are all translated into calls of the various os::View virtual hook members so you don't have to know anything about the raw messages to deal with them. M_KEY_DOWN/M_KEY_UP: This messages are sendt to the active window to report keyboard activity. They are translated into calls of View::KeyDown() View::KeyUp() on the active view by the Window class so you normally don't have to deal with it on your own. Not all members of the message are extracted and passed to the virtual hooks though so you might occationally have to mess with the raw message yourself. Name Type Description _raw_key T_INT32 The raw untranslated key-code _qualifiers T_INT32 The current qualifier mask _string T_STRING String containing a single UTF-8 encoded character. _raw_string T_STRING String containing a single UTF-8 encoded character. M_MOUSE_DOWN/M_MOUSE_UP This messages are send when the user click one of the mouse buttons. They are translated into calls of View::MouseDown() and View::MouseUp() by the Window class and are rarly touched from user code. Name Type Description _button T_INT32 Button number. Buttons are numbered from 1 where 1 is the left button, 2 is the right button, and 3 is the middle button. The mouse driver can also suppor additional buttons and this will then be assigned numbers from 4 and up. _drag_message T_MESSAGE This member is only present in M_MOUSE_UP messages and only if the M_MOUSE_UP was the end of a drag and drop operating. The content is the data being dragged as defined by the View::BeginDrag() member. Enumeration values: M_LAST_USER_MSG   M_ABOUT_REQUESTED   M_WINDOW_ACTIVATED   M_APP_ACTIVATED   M_ARGV_RECEIVED   M_QUIT_REQUESTED   M_CLOSE_REQUESTED   M_KEY_DOWN   M_KEY_UP   M_MINIMIZE   M_MOUSE_DOWN   M_MOUSE_UP   M_MOUSE_MOVED   M_WHEEL_MOVED   M_READY_TO_RUN   M_PATHS_RECEIVED   M_SCREEN_CHANGED   M_VALUE_CHANGED   M_VIEW_MOVED   M_VIEW_RESIZED   M_WINDOW_MOVED   M_WINDOW_RESIZED   M_DESKTOP_ACTIVATED   M_SCREENMODE_CHANGED   M_ZOOM   M_PAINT   M_COLOR_CONFIG_CHANGED   M_FONT_CHANGED   M_MENU_EVENT   _M_UNUSED2   _M_UNUSED3   M_QUIT   M_TERMINATE   _M_UNUSED4   _M_UNUSED5   _M_UNUSED6   _M_UNUSED7   _M_UNUSED8   _M_UNUSED9   M_MOVE_WINDOW   M_RESIZE_WINDOW   M_WINDOW_FRAME_CHANGED   M_SET_PROPERTY   M_GET_PROPERTY   M_CREATE_PROPERTY   M_DELETE_PROPERTY   M_GET_SUPPORTED_SUITES   M_CUT   M_COPY   M_PASTE   M_LOAD_REQUESTED   M_SAVE_REQUESTED   M_FILE_REQUESTER_CANCELED   M_MESSAGE_NOT_UNDERSTOOD   M_NO_REPLY   M_REPLY   M_SIMPLE_DATA   M_MIME_DATA   M_ARCHIVED_OBJECT   M_UPDATE_STATUS_BAR   M_RESET_STATUS_BAR   M_NODE_MONITOR   M_FIRST_EVENT

anonymous enum

Enumeration values: TRANSPARENT_CMAP8   TRANSPARENT_RGB32

anonymous enum

Enumeration values: MOUSE_BUT_LEFT   MOUSE_BUT_MID   MOUSE_BUT_RIGHT

anonymous enum

Description: Bit-masks for the verious qualifier keys. This defines can be used to check whether a given qualifier (or group of qualifiers) are pressed or not. The current qualifier mask is passed into various hook members dealing with keyboard input in the View class and it can also be retrieved asyncronously with the View::GetQualifiers() member. Enumeration values: QUAL_LSHIFT   Left <SHIFT> key. QUAL_RSHIFT   Right <SHIFT> key. QUAL_SHIFT   Any <SHIFT> key. QUAL_LCTRL   Left <CONTROL> key. QUAL_RCTRL   Right <CONTROL> key. QUAL_CTRL   Any <CONTROL> key. QUAL_LALT   Left <ALT> key. QUAL_RALT   Right <ALT> key. QUAL_ALT   Any <ALT> key. QUAL_REPEAT   Set if the key-down event was caused by key repeating.

anonymous enum

Enumeration values: VK_BACKSPACE   VK_ENTER   VK_RETURN   VK_SPACE   VK_TAB   VK_ESCAPE   VK_LEFT_ARROW   VK_RIGHT_ARROW   VK_UP_ARROW   VK_DOWN_ARROW   VK_INSERT   VK_DELETE   VK_HOME   VK_END   VK_PAGE_UP   VK_PAGE_DOWN   VK_FUNCTION_KEY

anonymous enum

Enumeration values: MBI_LEFT   MBI_RIGHT   MBI_MIDDLE   MBI_FIRST_EXTRA

anonymous enum

Enumeration values: MBM_LEFT   MBM_RIGHT   MBM_MIDDLE

enum alignment

Enumeration values: ALIGN_LEFT   ALIGN_RIGHT   ALIGN_TOP   ALIGN_BOTTOM   ALIGN_CENTER

enum color_space

Enumeration values: CS_NO_COLOR_SPACE   CS_RGB32   CS_RGBA32   CS_RGB24   CS_RGB16   CS_RGB15   CS_RGBA15   CS_CMAP8   CS_GRAY8   CS_GRAY1   CS_YUV422   CS_YUV411   CS_YUV420   CS_YUV444   CS_YUV9   CS_YUV12

enum drawing_mode

Enumeration values: DM_COPY   DM_OVER   DM_INVERT   DM_ERASE   DM_BLEND   DM_ADD   DM_SUBTRACT   DM_MIN   DM_MAX   DM_SELECT

enum mouse_ptr_mode

Enumeration values: MPTR_MONO   MPTR_CMAP8   MPTR_RGB32

enum orientation

Enumeration values: HORIZONTAL   VERTICAL

---