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


Xfc::Gdk Namespace Reference
[The Xfc Namespace]

The C++ framework for the GTK+ Drawing Kit and the GdkPixbuf library. More...

Classes

Typedefs

Enumerations

Functions

Event Methods
Device Methods
Keyboard/Pointer Methods
Thread Methods
Window Methods

Detailed Description

The C++ framework for the GTK+ Drawing Kit and the GdkPixbuf library.

Provides an API that can be used to add two-dimensional graphics to your program. GDK itself is the abstraction layer that allows GTK+ to support multiple windowing systems. GDK provides drawing and window system facilities on X11, Windows, and the Linux framebuffer device.


Enumeration Type Documentation

enum Xfc::Gdk::AxisUse

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

Enumerator:
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 Xfc::Gdk::ByteOrder

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

Enumerator:
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 Xfc::Gdk::CapStyle

Determines how the end of lines are drawn.

Enumerator:
CAP_NOT_LAST  The same as CAP_BUTT for lines of non-zero width; for zero width lines, the final point on the line will not be drawn.
CAP_BUTT  The ends of the lines are drawn squared off and extending to the coordinates of the end point.
CAP_ROUND  The ends of the lines are drawn as semicircles with the diameter equal to the line width and centered at the end point.
CAP_PROJECTING  The ends of the lines are drawn squared off and extending half the width of the line beyond the end point.

enum Xfc::Gdk::Colorspace

Defines the color spaces that are supported by the gdk-pixbuf library.

Currently only RGB is supported.

Enumerator:
COLORSPACE_RGB  Indicates a red/green/blue additive color space.

enum Xfc::Gdk::CrossingMode

Specifies the crossing mode for an EventCrossing.

Enumerator:
CROSSING_NORMAL  Crossing because of pointer motion.
CROSSING_GRAB  Crossing because a grab is activated.
CROSSING_UNGRAB  Crossing because a grab is deactivated.

enum Xfc::Gdk::DragAction

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

Enumerator:
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 Xfc::Gdk::DragProtocol

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

Enumerator:
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 Xfc::Gdk::EventMask

A set of bit-flags to indicate which events a window is to receive.

Most of these masks map onto one or more of the EventType event types.

POINTER_MOTION_HINT_MASK is a special mask which is used to reduce the number of MOTION_NOTIFY events received. Normally a MOTION_NOTIFY event is received each time the mouse moves. However, if the application spends a lot of time processing the event (updating the display, for example), it can easily lag behind the position of the mouse. When using the POINTER_MOTION_HINT_MASK the server will only send MOTION_NOTIFY events when the application asks for them, by calling Gdk::Window::get_pointer().

Enumerator:
EXPOSURE_MASK  Maps to the expose-event.
POINTER_MOTION_MASK  Maps to the motion-notify-event.
POINTER_MOTION_HINT_MASK  Decreases the number of motion-notify events.
BUTTON_MOTION_MASK  Maps to the motion-notify-event.
BUTTON1_MOTION_MASK  Maps to the motion-notify-event.
BUTTON2_MOTION_MASK  Maps to the motion-notify-event.
BUTTON3_MOTION_MASK  Maps to the motion-notify-event.
BUTTON_PRESS_MASK  Maps to the button-press-event.
BUTTON_RELEASE_MASK  Maps to the button-press-event.
KEY_PRESS_MASK  Maps to the key-press-event.
KEY_RELEASE_MASK  Maps to the key-release-event.
ENTER_NOTIFY_MASK  Maps to the enter-notify-event.
LEAVE_NOTIFY_MASK  Maps to the leave-notify-event.
FOCUS_CHANGE_MASK  Maps to the focus-change-event.
STRUCTURE_MASK  Allows map, unmap, destroy and configure events to be captured.
PROPERTY_CHANGE_MASK  Maps to the property-notify-event.
VISIBILITY_NOTIFY_MASK  Maps to the visibilty-notify-event.
PROXIMITY_IN_MASK  Maps to the proximity-in-event.
PROXIMITY_OUT_MASK  Maps to the proximity-out-event.
SUBSTRUCTURE_MASK  Allows a window to receive STRUCTURE_MASK events on any child windows.
SCROLL_MASK  Maps to the scroll-event.
ALL_EVENTS_MASK  Maps to the all events.

enum Xfc::Gdk::EventType

Specifies the type of the event.

