Xfce Foundation Classes
Main Page  | IndexNamespace List  |  Alphabetical List  |  Class List  |  File List


gdk/types.hh File Reference

A GdkPoint, GdkRectangle, GdkSegment and GdkSpan C++ wrapper interface. More...

#include <gdk/gdk.h>
#include <xfc/gdk/inline/types.inl>

Namespaces

Classes

Keyboard/Pointer Methods

Thread Methods

Typedefs

Enumerations


Detailed Description

A GdkPoint, GdkRectangle, GdkSegment and GdkSpan C++ wrapper interface.

Provides common enumerations and four utility classes - Point, Rectangle, Segment and Span.


Enumeration Type Documentation

enum AxisUse
 

An enumeration describing the way in which a device axis (valuator) maps onto the predefined valuator types that GTK+ understands.

Enumeration values:
AXIS_IGNORE  The axis is ignored.
AXIS_X  The axis is used as the x axis.
AXIS_Y  The axis is used as the y axis.
AXIS_PRESSURE  The axis is used for pressure information.
AXIS_XTILT  The axis is used for x tilt information.
AXIS_YTILT  The axis is used for x tilt information.
AXIS_WHEEL  The axis is used for wheel information.
AXIS_LAST  A constant equal to the numerically highest axis value.

enum ByteOrder
 

A set of values describing the possible byte-orders for storing pixel values in memory.

Enumeration values:
LSB_FIRST  The values are stored with the least-significant byte first; for instance, the 32-bit value 0xffeecc would be stored in memory as 0xcc, 0xee, 0xff, 0x00.
MSB_FIRST  The values are stored with the most-significant byte first; for instance, the 32-bit value 0xffeecc would be stored in memory as 0x00, 0xcc, 0xee, 0xff.

enum DragAction
 

Used in Gdk::DragContext to indicate what the destination should do with the dropped data.

Enumeration values:
ACTION_DEFAULT  The default action for the protocol being used.
ACTION_COPY  Copy the data.
ACTION_MOVE  Move the data, that is, first copy it, then delete it from the source using the DELETE target of the X selection protocol.
ACTION_LINK  Add a link to the data; note that this is only useful if source and destination agree on what it means.
ACTION_PRIVATE  Special action which tells the source that the destination will do something that the source doesn't understand.
ACTION_ASK  Ask the user what to do with the data.

enum DragProtocol
 

Used in Gdk::DragContext to indicate the protocol according to which DND is done.

Enumeration values:
DRAG_PROTO_MOTIF  The Motif DND protocol.
DRAG_PROTO_XDND  The Xdnd protocol.
DRAG_PROTO_ROOTWIN  Extension to Xdnd protocol for unclaimed root window drops.
DRAG_PROTO_  No protocol.
DRAG_PROTO_NONE  The simple WM_DROPFILES protocol.
DRAG_PROTO_OLE2  The complex OLE2 DND protocol (not implemented).
DRAG_PROTO_LOCAL  Intra-application DND.

enum ExtensionMode
 

An enumeration used to specify which extension events are desired for a particular widget.

Enumeration values:
EXTENSION_EVENTS_NONE  No extension events are desired.
EXTENSION_EVENTS_ALL  All extension events are desired.
EXTENSION_EVENTS_CURSOR  Extension events are desired only if a cursor will be displayed for the device.

enum FilterReturn
 

Specifies the result of applying a FilterSlot to a native event.

Enumeration values:
FILTER_CONTINUE  Event not handled, continue processesing.
FILTER_TRANSLATE  Translated the event stored.
FILTER_REMOVE  Terminate processing, removing event.

enum GrabStatus
 

Returned by pointer_grab() and keyboard_grab() to indicate success or the reason for the failure of the grab attempt.

Enumeration values:
GRAB_SUCCESS  The resource was successfully grabbed.
GRAB_ALREADY_GRABBED  The resource is actively grabbed by another client.
GRAB_INVALID_TIME  The resource was grabbed more recently than the specified time.
GRAB_NOT_VIEWABLE  The grab window or the confine_to window are not viewable.
GRAB_FROZEN  The resource is frozen by an active grab of another client.

enum Gravity
 

Defines the reference point of a window and the meaning of coordinates passed to Gtk::Window::move().