Enumerator:
NOTHING  A special code to indicate a null event.
DELETE  The window manager has requested that the toplevel window be hidden or destroyed, usually when the user clicks on a special icon in the title bar.
DESTROY  The window has been destroyed.
EXPOSE  All or part of the window has become visible and needs to be redrawn.
MOTION_NOTIFY  The pointer (usually a mouse) has moved.
BUTTON_PRESS  A mouse button has been pressed.
TWO_BUTTON_PRESS  A mouse button has been double-clicked (clicked twice within a short period of time); Note that each click also generates a GDK_BUTTON_PRESS event.
THREE_BUTTON_PRESS  A mouse button has been clicked 3 times in a short period of time; Note that each click also generates a GDK_BUTTON_PRESS event.
BUTTON_RELEASE  A mouse button has been released.
KEY_PRESS  A key has been pressed.
KEY_RELEASE  A key has been released.
ENTER_NOTIFY  The pointer has entered the window.
LEAVE_NOTIFY  The pointer has left the window.
FOCUS_CHANGE  The keyboard focus has entered or left the window.
CONFIGURE  The size, position or stacking order of the window has changed; Note that GTK+ discards these events for Gdk::WINDOW_CHILD windows.
MAP  The window has been mapped.
UNMAP  The window has been unmapped.
PROPERTY_NOTIFY  A property on the window has been changed or deleted.
SELECTION_CLEAR  The application has lost ownership of a selection.
SELECTION_REQUEST  Another application has requested a selection.
SELECTION_NOTIFY  A selection has been received.
PROXIMITY_IN  An input device has moved into contact with a sensing surface (e.g. a touchscreen or graphics tablet).
PROXIMITY_OUT  An input device has moved out of contact with a sensing surface.
DRAG_ENTER  The mouse has entered the window while a drag is in progress.
DRAG_LEAVE  The mouse has entered the window while a drag is in progress.
DRAG_MOTION  The mouse has moved in the window while a drag is in progress.
DRAG_STATUS  The status of the drag operation initiated by the window has changed.
DROP_START  A drop operation onto the window has started.
DROP_FINISHED  The drop operation initiated by the window has completed.
CLIENT_EVENT  A message has been received from another application.
VISIBILITY_NOTIFY  The window visibility status has changed.
NO_EXPOSE  Indicates that the source region was completely available when parts of a drawable were copied (this is not very useful).
SCROLL  The mouse wheel was scrolled either up or down.
WINDOW_STATE  The state of a toplevel window has chnaged (either not shown, minimized, maximized, sticky or fullscreen).
SETTING  A setting was modified.
OWNER_CHANGE  The owner of a selection changed.

enum Xfc::Gdk::ExtensionMode

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

Enumerator:
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 Xfc::Gdk::Fill

Determines how primitives are drawn.

Enumerator:
SOLID  Draw with the foreground color.
TILED  Draw with a tiled pixmap.
STIPPLED  Draw using the stipple bitmap; pixels corresponding to bits in the stipple bitmap that are set will be drawn in the foreground color; pixels corresponding to bits that are not set will be left untouched.
OPAQUE_STIPPLED  Draw using the stipple bitmap; pixels corresponding to bits in the stipple bitmap that are set will be drawn in the foreground color; pixels corresponding to bits that are not set will be left untouched.

enum Xfc::Gdk::FillRule

Specifies the method for determining which pixels are included in a region, when creating a Region from a polygon.

The fill rule is only relevant for polygons which overlap themselves.

Enumerator:
EVEN_ODD_RULE  Areas which are overlapped an odd number of times are included in the region, while areas overlapped an even number of times are not.
WINDING_RULE  Overlapping areas are always included.

enum Xfc::Gdk::FilterReturn

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

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

enum Xfc::Gdk::Function

Determines how the bit values for the source pixels are combined with the bit values for destination pixels to produce the final result.

The sixteen values here correspond to the 16 different possible 2x2 truth tables. Only a couple of these values are usually useful; for colored images, only COPY, XOR and INVERT are generally useful. For bitmaps, AND and OR are also useful.

Enumerator:
COPY  Overwrites destination pixels with the source pixels (GXcopy).
INVERT  Inverts the destination pixels (GXinvert).
XOR  Xor's the destination pixels with the source pixels (GXxor).
CLEAR  Set pixels to 0 (GXclear).
AND  Source AND destination (GXand).
AND_REVERSE  Source AND NOT destination (GXandReverse).
AND_INVERT  NOT source AND destination (GXandInverted).
NOOP  Destination (GXnoop).
OR  Source OR destination (GXor).
EQUIV  NOT source XOR destination (GXequiv).
OR_REVERSE  Source OR NOT destination (GXorReverse).
COPY_INVERT  NOT source (GXcopyInverted).
OR_INVERT  NOT source OR destination (GXorInverted).
NAND  NOT source OR NOT destination (GXnand).
NOR  NOT source AND NOT destination (GXset).
SET  Set pixels to 1.

enum Xfc::Gdk::GrabStatus

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

Enumerator:
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 Xfc::Gdk::Gravity

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

Enumerator:
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 Xfc::Gdk::ImageType

Specifies the type of a Gdk::Image.

Enumerator:
IMAGE_NORMAL  The original X image type, which is quite slow since the image has to be transferred from the client to the server to display it.
IMAGE_SHARED  A faster image type, which uses shared memory to transfer the image data between client and server; However this will only be available if client and server are on the same machine and the shared memory extension is supported by the server.
IMAGE_FASTEST  Specifies that IMAGE_SHARED should be tried first, and if that fails then IMAGE_NORMAL will be used.

enum Xfc::Gdk::InputMode

An enumeration that describes the mode of an input device.

Enumerator:
MODE_DISABLED  The device is disabled and will not report any events.
MODE_SCREEN  The device is enabled; the device's coordinate space maps to the entire screen.
MODE_WINDOW  The device is enabled; the device's coordinate space is mapped to a single window (the manner in which this window is chosen is undefined, but it will typically be the same way in which the focus window for key events is determined).

enum Xfc::Gdk::InputSource

An enumeration describing the type of an input device in general terms.

Enumerator:
SOURCE_MOUSE  The device is a mouse (this will be reported for the core pointer, even if it is something else, such as a trackball).
SOURCE_PEN  The device is a stylus of a graphics tablet or similar device.
SOURCE_ERASER  The device is an eraser; typically, this would be the other end of a stylus on a graphics tablet.
SOURCE_CURSOR  The device is a graphics tablet "puck" or similar device.

enum Xfc::Gdk::InterpType

Describes the different interpolation modes that can be used with the scaling functions.

INTERP_NEAREST is the fastest scaling method, but has horrible quality when scaling down. INTERP_BILINEAR is the best choice if you aren't sure what to choose, it has a good speed/quality balance.

Note: Cubic filtering is missing from the list; hyperbolic interpolation is just as fast and results in higher quality.

Enumerator:
INTERP_NEAREST  Nearest neighbor sampling; this is the fastest and lowest quality mode; Quality is normally unacceptable when scaling down, but may be OK when scaling up.
INTERP_TILES  This is an accurate simulation of the PostScript image operator without any interpolation enabled; Each pixel is rendered as a tiny parallelogram of solid color, the edges of which are implemented with antialiasing; It resembles nearest neighbor for enlargement, and bilinear for reduction.
INTERP_BILINEAR  Best quality/speed balance; use this mode by default (bilinear interpolation); For enlargement, it is equivalent to point-sampling the ideal bilinear-interpolated image; For reduction, it is equivalent to laying down small tiles and integrating over the coverage area.
INTERP_HYPER  This is the slowest and highest quality reconstruction function; It is derived from the hyperbolic filters in Wolberg's "Digital Image Warping", and is formally defined as the hyperbolic-filter sampling the ideal hyperbolic-filter interpolated image (the filter is designed to be idempotent for 1:1 pixel mapping).

enum Xfc::Gdk::JoinStyle

Determines how the joins between segments of a polygon are drawn.

Enumerator:
JOIN_MITER  The sides of each line are extended to meet at an angle.
JOIN_ROUND  The sides of the two lines are joined by a circular arc.
JOIN_BEVEL  The sides of the two lines are joined by a straight line which makes an equal angle with each line.

enum Xfc::Gdk::LineStyle

Determines how lines are drawn.

Enumerator:
LINE_SOLID  Lines are drawn solid.
LINE_ON_OFF_DASH  Even segments are drawn; odd segments are not drawn.
LINE_DOUBLE_DASH  Even segments are drawn normally.

Odd segments are drawn in the background color if the fill style is SOLID, or in the background color masked by the stipple if the fill style is STIPPLED.

enum Xfc::Gdk::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.

Enumerator:
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 Xfc::Gdk::NotifyType