Enumeration values:
GRAVITY_NORTH_WEST  The reference point is at the top left corner.
GRAVITY_NORTH  The reference point is in the middle of the top edge.
GRAVITY_NORTH_EAST  The reference point is at the top right corner.
GRAVITY_WEST  The reference point is at the middle of the left edge.
GRAVITY_CENTER  The reference point is at the center of the window.
GRAVITY_EAST  The reference point is at the middle of the right edge.
GRAVITY_SOUTH_WEST  The reference point is at the lower left corner.
GRAVITY_SOUTH  The reference point is at the middle of the lower edge.
GRAVITY_SOUTH_EAST  The reference point is at the lower right corner.
GRAVITY_STATIC  The reference point is at the top left corner of the window itself, ignoring window manager decorations.

enum ModifierType
 

A set of bit-flags to indicate the state of modifier keys and mouse buttons in various event types.

Typical modifier keys are Shift, Control, Meta, Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.

Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons.

Enumeration values:
SHIFT_MASK  The Shift key.
LOCK_MASK  A Lock key (depending on the modifier mapping of the X server this may either be CapsLock or ShiftLock).
CONTROL_MASK  The Control key.
MOD1_MASK  The fourth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier, but normally it is the Alt key).
MOD2_MASK  The fifth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).
MOD3_MASK  The sixth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).
MOD4_MASK  The seventh modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).
MOD5_MASK  The eighth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).
BUTTON1_MASK  The first mouse button.
BUTTON2_MASK  The second mouse button.
BUTTON3_MASK  The third mouse button.
BUTTON4_MASK  The fourth mouse button.
BUTTON5_MASK  The fifth mouse button.
RELEASE_MASK  Not used in GDK itself; GTK+ uses it to differentiate between (keyval, modifiers) pairs from key press and release events.
MODIFIER_MASK  Unknown.

enum RgbDither
 

Selects whether or not GdkRGB applies dithering to the image on display.

Since GdkRGB currently only handles images with 8 bits per component, dithering on 24 bit per pixel displays is a moot point.

Enumeration values:
RGB_DITHER_NONE  Never use dithering.
RGB_DITHER_NORMAL  Use dithering in 8 bits per pixel (and below) only.
RGB_DITHER_MAX  Use dithering in 16 bits per pixel and below.

enum WindowEdge
 

Determines a window edge or corner.

Enumeration values:
WINDOW_EDGE_NORTH_WEST  The top left corner.
WINDOW_EDGE_NORTH  The top edge.
WINDOW_EDGE_NORTH_EAST  The top right corner.
WINDOW_EDGE_WEST  The left edge.
WINDOW_EDGE_EAST  The right edge.
WINDOW_EDGE_SOUTH_WEST  The lower left corner.
WINDOW_EDGE_SOUTH  The lower edge.
WINDOW_EDGE_SOUTH_EAST  The lower right corner.

enum WindowTypeHint
 

These are hints for the window manager that indicate what type of function the window has.

The window manager can use this when determining decoration and behaviour of the window. The hint must be set before mapping the window.

Enumeration values:
WINDOW_TYPE_HINT_NORMAL  Normal toplevel window.
WINDOW_TYPE_HINT_DIALOG  Dialog window.
WINDOW_TYPE_HINT_MENU  Window used to implement a menu.
WINDOW_TYPE_HINT_TOOLBAR  Window used to implement toolbars.
WINDOW_TYPE_HINT_SPLASHSCREEN  Window used to implement a splashscreen.


Function Documentation

void flush  ) 
 

Flushes the X output buffer and waits until all requests have been processed by the server.

This is rarely needed by single-threaded applications. It's main use in XFC is for multi-threaded programming. Before unlocking a critical section of code with a call to Gdk::Mutex::unlock() you might want to call flush() to send all pending commands to the windowing system.

void keyboard_ungrab unsigned int  time = GDK_CURRENT_TIME  ) 
 

Ungrabs the keyboard for the default display, if it is grabbed by this application (see Gdk::Display::keyboard_ungrab()).

Parameters:
time A timestamp from a Gdk::Event, or GDK_CURRENT_TIME if no timestamp is available.

bool pointer_is_grabbed  ) 
 

Returns true if the pointer for the default display is currently grabbed by this application (see Gdk::Display::pointer_is_grabbed()).

Returns:
true if the pointer is currently grabbed by this application.
Note that this does not take the implicit pointer grab on button presses into account.

void pointer_ungrab unsigned int  time = GDK_CURRENT_TIME  ) 
 

Ungrabs the pointer for the default display, if it is grabbed by this application.

(see Gdk::Display::pointer_ungrab()).

Parameters:
time A timestamp from a Gdk::Event, or GDK_CURRENT_TIME if no timestamp is available.
Xfce Foundation Classes


Copyright © 2004-2005 The XFC Development Team XFC 4.3