Specifies the kind of crossing for an EventCrossing.

See the X11 protocol specification of LeaveNotify for full details of crossing event generation.

Enumerator:
NOTIFY_ANCESTOR  The window is entered from an ancestor or left towards an ancestor.
NOTIFY_VIRTUAL  The pointer moves between an ancestor and an inferior of the window.
NOTIFY_INFERIOR  The window is entered from an inferior or left towards an inferior.
NOTIFY_NONLINEAR  The window is entered from or left towards a window which is neither an ancestor nor an inferior.
NOTIFY_NONLINEAR_VIRTUAL  The pointer moves between two windows which are not ancestors of each other and the window is part of the ancestor chain between one of these windows and their least common ancestor.
NOTIFY_UNKNOWN  Unknown.

enum Xfc::Gdk::OverlapType

Specifies the possible values returned by Gdk::Region::rect_in().

Enumerator:
OVERLAP_RECTANGLE_IN  The rectangle is inside the Region.
OVERLAP_RECTANGLE_OUT  The rectangle is outside the Region.
OVERLAP_RECTANGLE_PART  The rectangle is partly inside the Region.

enum Xfc::Gdk::OwnerChange

Specifies why a selection ownership was changed.

Enumerator:
OWNER_CHANGE_NEW_OWNER  Some other application claimed the ownership.
OWNER_CHANGE_DESTROY  The window was destroyed.
OWNER_CHANGE_CLOSE  The client was closed.

enum Xfc::Gdk::PixbufAlphaMode

These values can be passed to render_to_drawable_alpha() to control how the alpha chanel of an image should be handled.

This method can create a bilevel clipping mask (black and white) and use it while pagfcng the image. In the future, when the X Window System gets an alpha channel extension, it will be possible to do full alpha compositing onto arbitrary drawables. For now both cases fall back to a bilevel clipping mask.

Enumerator:
PIXBUF_ALPHA_BILEVEL  A bilevel clipping mask (black and white) will be created and used to draw the image; Pixels below 0.5 opacity will be considered fully transparent, and all others will be considered fully opaque.
PIXBUF_ALPHA_FULL  For now falls back to PIXBUF_ALPHA_BILEVEL; In the future it will do full alpha compositing.

enum Xfc::Gdk::PixbufRotation

The possible rotations which can be passed to rotate_simple().

To make them easier to use, their numerical values are the actual degrees.

Enumerator:
PIXBUF_ROTATE_NONE  No rotation.
PIXBUF_ROTATE_COUNTERCLOCKWISE  Rotate by 90 degrees.
PIXBUF_ROTATE_UPSIDEDOWN  Rotate by 180 degrees.
PIXBUF_ROTATE_CLOCKWISE  Rotate by 270 degrees.

enum Xfc::Gdk::PropertyState

Specifies the type of a property change for an EventProperty.

Enumerator:
PROPERTY_NEW_VALUE  The property value was changed.
PROPERTY_DELETE  The property was deleted.

enum Xfc::Gdk::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.

Enumerator:
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 Xfc::Gdk::ScrollDirection

Specifies the direction for an EventScroll.

Enumerator:
SCROLL_UP  The window is scrolled up.
SCROLL_LEFT  The window is scrolled down. The window is scrolled to the left.
SCROLL_RIGHT  The window is scrolled to the right.

enum Xfc::Gdk::SettingAction

Specifies the kind of modification applied to a setting in an EventSetting.

Enumerator:
SETTING_ACTION_NEW  A setting was added.
SETTING_ACTION_CHANGED  A setting was changed.
SETTING_ACTION_DELETED  A setting was deleted.

enum Xfc::Gdk::SubwindowMode

Determines how drawing onto a window will affect child windows of that window.

Enumerator:
CLIP_BY_CHILDREN  Only draw onto the window itself.
INCLUDE_INFERIORS  Draw onto the window and child windows.

enum Xfc::Gdk::VisibilityState

Specifies the visiblity status of a window for an EventVisibility.

Enumerator:
VISIBILITY_UNOBSCURED  The window is completely visible.
VISIBILITY_PARTIAL  The window is partially visible.
VISIBILITY_FULLY_OBSCURED  The window is not visible at all.

enum Xfc::Gdk::VisualType

A set of values that describe the manner in which the pixel values for a visual are converted into RGB values for display.

Enumerator:
VISUAL_STATIC_GRAY  Each pixel value indexes a grayscale value directly.
VISUAL_GRAYSCALE  Each pixel is an index into a color map that maps pixel values into grayscale values (the color map can be changed by an application).
VISUAL_STATIC_COLOR  Each pixel value is an index into a predefined, unmodifiable color map that maps pixel values into RGB values.
VISUAL_PSUEDO_COLOR  Each pixel is an index into a color map that maps pixel values into rgb values (the color map can be changed by an application).
VISUAL_TRUE_COLOR  Each pixel value directly contains red, green, and blue components (The red_mask, green_mask, and blue_mask fields of the GdkVisual structure describe how the components are assembled into a pixel value).
VISUAL_DIRECT_COLOR  Each pixel value contains red, green, and blue components as for GDK_TRUE_COLOR, but the components are mapped via a color table into the final output table instead of being converted directly.

enum Xfc::Gdk::WindowEdge

Determines a window edge or corner.

Enumerator:
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 Xfc::Gdk::WindowState

Specifies the state of a toplevel window.

Enumerator:
WINDOW_STATE_WITHDRAWN  The window is not shown.
WINDOW_STATE_ICONIFIED  The window is minimized.
WINDOW_STATE_MAXIMIZED  The window is maximized.
WINDOW_STATE_STICKY  The window is sticky.
WINDOW_STATE_FULLSCREEN  The window is fullscreen.
WINDOW_STATE_ABOVE  The window is kept above other windows.
WINDOW_STATE_BELOW  The window is kept below other windows.

enum Xfc::Gdk::WindowType

Describes the kind of window.

Enumerator:
WINDOW_ROOT  The root window; this window has no parent, covers the entire screen, and is created by the window system.
WINDOW_TOPLEVEL  Toplevel window (used to implement Gtk::Window).
WINDOW_CHILD  Child window (used to implement e.g. Gtk::Button).
WINDOW_DIALOG  Useless/deprecated compatibility type.
WINDOW_TEMP  Override redirect temporary window (used to implement Gtk::Menu).
WINDOW_FOREIGN  Foreign window.

enum Xfc::Gdk::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.

Enumerator:
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.

enum Xfc::Gdk::WMDecoration

Specifies hints the window manager can use when determining how to decorate a window.

The hint must be set before mapping the window. These hints were originally defined by the Motif toolkit.

Enumerator:
DECOR_ALL  All decorations should be applied.
DECOR_BORDER  A frame should be drawn around the window.
DECOR_RESIZEH  The frame should have resize handles.
DECOR_TITLE  A titlebar should be placed above the window.
DECOR_MENU  A button for opening a menu should be included.
DECOR_MINIMIZE  A minimize button should be included.
DECOR_MAXIMIZE  A maximize button should be included.

enum Xfc::Gdk::WMFunction

Specifies hints the window manager can use when determining the functions to offer for the window.

The hint must be set before mapping the window. These hints were originally defined by the Motif toolkit.

Enumerator:
FUNC_ALL  All functions should be offered.
FUNC_RESIZE  The window should be resizable.
FUNC_MOVE  The window should be movable.
FUNC_MINIMIZE  The window should be minimizable.
FUNC_MAXMIZE  The window should be maximizable.
FUNC_CLOSE  The window should be closable.


Function Documentation

bool Xfc::Gdk::devices_list ( std::vector< Device * > &  devices  ) 

Returns the list of available input devices attached to the default display.

Parameters:
devices A reference to a vector of Device* to hold the list of devices.
Returns:
true if the vector is not empty.
The devices in this list are statically allocated and will be freed by GTK+. See also Gdk::Display::list_devcies.

bool Xfc::Gdk::events_pending (  ) 

Checks if any events are ready to be processed for any display.

Returns:
true if any events are pending.

void Xfc::Gdk::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.

Window* Xfc::Gdk::get_default_root_window (  ) 

Obtains the root window (parent all other windows are inside) for the default display and screen.

Returns:
The default root window.

void Xfc::Gdk::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 Xfc::Gdk::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 Xfc::Gdk::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.

void Xfc::Gdk::set_show_events ( bool  show_events  ) 

Sets whether a trace of received events is output.

Parameters:
show_events Set true to output event debugging information.
Note that GTK+ must be compiled with debugging (that is, configured using the --enable-debug option) to use this option.

Xfce Foundation Classes


Copyright © 2004-2005 The XFC Development Team XFC 4.3