Used to represent native events (<type>XEvent</type>s for the X11 backend, <type>MSG</type>s for Win32). Creates a new #GdkAppLaunchContext.

a new #GdkAppLaunchContext

Sets the workspace on which applications will be launched when using this context when running under a window manager that supports multiple workspaces, as described in the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink>. When the workspace is not specified or @desktop is set to -1, it is up to the window manager to pick one, typically it will be the current workspace.

the number of a workspace, or -1 Sets the display on which applications will be launched when using this context. See also gdk_app_launch_context_set_screen().

a #GdkDisplay Sets the icon for applications that are launched with this context. Window Managers can use this information when displaying startup notification. See also gdk_app_launch_context_set_icon_name().

a #GIcon, or %NULL Sets the icon for applications that are launched with this context. The @icon_name will be interpreted in the same way as the Icon field in desktop files. See also gdk_app_launch_context_set_icon(). If both @icon and @icon_name are set, the @icon_name takes priority. If neither @icon or @icon_name is set, the icon is taken from either the file that is passed to launched application or from the #GAppInfo for the launched application itself.

an icon name, or %NULL Sets the screen on which applications will be launched when using this context. See also gdk_app_launch_context_set_display(). If both @screen and @display are set, the @screen takes priority. If neither @screen or @display are set, the default screen and display are used.

a #GdkScreen Sets the timestamp of @context. The timestamp should ideally be taken from the event that triggered the launch. Window managers can use this information to avoid moving the focus to the newly launched application when the user is busy typing in another window. This is also known as 'focus stealing prevention'.

a timestamp An enumeration describing the way in which a device axis (valuator) maps onto the predefined valuator types that GTK+ understands. Makes a copy of a color structure. The result must be freed using gdk_color_free().

a copy of @color.

Compares two colors.

%TRUE if the two colors compare equal

another #GdkColor. Frees a color structure created with gdk_color_copy().

A hash function suitable for using for a hash table that stores #GdkColor's.

The hash function applied to @colora

Returns a textual specification of @color in the hexadecimal form <literal>&num;rrrrggggbbbb</literal>, where <literal>r</literal>, <literal>g</literal> and <literal>b</literal> are hex digits representing the red, green and blue components respectively.

a newly-allocated text string

Creates a new colormap for the given visual.

the new #GdkColormap.

a #GdkVisual. if %TRUE, the newly created colormap will be a private colormap, and all colors in it will be allocated for the applications use. Gets the system's default colormap for the default screen. (See gdk_colormap_get_system_for_screen ())

the default colormap.

Allocates a single color from a colormap.

%TRUE if the allocation succeeded.

the color to allocate. On return the <structfield>pixel</structfield> field will be filled in if allocation succeeds. this parameter has no effect, and it's here for mere compatibility. If %TRUE, GDK will attempt to do matching against existing colors if the color cannot be allocated as requested. Allocates colors from a colormap. allocated.

The number of colors that were not successfully

The color values to allocate. On return, the pixel values for allocated colors will be filled in. The number of colors in @colors. this parameter has no effect, and it's here for mere compatibility. If %TRUE, GDK will attempt to do matching against existing colors if the colors cannot be allocated as requested. An array of length @ncolors. On return, this indicates whether the corresponding color in @colors was successfully allocated or not. Frees previously allocated colors.

the colors to free. the number of colors in @colors. Gets the screen for which this colormap was created.

the screen for which this colormap was created.

Returns the visual for which a given colormap was created.

the visual of the colormap.

Creates a new cursor from the set of builtin cursors for the default display. See gdk_cursor_new_for_display(). To make the cursor invisible, use %GDK_BLANK_CURSOR.

a new #GdkCursor

cursor to create Creates a new cursor from the set of builtin cursors. Some useful ones are: <itemizedlist> <listitem><para> <inlinegraphic format="PNG" fileref="right_ptr.png"></inlinegraphic> #GDK_RIGHT_PTR (right-facing arrow) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="crosshair.png"></inlinegraphic> #GDK_CROSSHAIR (crosshair) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="xterm.png"></inlinegraphic> #GDK_XTERM (I-beam) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="watch.png"></inlinegraphic> #GDK_WATCH (busy) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="fleur.png"></inlinegraphic> #GDK_FLEUR (for moving objects) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="hand1.png"></inlinegraphic> #GDK_HAND1 (a right-pointing hand) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="hand2.png"></inlinegraphic> #GDK_HAND2 (a left-pointing hand) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="left_side.png"></inlinegraphic> #GDK_LEFT_SIDE (resize left side) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="right_side.png"></inlinegraphic> #GDK_RIGHT_SIDE (resize right side) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="top_left_corner.png"></inlinegraphic> #GDK_TOP_LEFT_CORNER (resize northwest corner) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="top_right_corner.png"></inlinegraphic> #GDK_TOP_RIGHT_CORNER (resize northeast corner) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="bottom_left_corner.png"></inlinegraphic> #GDK_BOTTOM_LEFT_CORNER (resize southwest corner) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="bottom_right_corner.png"></inlinegraphic> #GDK_BOTTOM_RIGHT_CORNER (resize southeast corner) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="top_side.png"></inlinegraphic> #GDK_TOP_SIDE (resize top side) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="bottom_side.png"></inlinegraphic> #GDK_BOTTOM_SIDE (resize bottom side) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="sb_h_double_arrow.png"></inlinegraphic> #GDK_SB_H_DOUBLE_ARROW (move vertical splitter) </para></listitem> <listitem><para> <inlinegraphic format="PNG" fileref="sb_v_double_arrow.png"></inlinegraphic> #GDK_SB_V_DOUBLE_ARROW (move horizontal splitter) </para></listitem> <listitem><para> #GDK_BLANK_CURSOR (Blank cursor). Since 2.16 </para></listitem> </itemizedlist>

a new #GdkCursor

the #GdkDisplay for which the cursor will be created cursor to create Creates a new cursor by looking up @name in the current cursor theme. the given name

a new #GdkCursor, or %NULL if there is no cursor with

the #GdkDisplay for which the cursor will be created the name of the cursor Creates a new cursor from a pixbuf. Not all GDK backends support RGBA cursors. If they are not supported, a monochrome approximation will be displayed. The functions gdk_display_supports_cursor_alpha() and gdk_display_supports_cursor_color() can be used to determine whether RGBA cursors are supported; gdk_display_get_default_cursor_size() and gdk_display_get_maximal_cursor_size() give information about cursor sizes. On the X backend, support for RGBA cursors requires a sufficently new version of the X Render extension.

a new #GdkCursor.

the #GdkDisplay for which the cursor will be created the #GdkPixbuf containing the cursor image the horizontal offset of the 'hotspot' of the cursor. the vertical offset of the 'hotspot' of the cursor. Creates a new cursor from a given pixmap and mask. Both the pixmap and mask must have a depth of 1 (i.e. each pixel has only 2 values - on or off). The standard cursor size is 16 by 16 pixels.

a new #GdkCursor.

the pixmap specifying the cursor. the pixmap specifying the mask, which must be the same size as the foreground color, used for the bits in the source which are 1. The color does not have to be allocated first. the background color, used for the bits in the source which are 0. The color does not have to be allocated first. the horizontal offset of the 'hotspot' of the cursor. the vertical offset of the 'hotspot' of the cursor. Returns the cursor type for this cursor.

a #GdkCursorType

Returns a #GdkPixbuf with the image used to display the cursor. Note that depending on the capabilities of the windowing system and on the cursor, GDK may not be able to obtain the image data. In this case, %NULL is returned.

a #GdkPixbuf representing @cursor, or %NULL

Adds a reference to @cursor.

Same @cursor that was passed in

Removes a reference from @cursor, deallocating the cursor if no references remain.

Frees an array of #GdkTimeCoord that was returned by gdk_device_get_history().

an array of #GdkTimeCoord. the length of the array. Returns the core pointer device for the default display. display and should not be freed. gdk_event_get_device() if a #GdkEvent with pointer device information is available.

the core pointer device; this is owned by the

Determines information about the current keyboard grab. This is not public API and must not be used by applications. keyboard grabbed.

%TRUE if this application currently has the

the display for which to get the grab information device to get the grab information from location to store current grab window location to store boolean indicating whether the @owner_events flag to gdk_keyboard_grab() or gdk_pointer_grab() was %TRUE. Returns the associated device to @device, if @device is of type %GDK_DEVICE_TYPE_MASTER, it will return the paired pointer or keyboard. If @device is of type %GDK_DEVICE_TYPE_SLAVE, it will return the master device to which @device is attached to. If @device is of type %GDK_DEVICE_TYPE_FLOATING, %NULL will be returned, as there is no associated device.

The associated device, or %NULL

Interprets an array of double as axis values for a given device, and locates the value in the array for a given axis use.

%TRUE if the given axis use was found, otherwise %FALSE

pointer to an array of axes the use to look for location to store the found value. Returns the axis use for @index_.

a #GdkAxisUse specifying how the axis is used.

the index of the axis. Interprets an array of double as axis values for a given device, and locates the value in the array for a given axis label, as returned by gdk_device_list_axes()

%TRUE if the given axis use was found, otherwise %FALSE.

pointer to an array of axes #GdkAtom with the axis label. location to store the found value. Returns the device type for @device.

the #GdkDeviceType for @device.

Returns the #GdkDisplay to which @device pertains. and must not be freed or unreffed.

a #GdkDisplay. This memory is owned by GTK+,

Determines whether the pointer follows device motion.

%TRUE if the pointer follows device motion

Obtains the motion history for a device; given a starting and ending timestamp, return all events in the motion history for the device in the given range of time. Some windowing systems do not support motion history, in which case, %FALSE will be returned. (This is not distinguishable from the case where motion history is supported and no events were found.) at least one event was found.

%TRUE if the windowing system supports motion history and

the window with respect to which which the event coordinates will be reported starting timestamp for range of events to return ending timestamp for the range of events to return location to store a newly-allocated array of #GdkTimeCoord, or %NULL location to store the length of @events, or %NULL If @index_ has a valid keyval, this function will return %TRUE and fill in @keyval and @modifiers with the keyval settings.

%TRUE if keyval is set for @index.

the index of the macro button to get. return value for the keyval. return value for modifiers. Determines the mode of the device.

a #GdkInputSource

Returns the number of axes the device currently has.

the number of axes.

Determines the name of the device.

a name

Determines the type of the device.

a #GdkInputSource

Gets the current state of a device relative to @window.

a #GdkWindow. an array of doubles to store the values of the axes of @device in, or %NULL. location to store the modifiers, or %NULL. Grabs the device so that all events coming from this device are passed to this application until the device is ungrabbed with gdk_device_ungrab(), or the window becomes unviewable. This overrides any previous grab on the device by this client. Device grabs are used for operations which need complete control over the given device events (either pointer or keyboard). For example in GTK+ this is used for Drag and Drop operations, popup menus and such. Note that if the event mask of an X window has selected both button press and button release events, then a button press event will cause an automatic pointer grab until the button is released. X does this automatically since most applications expect to receive button press and release events in pairs. It is equivalent to a pointer grab on the window with @owner_events set to %TRUE. If you set up anything at the time you take the grab that needs to be cleaned up when the grab ends, you should handle the #GdkEventGrabBroken events that are emitted when the grab ends unvoluntarily.

%GDK_GRAB_SUCCESS if the grab was successful.

the #GdkWindow which will own the grab (the grab window) specifies the grab ownership. if %FALSE then all device events are reported with respect to %TRUE then pointer events for this application are reported as normal, but pointer events outside this application are reported with respect to @window and only if selected by specifies the event mask, which is used in accordance with the cursor to display while the grab is active if the device is a pointer. If this is %NULL then the normal cursors are used for elsewhere. the timestamp of the event which led to this pointer grab. This usually comes from the #GdkEvent struct, though %GDK_CURRENT_TIME can be used if the time isn't known. Returns a #GList of #GdkAtoms, containing the labels for the axes that @device currently has. A #GList of #GdkAtoms, free with g_list_free().

Specifies how an axis of a device is used.

the index of the axis specifies how the axis is used Specifies the X key event to generate when a macro button of a device is pressed.

the index of the macro button to set the keyval to generate the modifiers to set Sets a the mode of an input device. The mode controls if the device is active and whether the device's range is mapped to the entire screen or to a single window.

%TRUE if the mode was successfully changed.

the input mode. Sets the source type for an input device.

the source type. Release any grab on @device.

a timestap (e.g. %GDK_CURRENT_TIME). Associated pointer or keyboard with this device, if any. Devices of type #GDK_DEVICE_TYPE_MASTER always come in keyboard/pointer pairs. Other device types will have a %NULL associated device. The #GdkDeviceManager the #GdkDevice pertains to. The #GdkDisplay the #GdkDevice pertains to. Whether the device is represented by a cursor on the screen. Devices of type %GDK_DEVICE_TYPE_MASTER will have %TRUE here. Input mode for the device. Source type for the device. Number of axes in the device. The device name. Device role in the device manager. The <structname>GdkDeviceAxis</structname> structure contains information about the range and mapping of a device axis. The <structname>GdkDeviceKey</structname> structure contains information about the mapping of one device macro button onto a normal X key event.

Returns the client pointer, that is, the master pointer that acts as the core pointer for this application. In X11, window managers may change this depending on the interaction pattern under the presence of several pointers. You should use this function sheldomly, only in code that isn't triggered by a #GdkEvent and there aren't other means to get a meaningful #GdkDevice to operate on.

The client pointer.

Returns the list of devices of type @type currently attached to #GdkDevices. The returned list must be freed with g_list_free (). The list elements are owned by GTK+ and must not be freed or unreffed.

a list of

device type to get.

The client pointer.

Gets the #GdkDisplay associated to @device_manager. associated to, or #NULL.

the #GdkDisplay to which @device_manager is

a list of

device type to get. The ::device-added signal is emitted either when a new master pointer is created, or when a slave (Hardware) input device is plugged in.

the newly added #GdkDevice. The ::device-changed signal is emitted either when some #GdkDevice has changed the number of either axes or keys. For example In X this will normally happen when the slave device routing events through the master device changes, in that case the master device will change to reflect the new slave device axes and keys.

the #GdkDevice that changed. The ::device-removed signal is emitted either when a master pointer is removed, or when a slave (Hardware) input device is unplugged.

the just removed #GdkDevice.

a list of

device type to get.

The client pointer.

Indicates the device type. See <link linkend="GdkDeviceManager.description">above</link> for more information about the meaning of these device types. Gets the default #GdkDisplay. This is a convenience function for <literal>gdk_display_manager_get_default_display (gdk_display_manager_get ())</literal>. display.

a #GdkDisplay, or %NULL if there is no default

Opens a display.

a #GdkDisplay, or %NULL if the display could not be opened.

the name of the display to open Opens the default display specified by command line arguments or environment variables, sets it as the default display, and returns it. gdk_parse_args must have been called first. If the default display has previously been set, simply returns that. An internal function that should not be used by applications. otherwise %NULL.

the default display, if it could be opened,

Get the default #GdkScreen for @display.

the default #GdkScreen object for @display

Gets the number of screen managed by the @display.

number of screens.

Returns a screen object for one of the screens of the display.

the #GdkScreen object

the screen number

Adds a filter to be called when X ClientMessage events are received. See gdk_window_add_filter() if you are interested in filtering other types of events.

the type of ClientMessage events to receive. This will be checked against the @message_type field of the XClientMessage event struct. the function to call to process the event. user data to pass to @func. Emits a short beep on @display

Closes the connection to the windowing system for the given display, and cleans up associated resources.

Returns %TRUE if there is an ongoing grab on @device for @display.

%TRUE if there is a grab in effect for @device.

a #GdkDevice Flushes any requests queued for the windowing system; this happens automatically when the main loop blocks waiting for new events, but if your application is drawing without returning control to the main loop, you may need to call this function explicitely. A common case where this function needs to be called is when an application is executing drawing commands from a thread other than the thread where the main loop is running. This is most useful for X11. On windowing systems where requests are handled synchronously, this function will do nothing.

Returns the core pointer device for the given display display and should not be freed. gdk_event_get_device() if a #GdkEvent with device information is available.

the core pointer device; this is owned by the

Returns the default size to use for cursors on @display.

the default cursor size.

Returns the default group leader window for all toplevel windows on @display. This window is implicitly created by GDK. See gdk_window_set_group().

The default group leader window for @display

Get the default #GdkScreen for @display.

the default #GdkScreen object for @display

Returns the #GdkDeviceManager associated to @display. owned by GDK and must not be freed or unreferenced.

A #GdkDeviceManager, or %NULL. This memory is

Gets the current location and state of @device for a given display.

device to query status to. location to store the #GdkScreen the @device is on, or %NULL. location to store root window X coordinate of @device, or %NULL. location to store root window Y coordinate of @device, or %NULL. location to store current modifier mask for @device, or %NULL. Gets the next #GdkEvent to be processed for @display, fetching events from the windowing system if necessary. are pending. The returned #GdkEvent should be freed with gdk_event_free().

the next #GdkEvent to be processed, or %NULL if no events

Gets the maximal size to use for cursors on @display.

the return location for the maximal cursor width the return location for the maximal cursor height Gets the number of screen managed by the @display.

number of screens.

Gets the name of the display. by GDK and should not be modified or freed.

a string representing the display name. This string is owned

Gets the current location of the pointer and the current modifier mask for a given display.

location to store the screen that the cursor is on, or %NULL. location to store root window X coordinate of pointer, or %NULL. location to store root window Y coordinate of pointer, or %NULL. location to store current modifier mask, or %NULL Returns a screen object for one of the screens of the display.

the #GdkScreen object

the screen number Obtains the window underneath @device, returning the location of the device in @win_x and @win_y. Returns %NULL if the window tree under @device is not known to GDK (for example, belongs to another application).

the #GdkWindow under the device position, or %NULL.

#GdkDevice to query info to. return location for the X coordinate of the device location, relative to the window origin, or %NULL. return location for the Y coordinate of the device location, relative to the window origin, or %NULL. Obtains the window underneath the mouse pointer, returning the location of the pointer in that window in @win_x, @win_y for @screen. Returns %NULL if the window under the mouse pointer is not known to GDK (for example, belongs to another application).

the window under the mouse pointer, or %NULL

return location for x coordinate of the pointer location relative to the window origin, or %NULL return location for y coordinate of the pointer location relative Finds out if the display has been closed.

%TRUE if the display is closed.

Release any keyboard grab instead.

a timestap (e.g #GDK_CURRENT_TIME). Returns the list of available input devices attached to @display. The list is statically allocated and should not be freed. a list of #GdkDevice

Gets a copy of the first #GdkEvent in the @display's event queue, without removing the event from the queue. (Note that this function will not get more events from the windowing system. It only checks the events that have already been moved to the GDK event queue.) if no events are in the queue. The returned #GdkEvent should be freed with gdk_event_free().

a copy of the first #GdkEvent on the event queue, or %NULL

Test if the pointer is grabbed.

%TRUE if an active X pointer grab is in effect

Release any pointer grab. instead.

a timestap (e.g. %GDK_CURRENT_TIME). Appends a copy of the given event onto the front of the event queue for @display.

a #GdkEvent. Request #GdkEventOwnerChange events for ownership changes of the selection named by the given atom. be sent.

whether #GdkEventOwnerChange events will

the #GdkAtom naming the selection for which ownership change notification is requested This function allows for hooking into the operation of getting the current location of any #GdkDevice on a particular #GdkDisplay. This is only useful for such low-level tools as an event recorder. Applications should never have any reason to use this facility.

The previous device hook table.

a table of pointers to functions for getting quantities related to all devices position, or %NULL to restore the default table. Sets the double click distance (two clicks within this distance count as a double click and result in a #GDK_2BUTTON_PRESS event). See also gdk_display_set_double_click_time(). Applications should <emphasis>not</emphasis> set this, it is a global user-configured setting.

distance in pixels Sets the double click time (two clicks within this time interval count as a double click and result in a #GDK_2BUTTON_PRESS event). Applications should <emphasis>not</emphasis> set this, it is a global user-configured setting.

double click time in milliseconds (thousandths of a second) This function allows for hooking into the operation of getting the current location of the pointer on a particular display. This is only useful for such low-level tools as an event recorder. Applications should never have any reason to use this facility.

the previous pointer hook table

a table of pointers to functions for getting quantities related to the current pointer position, or %NULL to restore the default table.

Returns %TRUE if gdk_window_set_composited() can be used to redirect drawing on the window using compositing. Currently this only works on X11 with XComposite and XDamage extensions available.

%TRUE if windows may be composited.

Returns %TRUE if cursors can use an 8bit alpha channel on @display. Otherwise, cursors are restricted to bilevel alpha (i.e. a mask).

whether cursors can have alpha channels.

Returns %TRUE if multicolored cursors are supported on @display. Otherwise, cursors have only a forground and a background color.

whether cursors can have multiple colors.

Returns %TRUE if gdk_window_input_shape_combine_mask() can be used to modify the input shape of windows on @display.

%TRUE if windows with modified input shape are supported

Returns whether #GdkEventOwnerChange events will be sent when the owner of a selection changes. be sent.

whether #GdkEventOwnerChange events will

Returns %TRUE if gdk_window_shape_combine_mask() can be used to create shaped windows on @display.

%TRUE if shaped windows are supported

Flushes any requests queued for the windowing system and waits until all requests have been handled. This is often used for making sure that the display is synchronized with the current state of the program. Calling gdk_display_sync() before gdk_error_trap_pop() makes sure that any errors generated from earlier requests are handled before the error trap is removed. This is most useful for X11. On windowing systems where requests are handled synchronously, this function will do nothing.

Warps @device in @display to the point @x,@y on the screen @screen, unless the device is confined to a window by a grab, in which case it will be moved as far as allowed by the grab. Warping the pointer creates events as if the user had moved the mouse instantaneously to the destination. Note that the pointer should normally be under the control of the user. This function was added to cover some rare use cases like keyboard navigation support for the color picker in the #GtkColorSelectionDialog.

a #GdkDevice. the screen of @display to warp @device to. the X coordinate of the destination. the Y coordinate of the destination. Warps the pointer of @display to the point @x,@y on the screen @screen, unless the pointer is confined to a window by a grab, in which case it will be moved as far as allowed by the grab. Warping the pointer creates events as if the user had moved the mouse instantaneously to the destination. Note that the pointer should normally be under the control of the user. This function was added to cover some rare use cases like keyboard navigation support for the color picker in the #GtkColorSelectionDialog.

the screen of @display to warp the pointer to the x coordinate of the destination the y coordinate of the destination The ::closed signal is emitted when the connection to the windowing system for @display is closed.

%TRUE if the display was closed due to an error The ::opened signal is emitted when the connection to the windowing system for @display is opened.

number of screens.

the #GdkScreen object

the screen number

the default #GdkScreen object for @display

A table of pointers to functions for getting quantities related to the current device position. Each #GdkDisplay has a table of this type, which can be set using gdk_display_set_device_hooks().

Gets the singleton #GdkDisplayManager object. gdk_init(), or gdk_init_check() must have been called first.

The global #GdkDisplayManager singleton; gdk_parse_pargs(),

Gets the default #GdkDisplay. display.

a #GdkDisplay, or %NULL if there is no default

List all currently open displays. #GSList of #GdkDisplay objects. Free this list with g_slist_free() when you are done with it.

a newly allocated

Sets @display as the default display.

a #GdkDisplay The ::display_opened signal is emitted when a display is opened.

the opened display

Used in #GdkDragContext to indicate what the destination should do with the dropped data. Creates a new #GdkDragContext.

the newly created #GdkDragContext.

Determines the bitmask of actions proposed by the source if gdk_drag_context_suggested_action() returns GDK_ACTION_ASK.

the #GdkDragAction flags

Returns the #GdkDevice associated to the drag context.

The #GdkDevice associated to @context.

Determines the action chosen by the drag destination.

a #GdkDragAction value

Returns the #GdkWindow where the DND operation started.

a #GdkWindow

Determines the suggested drag action of the context.

a #GdkDragAction value

Retrieves the list of targets of the context.

a #GList of targets

Associates a #GdkDevice to @context, so all Drag and Drop events for @context are emitted as if they came from this device.

a #GdkDevice Used in #GdkDragContext to indicate the protocol according to which DND is done.

Computes the region of a drawable that potentially can be written to by drawing primitives. This region will not take into account the clip region for the GC, and may also not take into account other factors such as if the window is obscured by other windows, but no area outside of this region will be affected by drawing primitives. when you are done.

a #cairo_region_t. This must be freed with cairo_region_destroy()

Gets the colormap for @drawable, if one is set; returns %NULL otherwise.

the colormap, or %NULL

Obtains the bit depth of the drawable, that is, the number of bits that make up a pixel in the drawable's visual. Examples are 8 bits per pixel, 24 bits per pixel, etc.

number of bits per pixel

Gets the #GdkScreen associated with a #GdkDrawable.

the #GdkScreen associated with @drawable

Fills *@width and *@height with the size of @drawable. On the X11 platform, if @drawable is a #GdkWindow, the returned size is the size reported in the most-recently-processed configure event, rather than the current size on the X server.

location to store drawable's width, or %NULL location to store drawable's height, or %NULL

Computes the region of a drawable that is potentially visible. This does not necessarily take into account if the window is obscured by other windows, but no area outside of this region is visible. when you are done.

a #cairo_region_t. This must be freed with cairo_region_destroy()

Gets the #GdkVisual describing the pixel format of @drawable.

a #GdkVisual

Sets the colormap associated with @drawable. Normally this will happen automatically when the drawable is created; you only need to use this function if the drawable-creating function did not have a way to determine the colormap, and you then use drawable operations that require a colormap. The colormap for all drawables and graphics contexts you intend to use together should match.

a #cairo_region_t. This must be freed with cairo_region_destroy()

Gets the colormap for @drawable, if one is set; returns %NULL otherwise.

the colormap, or %NULL

Obtains the bit depth of the drawable, that is, the number of bits that make up a pixel in the drawable's visual. Examples are 8 bits per pixel, 24 bits per pixel, etc.

number of bits per pixel

Gets the #GdkDisplay associated with a #GdkDrawable.

the #GdkDisplay associated with @drawable

Gets the #GdkScreen associated with a #GdkDrawable.

the #GdkScreen associated with @drawable

location to store drawable's width, or %NULL location to store drawable's height, or %NULL Computes the region of a drawable that is potentially visible. This does not necessarily take into account if the window is obscured by other windows, but no area outside of this region is visible. when you are done.

a #cairo_region_t. This must be freed with cairo_region_destroy()

Gets the #GdkVisual describing the pixel format of @drawable.

a #GdkVisual

a #GdkColormap

number of bits per pixel

location to store drawable's width, or %NULL location to store drawable's height, or %NULL

the colormap, or %NULL

a #GdkVisual

the #GdkScreen associated with @drawable

a #cairo_region_t. This must be freed with cairo_region_destroy()

Creates a new event of the given type. All fields are set to 0. should be freed with gdk_event_free().

a newly-allocated #GdkEvent. The returned #GdkEvent

a #GdkEventType If both events contain X/Y information, this function will return %TRUE and return in @angle the relative angle from @event1 to @event2. The rotation direction for positive angles is from the positive X axis towards the positive Y axis.

%TRUE if the angle could be calculated.

second #GdkEvent return location for the relative angle between both events If both events contain X/Y information, the center of both coordinates will be returned in @x and @y.

%TRUE if the center could be calculated.

second #GdkEvent return location for the X coordinate of the center return location for the Y coordinate of the center If both events have X/Y information, the distance between both coordinates (as in a straight line going from @event1 to @event2) will be returned.

%TRUE if the distance could be calculated.

second #GdkEvent return location for the distance Copies a #GdkEvent, copying or incrementing the reference count of the resources associated with it (e.g. #GdkWindow's and strings). gdk_event_free().

a copy of @event. The returned #GdkEvent should be freed with

Frees a #GdkEvent, freeing or decrementing any resources associated with it. Note that this function should only be called with events returned from functions such as gdk_event_peek(), gdk_event_get(), gdk_event_copy() and gdk_event_new().

Extract the axis value for a particular axis use from an event structure.

%TRUE if the specified axis was found, otherwise %FALSE

the axis use to look for location to store the value found Extract the event window relative x/y coordinates from an event.

%TRUE if the event delivered event window coordinates

location to put event window x coordinate location to put event window y coordinate If the event contains a "device" field, this function will return it, else it will return %NULL.

a #GdkDevice, or %NULL.

Extract the root window relative x/y coordinates from an event.

%TRUE if the event delivered root window coordinates

location to put root window x coordinate location to put root window y coordinate Returns the screen for the event. The screen is typically the screen for <literal>event->any.window</literal>, but for events such as mouse events, it is the screen where the pointer was when the event occurs - that is, the screen which has the root window to which <literal>event->motion.x_root</literal> and <literal>event->motion.y_root</literal> are relative.

the screen for the event

If the event contains a "state" field, puts that field in @state. Otherwise stores an empty state (0). Returns %TRUE if there was a state field in the event. @event may be %NULL, in which case it's treated as if the event had no state field.

%TRUE if there was a state field in the event

return location for state Returns the time stamp from @event, if there is one; otherwise returns #GDK_CURRENT_TIME. If @event is %NULL, returns #GDK_CURRENT_TIME.

time stamp field from @event

Appends a copy of the given event onto the front of the event queue for event->any.window's display, or the default event queue if event->any.window is %NULL. See gdk_display_put_event().

Sends an X ClientMessage event to a given window (which must be on the default #GdkDisplay.) This could be used for communicating between different applications, though the amount of data is limited to 20 bytes.

non-zero on success.

the window to send the X ClientMessage event to. Sends an X ClientMessage event to all toplevel windows on the default #GdkScreen. Toplevel windows are determined by checking for the WM_STATE property, as described in the Inter-Client Communication Conventions Manual (ICCCM). If no windows are found with the WM_STATE property set, the message is sent to all children of the root window.

Sets the device for @event to @device. The event must have been allocated by GTK+, for instance, by gdk_event_copy().

a #GdkDevice Sets the screen for @event to @screen. The event must have been allocated by GTK+, for instance, by gdk_event_copy().

a #GdkScreen

An enumeration used to specify which extension events are desired for a particular widget. Specifies the type of function used to filter native events before they are converted to GDK events. When a filter is called, @event is unpopulated, except for <literal>event->window</literal>. The filter may translate the native event to a GDK event and store the result in @event, or handle it without translation. If the filter translates the event and processing should continue, it should return %GDK_FILTER_TRANSLATE.

a #GdkFilterReturn value.

the native event to filter. the GDK event to which the X event will be translated. user data set when the filter was installed. Specifies the result of applying a #GdkFilterFunc to a native event. The #GdkGeometry struct gives the window manager information about a window's geometry constraints. Normally you would set these on the GTK+ level using gtk_window_set_geometry_hints(). #GtkWindow then sets the hints on the #GdkWindow it creates. gdk_window_set_geometry_hints() expects the hints to be fully valid already and simply passes them to the window manager; in contrast, gtk_window_set_geometry_hints() performs some interpretation. For example, #GtkWindow will apply the hints to the geometry widget instead of the toplevel window, if you set a geometry widget. Also, the #GtkWindow will substitute the size request of the window or geometry widget. If the minimum size hint is not provided, #GtkWindow will use its requisition as the minimum size. If the minimum size is provided and a geometry widget is set, #GtkWindow will take the minimum size as the minimum size of the geometry widget rather than the entire window. The base size is treated similarly. The canonical use-case for gtk_window_set_geometry_hints() is to get a terminal widget to resize properly. Here, the terminal text area should be the geometry widget; #GtkWindow will then automatically set the base size to the size of other widgets in the terminal window, such as the menubar and scrollbar. Then, the @width_inc and @height_inc fields should be set to the size of one character in the terminal. Finally, the base size should be set to the size of one character. The net effect is that the minimum size of the terminal will have a 1x1 character terminal area, and only terminal sizes on the "character grid" will be allowed. Here's an example of how the terminal example would be implemented, assuming a terminal area widget called "terminal" and a toplevel window "toplevel": <informalexample><programlisting><![CDATA[ GdkGeometry hints; hints.base_width = terminal->char_width; hints.base_height = terminal->char_height; hints.min_width = terminal->char_width; hints.min_height = terminal->char_height; hints.width_inc = terminal->char_width; hints.height_inc = terminal->char_height; gtk_window_set_geometry_hints (GTK_WINDOW (toplevel), GTK_WIDGET (terminal), &hints, GDK_HINT_RESIZE_INC | GDK_HINT_MIN_SIZE | GDK_HINT_BASE_SIZE); ]]></programlisting></informalexample> The other useful fields are the @min_aspect and @max_aspect fields; these contain a width/height ratio as a floating point number. If a geometry widget is set, the aspect applies to the geometry widget rather than the entire window. The most common use of these hints is probably to set @min_aspect and aspect ratio. Defines how device grabs interact with other devices. Defines the reference point of a window and the meaning of coordinates passed to gtk_window_move(). See gtk_window_move() and the "implementation notes" section of the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink> specification for more details. An enumeration that describes the mode of an input device. An enumeration describing the type of an input device in general terms.

Adds virtual modifiers (i.e. Super, Hyper and Meta) which correspond to the real modifiers (i.e Mod2, Mod3, ...) in @modifiers. are set in @state to their non-virtual counterparts (i.e. Mod2, Mod3,...) and set the corresponding bits in @state. GDK already does this before delivering key events, but for compatibility reasons, it only sets the first virtual modifier it finds, whereas this function sets all matching virtual modifiers. This function is useful when matching key events against accelerators.

pointer to the modifier mask to change Returns whether the Caps Lock modifer is locked.

%TRUE if Caps Lock is on

Returns the keyvals bound to @hardware_keycode. The Nth #GdkKeymapKey in @keys is bound to the Nth keyval in @keyvals. Free the returned arrays with g_free(). When a keycode is pressed by the user, the keyval from this list of entries is selected by considering the effective keyboard group and level. See gdk_keymap_translate_keyboard_state().

%TRUE if there were any entries

a keycode return location for array of #GdkKeymapKey, or %NULL return location for array of keyvals, or %NULL length of @keys and @keyvals Obtains a list of keycode/group/level combinations that will generate @keyval. Groups and levels are two kinds of keyboard mode; in general, the level determines whether the top or bottom symbol on a key is used, and the group determines whether the left or right symbol is used. On US keyboards, the shift key changes the keyboard level, and there are no groups. A group switch key might convert a keyboard between Hebrew to English modes, for example. #GdkEventKey contains a %group field that indicates the active keyboard group. The level is computed from the modifier mask. The returned array should be freed with g_free().

%TRUE if keys were found and returned

a keyval, such as %GDK_a, %GDK_Up, %GDK_Return, etc. return location for an array of #GdkKeymapKey return location for number of elements in returned array Returns whether the Num Lock modifer is locked.

%TRUE if Num Lock is on

Looks up the keyval mapped to a keycode/group/level triplet. If no keyval is bound to @key, returns 0. For normal user input, you want to use gdk_keymap_translate_keyboard_state() instead of this function, since the effective group/level may not be the same as the current keyboard state.

a keyval, or 0 if none was mapped to the given @key

a #GdkKeymapKey with keycode, group, and level initialized Maps the virtual modifiers (i.e. Super, Hyper and Meta) which are set in @state to their non-virtual counterparts (i.e. Mod2, Mod3,...) and set the corresponding bits in @state. This function is useful when matching key events against accelerators. same non-virtual modifier. Note that %FALSE is also returned if a virtual modifier is mapped to a non-virtual modifier that was already set in @state.

%TRUE if no virtual modifiers were mapped to the

pointer to the modifier state to map Translates the contents of a #GdkEventKey into a keyval, effective group, and level. Modifiers that affected the translation and are thus unavailable for application use are returned in groups and levels. The @effective_group is the group that was actually used for the translation; some keys such as Enter are not affected by the active keyboard group. The @level is derived from keyval, so this function isn't as useful as you might think. <note><para> from @state when comparing this key press to a hot key. For instance, on a US keyboard, the <literal>plus</literal> symbol is shifted, so when comparing a key press to a <literal><Control>plus</literal> accelerator <Shift> should be masked out. </para> <informalexample><programlisting> /* We want to ignore irrelevant modifiers like ScrollLock */ &num;define ALL_ACCELS_MASK (GDK_CONTROL_MASK | GDK_SHIFT_MASK | GDK_MOD1_MASK) gdk_keymap_translate_keyboard_state (keymap, event->hardware_keycode, event->state, event->group, &keyval, NULL, NULL, &consumed); if (keyval == GDK_PLUS && (event->state & ~consumed & ALL_ACCELS_MASK) == GDK_CONTROL_MASK) /* Control was pressed */ </programlisting></informalexample> <para> An older interpretation @consumed_modifiers was that it contained all modifiers that might affect the translation of the key; this allowed accelerators to be stored with irrelevant consumed modifiers, by doing:</para> <informalexample><programlisting> /* XXX Don't do this XXX */ if (keyval == accel_keyval && (event->state & ~consumed & ALL_ACCELS_MASK) == (accel_mods & ~consumed)) /* Accelerator was pressed */ </programlisting></informalexample> <para> However, this did not work if multi-modifier combinations were used in the keymap, since, for instance, <literal><Control></literal> would be masked out even if only <literal><Control><Alt></literal> was used in the keymap. To support this usage as well as well as possible, all <emphasis>single modifier</emphasis> combinations that could affect the key for any combination of modifiers will be returned in @consumed_modifiers; multi-modifier combinations are returned only when actually found in @state. When you store accelerators, you should always store them with consumed modifiers removed. Store <literal><Control>plus</literal>, not <literal><Control><Shift>plus</literal>, </para></note>

%TRUE if there was a keyval bound to the keycode/state/group

a keycode a modifier state active keyboard group return location for keyval, or %NULL return location for effective group, or %NULL return location for level, or %NULL return location for modifiers that were used to determine the group or level, or %NULL The ::direction-changed signal gets emitted when the direction of the keymap changes.

The ::keys-changed signal is emitted when the mapping represented by

The ::state-changed signal is emitted when the state of the keyboard changes, e.g when Caps Lock is turned on or off. See gdk_keymap_get_caps_lock_state().

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. Since 2.10, GDK recognizes which of the Meta, Super or Hyper keys are mapped to Mod2 - Mod5, and indicates this by setting %GDK_SUPER_MASK, %GDK_HYPER_MASK or %GDK_META_MASK in the state field of key events. Wraps a native window for the default display in a #GdkPixmap. This may fail if the pixmap has been destroyed. For example in the X backend, a native pixmap handle is an Xlib <type>XID</type>. native pixmap or %NULL if the pixmap has been destroyed.

the newly-created #GdkPixmap wrapper for the

a native pixmap handle. Wraps a native pixmap in a #GdkPixmap. This may fail if the pixmap has been destroyed. For example in the X backend, a native pixmap handle is an Xlib <type>XID</type>. native pixmap or %NULL if the pixmap has been destroyed.

the newly-created #GdkPixmap wrapper for the

The #GdkDisplay where @anid is located. a native pixmap handle. Wraps a native pixmap in a #GdkPixmap. This may fail if the pixmap has been destroyed. For example in the X backend, a native pixmap handle is an Xlib <type>XID</type>. This function is an alternative to gdk_pixmap_foreign_new_for_display() for cases where the dimensions of the pixmap are known. For the X backend, this avoids a roundtrip to the server. native pixmap or %NULL if the pixmap has been destroyed.

the newly-created #GdkPixmap wrapper for the

a #GdkScreen a native pixmap handle the width of the pixmap identified by @anid the height of the pixmap identified by @anid the depth of the pixmap identified by @anid

Looks up the #GdkPixmap that wraps the given native pixmap handle. For example in the X backend, a native pixmap handle is an Xlib <type>XID</type>. or %NULL if there is none.

the #GdkPixmap wrapper for the native pixmap,

a native pixmap handle. Looks up the #GdkPixmap that wraps the given native pixmap handle. For example in the X backend, a native pixmap handle is an Xlib <type>XID</type>. or %NULL if there is none.

the #GdkPixmap wrapper for the native pixmap,

the #GdkDisplay associated with @anid a native pixmap handle. A table of pointers to functions for getting quantities related to the current pointer position. GDK has one global table of this type, which can be set using gdk_set_pointer_hooks(). This is only useful for such low-level tools as an event recorder. Applications should never have any reason to use this facility

Gets the default screen for the default display. (See gdk_display_get_default ()).

a #GdkScreen, or %NULL if there is no default display.

Returns the height of the default screen in pixels.

the height of the default screen in pixels.

Returns the height of the default screen in millimeters. Note that on many X servers this value will not be correct. though it is not always correct.

the height of the default screen in millimeters,

Returns the width of the default screen in pixels.

the width of the default screen in pixels.

Returns the width of the default screen in millimeters. Note that on many X servers this value will not be correct. though it is not always correct.

the width of the default screen in millimeters,

On X11, sends an X ClientMessage event to all toplevel windows on Toplevel windows are determined by checking for the WM_STATE property, as described in the Inter-Client Communication Conventions Manual (ICCCM). If no windows are found with the WM_STATE property set, the message is sent to all children of the root window. On Windows, broadcasts a message registered with the name GDK_WIN32_CLIENT_MESSAGE to all top-level windows. The amount of data is limited to one long, i.e. four bytes.

the #GdkEvent.

Gets the default colormap for @screen.

the default #GdkColormap.

Gets the display to which the @screen belongs.

the display to which @screen belongs

Gets any options previously set with gdk_screen_set_font_options(). font options have been set.

the current font options, or %NULL if no default

Gets the height of @screen in pixels

the height of @screen in pixels.

Returns the height of @screen in millimeters. Note that on some X servers this value will not be correct.

the heigth of @screen in millimeters.

Returns the monitor number in which the point (@x,@y) is located. a monitor close to (@x,@y) if the point is not in any monitor.

the monitor number in which the point (@x,@y) lies, or

the x coordinate in the virtual screen. the y coordinate in the virtual screen. Returns the number of the monitor in which the largest area of the bounding rectangle of @window resides.

the monitor number in which most of @window is located, or if @window does not intersect any monitors, a monitor, close to @window.

a #GdkWindow Retrieves the #GdkRectangle representing the size and position of the individual monitor within the entire screen area. Note that the size of the entire screen area can be retrieved via gdk_screen_get_width() and gdk_screen_get_height().

the monitor number, between 0 and gdk_screen_get_n_monitors (screen) a #GdkRectangle to be filled with the monitor geometry Gets the height in millimeters of the specified monitor.

the height of the monitor, or -1 if not available

number of the monitor, between 0 and gdk_screen_get_n_monitors (screen) Returns the output name of the specified monitor. Usually something like VGA, DVI, or TV, not the actual product name of the display device. or %NULL if the name cannot be determined

a newly-allocated string containing the name of the monitor,

number of the monitor, between 0 and gdk_screen_get_n_monitors (screen) Gets the width in millimeters of the specified monitor, if available.

the width of the monitor, or -1 if not available

number of the monitor, between 0 and gdk_screen_get_n_monitors (screen) Returns the number of monitors which @screen consists of.

number of monitors which @screen consists of

Gets the index of @screen among the screens in the display to which it belongs. (See gdk_screen_get_display())

the index

Gets the primary monitor for @screen. The primary monitor is considered the monitor where the 'main desktop' lives. While normal application windows typically allow the window manager to place the windows, specialized desktop applications such as panels should place themselves on the primary monitor. If no primary monitor is configured by the user, the return value will be 0, defaulting to the first monitor.

An integer index for the primary monitor, or 0 if none is configured.

Gets the resolution for font handling on the screen; see gdk_screen_set_resolution() for full details. has been set.

the current resolution, or -1 if no resolution

Gets a colormap to use for creating windows or pixmaps with an alpha channel. The windowing system on which GTK+ is running may not support this capability, in which case %NULL will be returned. Even if a non-%NULL value is returned, its possible that the window's alpha channel won't be honored X an appropriate windowing manager and compositing manager must be running to provide appropriate display. This functionality is not implemented in the Windows backend. For setting an overall opacity for a top-level window, see gdk_window_set_opacity(). an alpha channel or %NULL if the capability is not available.

a colormap to use for windows with

Gets a visual to use for creating windows or pixmaps with an alpha channel. See the docs for gdk_screen_get_rgba_colormap() for caveats. alpha channel or %NULL if the capability is not available.

a visual to use for windows with an

Gets the root window of @screen.

the root window

Retrieves a desktop-wide setting such as double-click time for the #GdkScreen @screen. FIXME needs a list of valid settings here, or a link to more information. in @value, %FALSE otherwise.

%TRUE if the setting existed and a value was stored

the name of the setting location to store the value of the setting Gets the system's default colormap for @screen

the default colormap for @screen.

Get the system's default visual for @screen. This is the visual for the root window of the display. The return value should not be freed.

the system visual

Obtains a list of all toplevel windows known to GDK on the screen @screen. A toplevel window is a child of the root window (see gdk_get_default_root_window()). The returned list should be freed with g_list_free(), but its elements need not be freed. list of toplevel windows, free with g_list_free()

Gets the width of @screen in pixels

the width of @screen in pixels.

Gets the width of @screen in millimeters. Note that on some X servers this value will not be correct.

the width of @screen in millimeters.

Returns a #GList of #GdkWindows representing the current window stack. On X11, this is done by inspecting the _NET_CLIENT_LIST_STACKING property on the root window, as described in the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink>. If the window manager does not support the _NET_CLIENT_LIST_STACKING hint, this function returns %NULL. On other platforms, this function may return %NULL, depending on whether it is implementable on that platform. The returned list is newly allocated and owns references to the windows it contains, so it should be freed using g_list_free() and its windows unrefed using g_object_unref() when no longer needed. a list of #GdkWindows for the current window stack, or %NULL.

Returns whether windows with an RGBA visual can reasonably be expected to have their alpha channel drawn correctly on the screen. On X11 this function returns whether a compositing manager is compositing @screen. expected to have their alpha channels drawn correctly on the screen.

Whether windows with RGBA visuals can reasonably be

Lists the available visuals for the specified @screen. A visual describes a hardware image data format. For example, a visual might support 24-bit color, or 8-bit color, and might expect pixels to be in a certain format. Call g_list_free() on the return value when you're finished with it. a list of visuals; the list must be freed, but not its contents

Determines the name to pass to gdk_display_open() to get a #GdkDisplay with this screen as the default screen.

a newly allocated string, free with g_free()

Sets the default @colormap for @screen.

a #GdkColormap Sets the default font options for the screen. These options will be set on any #PangoContext's newly created with gdk_pango_context_get_for_screen(). Changing the default set of font options does not affect contexts that have already been created.

a #cairo_font_options_t, or %NULL to unset any previously set default font options. Sets the resolution for font handling on the screen. This is a scale factor between points specified in a #PangoFontDescription and cairo units. The default value is 96, meaning that a 10 point font will be 13 units high. (10 * 96. / 72. = 13.3).

the resolution in "dots per inch". (Physical inches aren't actually involved; the terminology is conventional.) The ::composited-changed signal is emitted when the composited status of the screen changes

The ::monitors-changed signal is emitted when the number, size or position of the monitors attached to the screen change. Only for X11 and OS X for now. A future implementation for Win32 may be a possibility.

The ::size-changed signal is emitted when the pixel width or height of a screen changes.

The #GdkTimeCoord structure stores a single event in a motion history. Get the visual with the most available colors for the default GDK screen. The return value should not be freed.

best visual

Get the best available depth for the default GDK screen. "Best" means "largest," i.e. 32 preferred over 24 preferred over 8 bits per pixel.

best available depth

Return the best available visual type for the default GDK screen.

best visual type

Combines gdk_visual_get_best_with_depth() and gdk_visual_get_best_with_type().

best visual with both @depth and

a bit depth a visual type Get the best visual with depth @depth for the default GDK screen. Color visuals and visuals with mutable colormaps are preferred over grayscale or fixed-colormap visuals. The return value should not be freed. %NULL may be returned if no visual supports @depth.

best visual for the given depth

a bit depth Get the best visual of the given @visual_type for the default GDK screen. Visuals with higher color depths are considered better. The return value should not be freed. %NULL may be returned if no visual has type

best visual of the given type

a visual type Get the system's default visual for the default GDK screen. This is the visual for the root window of the display. The return value should not be freed.

system visual

Returns the number of significant bits per red, green and blue value.

The number of significant bits per color value for @visual.

Obtains values that are needed to calculate blue pixel values in TrueColor and DirectColor. The "mask" is the significant bits within the pixel. The "shift" is the number of bits left we must shift a primary for it to be in position (according to the "mask"). Finally, "precision" refers to how much precision the pixel value contains for a particular primary.

A pointer to a #guint32 to be filled in, or %NULL. A pointer to a #gint to be filled in, or %NULL. A pointer to a #gint to be filled in, or %NULL. Returns the byte order of this visual.

A #GdkByteOrder stating the byte order of @visual.

Returns the size of a colormap for this visual.

The size of a colormap that is suitable for @visual.

Returns the bit depth of this visual.

The bit depth of this visual.

Obtains values that are needed to calculate green pixel values in TrueColor and DirectColor. The "mask" is the significant bits within the pixel. The "shift" is the number of bits left we must shift a primary for it to be in position (according to the "mask"). Finally, "precision" refers to how much precision the pixel value contains for a particular primary.

A pointer to a #guint32 to be filled in, or %NULL. A pointer to a #gint to be filled in, or %NULL. A pointer to a #gint to be filled in, or %NULL. Obtains values that are needed to calculate red pixel values in TrueColor and DirectColor. The "mask" is the significant bits within the pixel. The "shift" is the number of bits left we must shift a primary for it to be in position (according to the "mask"). Finally, "precision" refers to how much precision the pixel value contains for a particular primary.

A pointer to a #guint32 to be filled in, or %NULL. A pointer to a #gint to be filled in, or %NULL. A pointer to a #gint to be filled in, or %NULL. Gets the screen to which this visual belongs

the screen to which this visual belongs.

Returns the type of visual this is (PseudoColor, TrueColor, etc).

A #GdkVisualType stating the type of @visual.

These are hints originally defined by the Motif toolkit. The window manager can use them when determining how to decorate the window. The hint must be set before mapping the window. These are hints originally defined by the Motif toolkit. The window manager can use them when determining the functions to offer for the window. The hint must be set before mapping the window. An opaque structure representing an onscreen drawable. Pointers to structures of type #GdkPixmap, #GdkBitmap, and #GdkWindow can often be used interchangeably. The type #GdkDrawable refers generically to any of these types. Adds an event filter to @window, allowing you to intercept events before they reach GDK. This is a low-level operation and makes it easy to break GDK and/or GTK+, so you have to know what you're doing. Pass %NULL for @window to get all events for all windows, instead of events for a specific window. See gdk_display_add_client_message_filter() if you are interested in X ClientMessage events.

filter callback data to pass to filter callback Emits a short beep associated to @window in the appropriate display, if supported. Otherwise, emits a short beep on the display just as gdk_display_beep().

Begins a window move operation (for a toplevel window). You might use this function to implement a "window move grip," for example. The function works best with window managers that support the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink>, but has a fallback implementation for other window managers.

the button being used to drag root window X coordinate of mouse click that began the drag root window Y coordinate of mouse click that began the drag timestamp of mouse click that began the drag A convenience wrapper around gdk_window_begin_paint_region() which creates a rectangular region for you. See gdk_window_begin_paint_region() for details.

rectangle you intend to draw to Indicates that you are beginning the process of redrawing @region. A backing store (offscreen buffer) large enough to contain @region will be created. The backing store will be initialized with the background color or background pixmap for @window. Then, all drawing operations performed on @window will be diverted to the backing store. When you call gdk_window_end_paint(), the backing store will be copied to @window, making it visible onscreen. Only the part of @window contained in @region will be modified; that is, drawing operations are clipped to @region. The net result of all this is to remove flicker, because the user sees the finished product appear all at once when you call gdk_window_end_paint(). If you draw to @window directly without calling gdk_window_begin_paint_region(), the user may see flicker as individual drawing operations are performed in sequence. The clipping and background-initializing features of gdk_window_begin_paint_region() are conveniences for the programmer, so you can avoid doing that work yourself. When using GTK+, the widget system automatically places calls to gdk_window_begin_paint_region() and gdk_window_end_paint() around emissions of the expose_event signal. That is, if you're writing an expose event handler, you can assume that the exposed area in #GdkEventExpose has already been cleared to the window background, is already set as the clip region, and already has a backing store. Therefore in most cases, application code need not call gdk_window_begin_paint_region(). (You can disable the automatic calls around expose events on a widget-by-widget basis by calling gtk_widget_set_double_buffered().) If you call this function multiple times before calling the matching gdk_window_end_paint(), the backing stores are pushed onto a stack. gdk_window_end_paint() copies the topmost backing store onscreen, subtracts the topmost region from all other regions in the stack, and pops the stack. All drawing operations affect only the topmost backing store in the stack. One matching call to gdk_window_end_paint() is required for each call to gdk_window_begin_paint_region().

region you intend to draw to Begins a window resize operation (for a toplevel window). You might use this function to implement a "window resize grip," for example; in fact #GtkStatusbar uses it. The function works best with window managers that support the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink>, but has a fallback implementation for other window managers.

the edge or corner from which the drag is started the button being used to drag root window X coordinate of mouse click that began the drag root window Y coordinate of mouse click that began the drag timestamp of mouse click that began the drag (use gdk_event_get_time()) Clears an entire @window to the background color or background pixmap.

Clears an area of @window to the background color or background pixmap.

x coordinate of rectangle to clear y coordinate of rectangle to clear width of rectangle to clear height of rectangle to clear Like gdk_window_clear_area(), but also generates an expose event for the cleared area. This function has a stupid name because it dates back to the mists time, pre-GDK-1.0.

x coordinate of rectangle to clear y coordinate of rectangle to clear width of rectangle to clear height of rectangle to clear Signal to the window system that the application has finished handling Configure events it has received. Window Managers can use this to better synchronize the frame repaint with the application. GTK+ applications will automatically call this function when appropriate. This function can only be called if gdk_window_enable_synchronized_configure() was called previously.

Transforms window coordinates from a parent window to a child window, where the parent window is the normal parent as returned by gdk_window_get_parent() for normal windows, and the window's embedder as returned by gdk_offscreen_window_get_embedder() for offscreen windows. For normal windows, calling this function is equivalent to subtracting the return values of gdk_window_get_position() from the parent coordinates. For offscreen windows however (which can be arbitrarily transformed), the coordinates. You should always use this function when writing generic code that walks down a window hierarchy.

X coordinate in parent's coordinate system Y coordinate in parent's coordinate system return location for X coordinate in child's coordinate system return location for Y coordinate in child's coordinate system Transforms window coordinates from a child window to its parent window, where the parent window is the normal parent as returned by gdk_window_get_parent() for normal windows, and the window's embedder as returned by gdk_offscreen_window_get_embedder() for offscreen windows. For normal windows, calling this function is equivalent to adding the return values of gdk_window_get_position() to the child coordinates. For offscreen windows however (which can be arbitrarily transformed), the coordinates. You should always use this function when writing generic code that walks up a window hierarchy.

X coordinate in child's coordinate system Y coordinate in child's coordinate system return location for X coordinate in parent's coordinate system, or %NULL return location for Y coordinate in parent's coordinate system, or %NULL Create a new surface that is as compatible as possible with the given @window. For example the new surface will have the same fallback resolution and font options as @window. Generally, the new surface will also use the same backend as @window, unless that is not possible for some reason. The type of the returned surface may be examined with cairo_surface_get_type(). Initially the surface contents are all 0 (transparent if contents have transparency, black otherwise.) owns the surface and should call cairo_surface_destroy() when done with it. This function always returns a valid pointer, but it will return a pointer to a "nil" surface if @other is already in an error state or any other error occurs.

a pointer to the newly allocated surface. The caller

the content for the new surface width of the new surface height of the new surface Attempt to deiconify (unminimize) @window. On X11 the window manager may choose to ignore the request to deiconify. When using GTK+, use gtk_window_deiconify() instead of the #GdkWindow variant. Or better yet, you probably want to use gtk_window_present(), which raises the window, focuses it, unminimizes it, and puts it on the current desktop.

Destroys the window system resources associated with @window and decrements @window's reference count. The window system resources for all children of @window are also destroyed, but the children's reference counts are not decremented. Note that a window will not be destroyed automatically when its reference count reaches zero. You must call this function yourself before that happens.

Indicates that the application will cooperate with the window system in synchronizing the window repaint with the window manager during resizing operations. After an application calls this function, it must call gdk_window_configure_finished() every time it has finished all processing associated with a set of Configure events. Toplevel GTK+ windows automatically use this protocol. On X, calling this function makes @window participate in the _NET_WM_SYNC_REQUEST window manager protocol.

Indicates that the backing store created by the most recent call to gdk_window_begin_paint_region() should be copied onscreen and deleted, leaving the next-most-recent backing store or no backing store at all as the active paint region. See gdk_window_begin_paint_region() for full details. It is an error to call this function without a matching gdk_window_begin_paint_region() first.

Tries to ensure that there is a window-system native window for this GdkWindow. This may fail in some situations, returning %FALSE. Offscreen window and children of them can never have native windows. Some backends may not support native child windows.

%TRUE if the window has a native window, %FALSE otherwise

Flush all outstanding cached operations on a window, leaving the window in a state which reflects all that has been drawn before. Gdk uses multiple kinds of caching to get better performance and nicer drawing. For instance, during exposes all paints to a window using double buffered rendering are keep on a pixmap until the last window has been exposed. It also delays window moves/scrolls until as long as possible until next update to avoid tearing when moving windows. Normally this should be completely invisible to applications, as we automatically flush the windows when required, but this might be needed if you for instance mix direct native drawing with gdk drawing. For Gtk widgets that don't use double buffering this will be called automatically before sending the expose event.

Sets keyboard focus to @window. In most cases, gtk_window_present() should be used on a #GtkWindow, rather than calling this function.

timestamp of the event triggering the window focus Temporarily freezes a window and all its descendants such that it won't receive expose events. The window will begin receiving expose events again when gdk_window_thaw_toplevel_updates_libgtk_only() is called. If gdk_window_freeze_toplevel_updates_libgtk_only() has been called more than once, gdk_window_thaw_toplevel_updates_libgtk_only() must be called an equal number of times to begin processing exposes. This function is not part of the GDK public API and is only for use by GTK+.

Temporarily freezes a window such that it won't receive expose events. The window will begin receiving expose events again when gdk_window_thaw_updates() is called. If gdk_window_freeze_updates() has been called more than once, gdk_window_thaw_updates() must be called an equal number of times to begin processing exposes.

Moves the window into fullscreen mode. This means the window covers the entire screen and is above any panels or task bars. If the window was already fullscreen, then this function does nothing. On X11, asks the window manager to put @window in a fullscreen state, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or don't have a concept of "fullscreen"; so you can't rely on the fullscreenification actually happening. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen.

This function informs GDK that the geometry of an embedded offscreen window has changed. This is necessary for GDK to keep track of which offscreen window the pointer is in.

Determines whether or not the desktop environment shuld be hinted that the window does not want to receive input focus.

whether or not the window should receive input focus.

Gets the pattern used to clear the background on @window. If @window does not have its own background and reuses the parent's, %NULL is returned and you'll have to query it yourself. parent's background.

The pattern to use for the background or %NULL to use the

Gets the list of children of @window known to GDK. This function only returns children created via GDK, so for example it's useless when used with the root window; it only returns windows an application created itself. The returned list must be freed, but the elements in the list need not be. list of child windows inside @window

Determines whether @window is composited. See gdk_window_set_composited().

%TRUE if the window is composited.

Retrieves a #GdkCursor pointer for the cursor currently set on the specified #GdkWindow, or %NULL. If the return value is %NULL then there is no custom cursor set on the specified window, and it is using the cursor for its parent window. by the #GdkWindow and should not be unreferenced directly. Use gdk_window_set_cursor() to unset the cursor of the window

a #GdkCursor, or %NULL. The returned object is owned

Returns the decorations set on the GdkWindow with gdk_window_set_decorations().

%TRUE if the window has decorations set, %FALSE otherwise.

The window decorations will be written here Retrieves a #GdkCursor pointer for the @device currently set on the specified #GdkWindow, or %NULL. If the return value is %NULL then there is no custom cursor set on the specified window, and it is using the cursor for its parent window. by the #GdkWindow and should not be unreferenced directly. Use gdk_window_set_cursor() to unset the cursor of the window

a #GdkCursor, or %NULL. The returned object is owned

a #GdkDevice. Returns the event mask for @window corresponding to an specific device.

device event mask for @window

a #GdkDevice. Obtains the current device position and modifier state. The position is given in coordinates relative to the upper left corner of @window. gdk_display_get_window_at_device_position()), or %NULL if the window is not known to GDK.

The window underneath @device (as with

#GdkDevice to query to. return location for the X coordinate of @device, or %NULL. return location for the Y coordinate of @device, or %NULL. return location for the modifier mask, or %NULL. Obtains the parent of @window, as known to GDK. Works like gdk_window_get_parent() for normal windows, but returns the window's embedder for offscreen windows.

effective parent of @window

Gets the toplevel window that's an ancestor of @window. Works like gdk_window_get_toplevel(), but treats an offscreen window's embedder as its parent, using gdk_window_get_effective_parent().

the effective toplevel window containing @window

Gets the event mask for @window for all master input devices. See gdk_window_set_events().

event mask for @window

Determines whether or not the desktop environment should be hinted that the window does not want to receive input focus when it is mapped. it is mapped.

whether or not the window wants to receive input focus when

Obtains the bounding box of the window, including window manager titlebar/borders if any. The frame position is given in root window coordinates. To get the position of the window itself (rather than the frame) in root window coordinates, use gdk_window_get_origin().

rectangle to fill with bounding box of the window frame Any of the return location arguments to this function may be %NULL, if you aren't interested in getting the value of that field. The X and Y coordinates returned are relative to the parent window of @window, which for toplevels usually means relative to the window decorations (titlebar, etc.) rather than relative to the root window (screen-size background window). On the X11 platform, the geometry is obtained from the X server, so reflects the latest position of @window; this may be out-of-sync with the position of @window delivered in the most-recently-processed #GdkEventConfigure. gdk_window_get_position() in contrast gets the position from the most recent configure event. <note> If @window is not a toplevel, it is <emphasis>much</emphasis> better to call gdk_window_get_position() and gdk_drawable_get_size() instead, because it avoids the roundtrip to the X server and because gdk_drawable_get_size() supports the full 32-bit coordinate space, whereas gdk_window_get_geometry() is restricted to the 16-bit coordinates of X11. </note>

return location for X coordinate of window (relative to its parent) return location for Y coordinate of window (relative to its parent) return location for width of window return location for height of window return location for bit depth of window Returns the group leader window for @window. See gdk_window_set_group().

the group leader window for @window

If you bypass the GDK layer and use windowing system primitives to draw directly onto a #GdkWindow, then you need to deal with two system coordinates, and GDK may have redirected drawing to a offscreen pixmap as the result of a gdk_window_begin_paint_region() calls. This function allows retrieving the information you need to compensate for these effects. This function exposes details of the GDK implementation, and is thus likely to change in future releases of GDK.

location to store the drawable to which drawing should be done. location to store the X offset between coordinates in @window, and the underlying window system primitive coordinates for *@real_drawable. location to store the Y offset between coordinates in @window, and the underlying window system primitive coordinates for *@real_drawable. Determines whether or not the window manager is hinted that @window has modal behaviour.

whether or not the window has the modal hint set.

Obtains the position of a window in root window coordinates. (Compare with gdk_window_get_position() and gdk_window_get_geometry() which return the position of a window relative to its parent window.)

not meaningful, ignore

return location for X coordinate return location for Y coordinate Obtains the parent of @window, as known to GDK. Does not query the X server; thus this returns the parent as passed to gdk_window_new(), not the actual parent. This should never matter unless you're using Xlib calls mixed with GDK calls on the X11 platform. It may also matter for toplevel windows, because the window manager may choose to reparent them. Note that you should use gdk_window_get_effective_parent() when writing generic code that walks up a window hierarchy, because gdk_window_get_parent() will most likely not do what you expect if there are offscreen windows in the hierarchy.

parent of @window

Obtains the current pointer position and modifier state. The position is given in coordinates relative to the upper left corner of @window. gdk_window_at_pointer()), or %NULL if the window containing the pointer isn't known to GDK

the window containing the pointer (as with

return location for X coordinate of pointer or %NULL to not return the X coordinate return location for Y coordinate of pointer or %NULL to not return the Y coordinate return location for modifier mask or %NULL to not return the modifier mask Obtains the position of the window as reported in the most-recently-processed #GdkEventConfigure. Contrast with gdk_window_get_geometry() which queries the X server for the current window position, regardless of which events have been received or processed. The position coordinates are relative to the window's parent window.

X coordinate of window Y coordinate of window Obtains the position of a window position in root window coordinates. This is similar to gdk_window_get_origin() but allows you go pass in any position in the window, not just the origin.

X coordinate in window Y coordinate in window return location for X coordinate return location for Y coordinate Obtains the top-left corner of the window manager frame in root window coordinates.

return location for X position of window frame return location for Y position of window frame Gets the bitwise OR of the currently active window state flags, from the #GdkWindowState enumeration.

window state bitfield

Returns %TRUE if the window is aware of the existence of multiple devices.

%TRUE if the window handles multidevice features.

Gets the toplevel window that's an ancestor of @window. Any window type but %GDK_WINDOW_CHILD is considered a toplevel window, as is a %GDK_WINDOW_CHILD window that has a root window as parent. Note that you should use gdk_window_get_effective_toplevel() when you want to get to a window's toplevel as seen on screen, because gdk_window_get_toplevel() will most likely not do what you expect if there are offscreen windows in the hierarchy.

the toplevel window containing @window

This function returns the type hint set for a window.

The type hint set for @window

Transfers ownership of the update area from @window to the caller of the function. That is, after calling this function, @window will no longer have an invalid/dirty region; the update area is removed from @window and handed to you. If a window has no update area, gdk_window_get_update_area() returns %NULL. You are responsible for calling cairo_region_destroy() on the returned region if it's non-%NULL.

the update area for @window

Retrieves the user data for @window, which is normally the widget that @window belongs to. See gdk_window_set_user_data().

return location for user data Gets the type of the window. See #GdkWindowType.

type of window

Checks whether the window has a native window or not. Note that you can use gdk_window_ensure_native() if a native window is needed.

%TRUE if the %window has a native window, %FALSE otherwise.

For toplevel windows, withdraws them, so they will no longer be known to the window manager; for all windows, unmaps them, so they won't be displayed. Normally done automatically as part of gtk_widget_hide().

Asks to iconify (minimize) @window. The window manager may choose to ignore the request, but normally will honor it. Using gtk_window_iconify() is preferred, if you have a #GtkWindow widget. This function only makes sense when @window is a toplevel window.

Like gdk_window_shape_combine_mask(), but the shape applies only to event handling. Mouse events which happen while the pointer position corresponds to an unset bit in the mask will be passed on the window below @window. An input shape is typically used with RGBA windows. The alpha channel of the window defines which pixels are invisible and allows for nicely antialiased borders, and the input shape controls where the window is "clickable". On the X11 platform, this requires version 1.1 of the shape extension. On the Win32 platform, this functionality is not present and the function does nothing.

shape mask, or %NULL X position of shape mask with respect to @window Y position of shape mask with respect to @window Like gdk_window_shape_combine_region(), but the shape applies only to event handling. Mouse events which happen while the pointer position corresponds to an unset bit in the mask will be passed on the window below @window. An input shape is typically used with RGBA windows. The alpha channel of the window defines which pixels are invisible and allows for nicely antialiased borders, and the input shape controls where the window is "clickable". On the X11 platform, this requires version 1.1 of the shape extension. On the Win32 platform, this functionality is not present and the function does nothing.

region of window to be non-transparent X position of @shape_region in @window coordinates Y position of @shape_region in @window coordinates Adds @region to the update area for @window. The update area is the region that needs to be redrawn, or "dirty region." The call gdk_window_process_updates() sends one or more expose events to the window, which together cover the entire update area. An application would normally redraw the contents of @window in response to those expose events. GDK will call gdk_window_process_all_updates() on your behalf whenever your program returns to the main loop and becomes idle, so normally there's no need to do that manually, you just need to invalidate regions that you know should be redrawn. The @child_func parameter controls whether the region of each child window that intersects @region will also be invalidated. Only children for which @child_func returns TRUE will have the area invalidated.

a #cairo_region_t function to use to decide if to recurse to a child, %NULL means never recurse. data passed to @child_func A convenience wrapper around gdk_window_invalidate_region() which invalidates a rectangular region. See gdk_window_invalidate_region() for details.

rectangle to invalidate or %NULL to invalidate the whole window whether to also invalidate child windows Adds @region to the update area for @window. The update area is the region that needs to be redrawn, or "dirty region." The call gdk_window_process_updates() sends one or more expose events to the window, which together cover the entire update area. An application would normally redraw the contents of @window in response to those expose events. GDK will call gdk_window_process_all_updates() on your behalf whenever your program returns to the main loop and becomes idle, so normally there's no need to do that manually, you just need to invalidate regions that you know should be redrawn. The @invalidate_children parameter controls whether the region of each child window that intersects @region will also be invalidated. If %FALSE, then the update area for child windows will remain unaffected. See gdk_window_invalidate_maybe_recurse if you need fine grained control over which children are invalidated.

a #cairo_region_t %TRUE to also invalidate child windows Check to see if a window is destroyed..

%TRUE if the window is destroyed

Determines whether or not the window is an input only window.

%TRUE if @window is input only

Determines whether or not the window is shaped.

%TRUE if @window is shaped

Check if the window and all ancestors of the window are mapped. (This is not necessarily "viewable" in the X sense, since we only check as far as we have GDK window parents, not to the root window.)

%TRUE if the window is viewable

Checks whether the window has been mapped (with gdk_window_show() or gdk_window_show_unraised()).

%TRUE if the window is mapped

Lowers @window to the bottom of the Z-order (stacking order), so that other windows with the same parent window appear above @window. This is true whether or not the other windows are visible. If @window is a toplevel, the window manager may choose to deny the request to move the window in the Z-order, gdk_window_lower() only requests the restack, does not guarantee it. Note that gdk_window_show() raises the window again, so don't call this function before gdk_window_show(). (Try gdk_window_show_unraised().)

Maximizes the window. If the window was already maximized, then this function does nothing. On X11, asks the window manager to maximize @window, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or don't have a concept of "maximized"; so you can't rely on the maximization actually happening. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen. On Windows, reliably maximizes the window.

Merges the input shape masks for any child windows into the input shape mask for @window. i.e. the union of all input masks for @window and its children will become the new input mask for @window. See gdk_window_input_shape_combine_mask(). This function is distinct from gdk_window_set_child_input_shapes() because it includes @window's input shape mask in the set of shapes to be merged.

Merges the shape masks for any child windows into the shape mask for @window. i.e. the union of all masks for @window and its children will become the new mask for @window. See gdk_window_shape_combine_mask(). This function is distinct from gdk_window_set_child_shapes() because it includes @window's shape mask in the set of shapes to be merged.

Repositions a window relative to its parent window. For toplevel windows, window managers may ignore or modify the move; you should probably use gtk_window_move() on a #GtkWindow widget anyway, instead of using GDK functions. For child windows, the move will reliably succeed. If you're also planning to resize the window, use gdk_window_move_resize() to both move and resize simultaneously, for a nicer visual effect.

X coordinate relative to window's parent Y coordinate relative to window's parent Move the part of @window indicated by @region by @dy pixels in the Y direction and @dx pixels in the X direction. The portions of @region that not covered by the new position of @region are invalidated. Child windows are not moved.

The #cairo_region_t to move Amount to move in the X direction Amount to move in the Y direction Equivalent to calling gdk_window_move() and gdk_window_resize(), except that both operations are performed at once, avoiding strange visual effects. (i.e. the user may be able to see the window first move, then resize, if you don't use gdk_window_move_resize().)

new X position relative to window's parent new Y position relative to window's parent new width new height Creates a new #GdkWindow using the attributes from display, @parent must be specified.

the new #GdkWindow

attributes of the new window mask indicating which fields in @attributes are valid Like gdk_window_get_children(), but does not copy the list of children, so the list does not need to be freed. a reference to the list of child windows in @window

Sends one or more expose events to @window. The areas in each expose event will cover the entire update area for the window (see gdk_window_invalidate_region() for details). Normally GDK calls gdk_window_process_all_updates() on your behalf, so there's no need to call this function unless you want to force expose events to be delivered immediately and synchronously (vs. the usual case, where GDK delivers them in an idle handler). Occasionally this is useful to produce nicer scrolling behavior, for example.

whether to also process updates for child windows Raises @window to the top of the Z-order (stacking order), so that other windows with the same parent window appear below @window. This is true whether or not the windows are visible. If @window is a toplevel, the window manager may choose to deny the request to move the window in the Z-order, gdk_window_raise() only requests the restack, does not guarantee it.

Redirects drawing into @window so that drawing to the window in the rectangle specified by @src_x, @src_y, Only drawing between gdk_window_begin_paint_region() or gdk_window_begin_paint_rect() and gdk_window_end_paint() is redirected. Redirection is active until gdk_window_remove_redirection() is called.

a #GdkDrawable x position in @window y position in @window x position in @drawable y position in @drawable width of redirection, or -1 to use the width of @window height of redirection or -1 to use the height of @window Registers a window as a potential drop destination.

Remove a filter previously added with gdk_window_add_filter().

previously-added filter function user data for previously-added filter function Removes any active redirection started by gdk_window_redirect_to_drawable().

Reparents @window into the given @new_parent. The window being reparented will be unmapped as a side effect.

new parent to move @window into X location inside the new parent Y location inside the new parent Resizes @window; for toplevel windows, asks the window manager to resize the window. The window manager may not allow the resize. When using GTK+, use gtk_window_resize() instead of this low-level GDK function. Windows may not be resized below 1x1. If you're also planning to move the window, use gdk_window_move_resize() to both move and resize simultaneously, for a nicer visual effect.

new width of the window new height of the window Changes the position of @window in the Z-order (stacking order), so that it is above @sibling (if @above is %TRUE) or below @sibling (if @above is %FALSE). If @sibling is %NULL, then this either raises (if @above is %TRUE) or lowers the window. If @window is a toplevel, the window manager may choose to deny the request to move the window in the Z-order, gdk_window_restack() only requests the restack, does not guarantee it.

a #GdkWindow that is a sibling of @window, or %NULL a boolean Scroll the contents of @window, both pixels and children, by the given amount. @window itself does not move. Portions of the window that the scroll operation brings in from offscreen areas are invalidated. The invalidated region may be bigger than what would strictly be necessary. For X11, a minimum area will be invalidated if the window has no subwindows, or if the edges of the window's parent do not extend beyond the edges of the window. In other cases, a multi-step process is used to scroll the window which may produce temporary visual artifacts and unnecessary invalidations.

Amount to scroll in the X direction Amount to scroll in the Y direction Setting @accept_focus to %FALSE hints the desktop environment that the window doesn't want to receive input focus. On X, it is the responsibility of the window manager to interpret this hint. ICCCM-compliant window manager usually respect it.

%TRUE if the window should receive input focus Sets the background pixmap of @window. May also be used to set a background of "None" on @window, by setting a background pixmap of %NULL. A background pixmap will be tiled, positioning the first tile at the origin of @window, or if @parent_relative is %TRUE, the tiling will be done based on the origin of the parent window (useful to align tiles in a parent with tiles in a child). A background pixmap of %NULL means that the window will have no background. A window with no background will never have its background filled by the windowing system, instead the window will contain whatever pixels were already in the corresponding area of the display. The windowing system will normally fill a window with its background when the window is obscured then exposed, and when you call gdk_window_clear().

a #GdkPixmap, or %NULL whether the tiling origin is at the origin of Sets the background color of @window. (However, when using GTK+, set the background of a widget with gtk_widget_modify_bg() - if you're an application - or gtk_style_set_background() - if you're implementing a custom widget.) See also gdk_window_set_background_pixmap().

an allocated #GdkColor Sets the input shape mask of @window to the union of input shape masks for all children of @window, ignoring the input shape mask of @window itself. Contrast with gdk_window_merge_child_input_shapes() which includes the input shape mask of @window in the masks to be merged.

Sets the shape mask of @window to the union of shape masks for all children of @window, ignoring the shape mask of @window itself. Contrast with gdk_window_merge_child_shapes() which includes the shape mask of @window in the masks to be merged.

Sets a #GdkWindow as composited, or unsets it. Composited windows do not automatically have their contents drawn to the screen. Drawing is redirected to an offscreen buffer and an expose event is emitted on the parent of the composited window. It is the responsibility of the parent's expose handler to manually merge the off-screen content onto the screen in whatever way it sees fit. See <xref linkend="composited-window-example"/> for an example. It only makes sense for child windows to be composited; see gdk_window_set_opacity() if you need translucent toplevel windows. An additional effect of this call is that the area of this window is no longer clipped from regions marked for invalidation on its parent. Draws done on the parent window are also no longer clipped by the child. This call is only supported on some systems (currently, only X11 with new enough Xcomposite and Xdamage extensions). You must call gdk_display_supports_composite() to check if setting a window as composited is supported before attempting to do so.

%TRUE to set the window as composited Sets the default mouse pointer for a #GdkWindow. Use gdk_cursor_new_for_display() or gdk_cursor_new_from_pixmap() to create the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR. Passing %NULL for the @cursor argument to gdk_window_set_cursor() means that @window will use the cursor of its parent window. Most windows should use this default.

a cursor "Decorations" are the features the window manager adds to a toplevel #GdkWindow. This function sets the traditional Motif window manager hints that tell the window manager which decorations you would like your window to have. Usually you should use gtk_window_set_decorated() on a #GtkWindow instead of using the GDK function directly. The @decorations argument is the logical OR of the fields in the #GdkWMDecoration enumeration. If #GDK_DECOR_ALL is included in the mask, the other bits indicate which decorations should be turned off. If #GDK_DECOR_ALL is not included, then the other bits indicate which decorations should be turned on. Most window managers honor a decorations hint of 0 to disable all decorations, but very few honor all possible combinations of bits.

decoration hint mask Sets a specific #GdkCursor for a given device when it gets inside @window. Use gdk_cursor_new_for_display() or gdk_cursor_new_from_pixmap() to create the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR. Passing %NULL for the @cursor argument to gdk_window_set_cursor() means that use this default.

a #GdkDevice a #GdkCursor Sets the event mask for a given device (Normally a floating device, not attached to any visible pointer) to @window. For example, an event mask including #GDK_BUTTON_PRESS_MASK means the window should report button press events. The event mask is the bitwise OR of values from the #GdkEventMask enumeration.

#GdkDevice to enable events for. event mask for @window The event mask for a window determines which events will be reported for that window from all master input devices. For example, an event mask including #GDK_BUTTON_PRESS_MASK means the window should report button press events. The event mask is the bitwise OR of values from the #GdkEventMask enumeration.

event mask for @window Setting @focus_on_map to %FALSE hints the desktop environment that the window doesn't want to receive input focus when it is mapped. focus_on_map should be turned off for windows that aren't triggered interactively (such as popups from network activity). On X, it is the responsibility of the window manager to interpret this hint. Window managers following the freedesktop.org window manager extension specification should respect it.

%TRUE if the window should receive input focus when mapped Sets hints about the window management functions to make available via buttons on the window frame. On the X backend, this function sets the traditional Motif window manager hint for this purpose. However, few window managers do anything reliable or interesting with this hint. Many ignore it entirely. The @functions argument is the logical OR of values from the #GdkWMFunction enumeration. If the bitmask includes #GDK_FUNC_ALL, then the other bits indicate which functions to disable; if it doesn't include #GDK_FUNC_ALL, it indicates which functions to enable.

bitmask of operations to allow on @window Sets the geometry hints for @window. Hints flagged in @geom_mask are set, hints not flagged in @geom_mask are unset. To unset all hints, use a @geom_mask of 0 and a @geometry of %NULL. This function provides hints to the windowing system about acceptable sizes for a toplevel window. The purpose of this is to constrain user resizing, but the windowing system will typically (but is not required to) also constrain the current size of the window to the provided values and constrain programatic resizing via gdk_window_resize() or gdk_window_move_resize(). Note that on X11, this effect has no effect on windows of type %GDK_WINDOW_TEMP or windows where override redirect has been turned on via gdk_window_set_override_redirect() since these windows are not resizable by the user. Since you can't count on the windowing system doing the constraints for programmatic resizes, you should generally call gdk_window_constrain_size() yourself to determine appropriate sizes.

geometry hints bitmask indicating fields of @geometry to pay attention to Sets the group leader window for @window. By default, GDK sets the group leader for all toplevel windows to a global window implicitly created by GDK. With this function you can override this default. The group leader window allows the window manager to distinguish all windows that belong to a single application. It may for example allow users to minimize/unminimize all windows belonging to an application at once. You should only set a non-default group window if your application pretends to be multiple applications.

group leader window, or %NULL to restore the default group leader window Sets the icon of @window as a pixmap or window. If using GTK+, investigate gtk_window_set_default_icon_list() first, and then gtk_window_set_icon_list() and gtk_window_set_icon(). If those don't meet your needs, look at gdk_window_set_icon_list(). Only if all those are too high-level do you want to fall back to gdk_window_set_icon().

a #GdkWindow to use for the icon, or %NULL to unset a #GdkPixmap to use as the icon, or %NULL to unset a 1-bit pixmap (#GdkBitmap) to use as mask for @pixmap, or %NULL to have none Sets a list of icons for the window. One of these will be used to represent the window when it has been iconified. The icon is usually shown in an icon box or some sort of task bar. Which icon size is shown depends on the window manager. The window manager can scale the icon but setting several size icons can give better image quality since the window manager may only need to scale the icon by a small amount or not at all.

A list of pixbufs, of different sizes. Windows may have a name used while minimized, distinct from the name they display in their titlebar. Most of the time this is a bad idea from a user interface standpoint. But you can set such a name with this function, if you like. After calling this with a non-%NULL @name, calls to gdk_window_set_title() will not update the icon title. Using %NULL for @name unsets the icon title; further calls to gdk_window_set_title() will again update the icon title as well.

name of window while iconified (minimized) Set if @window must be kept above other windows. If the window was already above, then this function does nothing. On X11, asks the window manager to keep @window above, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or don't have a concept of "keep above"; so you can't rely on the window being kept above. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen.

whether to keep @window above other windows Set if @window must be kept below other windows. If the window was already below, then this function does nothing. On X11, asks the window manager to keep @window below, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or don't have a concept of "keep below"; so you can't rely on the window being kept below. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen.

whether to keep @window below other windows The application can use this hint to tell the window manager that a certain window has modal behaviour. The window manager can use this information to handle modal windows in a special way. You should only use this on windows for which you have previously called gdk_window_set_transient_for()

%TRUE if the window is modal, %FALSE otherwise. Request the windowing system to make @window partially transparent, with opacity 0 being fully transparent and 1 fully opaque. (Values of the opacity parameter are clamped to the [0,1] range.) On X11, this works only on X screens with a compositing manager running. For setting up per-pixel alpha, see gdk_screen_get_rgba_colormap(). For making non-toplevel windows translucent, see gdk_window_set_composited().

opacity An override redirect window is not under the control of the window manager. This means it won't have a titlebar, won't be minimizable, etc. - it will be entirely under the control of the application. The window manager can't see the override redirect window at all. Override redirect should only be used for short-lived temporary windows, such as popup menus. #GtkMenu uses an override redirect window in its implementation, for example.

%TRUE if window should be override redirect When using GTK+, typically you should use gtk_window_set_role() instead of this low-level function. The window manager and session manager use a window's role to distinguish it from other kinds of window in the same application. When an application is restarted after being saved in a previous session, all windows with the same title and role are treated as interchangeable. So if you have two windows with the same title that should be distinguished for session management purposes, you should set the role on those windows. It doesn't matter what string you use for the role, as long as you have a different role for each non-interchangeable kind of window.

a string indicating its role Toggles whether a window should appear in a pager (workspace switcher, or other desktop utility program that displays a small thumbnail representation of the windows on the desktop). If a window's semantic type as specified with gdk_window_set_type_hint() already fully describes the window, this function should <emphasis>not</emphasis> be called in addition, instead you should allow the window to be treated according to standard policy for its semantic type.

%TRUE to skip the pager Toggles whether a window should appear in a task list or window list. If a window's semantic type as specified with gdk_window_set_type_hint() already fully describes the window, this function should <emphasis>not</emphasis> be called in addition, instead you should allow the window to be treated according to standard policy for its semantic type.

%TRUE to skip the taskbar When using GTK+, typically you should use gtk_window_set_startup_id() instead of this low-level function.

a string with startup-notification identifier Set the bit gravity of the given window to static, and flag it so all children get static subwindow gravity. This is used if you are implementing scary features that involve deep knowledge of the windowing system. Don't worry about it unless you have to.

%TRUE if the server supports static gravity

%TRUE to turn on static gravity This function will enable multidevice features in @window. Multidevice aware windows will need to handle properly multiple, per device enter/leave events, device grabs and grab ownerships.

%TRUE to enable multidevice support in @window. Sets the title of a toplevel window, to be displayed in the titlebar. If you haven't explicitly set the icon name for the window (using gdk_window_set_icon_name()), the icon name will be set to user-readable strings in GDK/GTK+). @title may not be %NULL.

title of @window Indicates to the window manager that @window is a transient dialog associated with the application window @parent. This allows the window manager to do things like center @window on @parent and keep @window above @parent. See gtk_window_set_transient_for() if you're using #GtkWindow or #GtkDialog.

another toplevel #GdkWindow The application can use this call to provide a hint to the window manager about the functionality of a window. The window manager can use this information when determining the decoration and behaviour of the window. The hint must be set before the window is mapped.

A hint of the function this window will have Toggles whether a window needs the user's urgent attention.

%TRUE if the window is urgent For most purposes this function is deprecated in favor of g_object_set_data(). However, for historical reasons GTK+ stores the #GtkWidget that owns a #GdkWindow as user data on the #GdkWindow. So, custom widget implementations should use this function for that. If GTK+ receives an event for a #GdkWindow, and the user data for the window is non-%NULL, GTK+ will assume the user data is a #GtkWidget, and forward the event to that widget.

user data Applies a shape mask to @window. Pixels in @window corresponding to set bits in the @mask will be visible; pixels in @window corresponding to unset bits in the @mask will be transparent. This gives a non-rectangular window. If @mask is %NULL, the shape mask will be unset, and the @x/@y parameters are not used. On the X11 platform, this uses an X server extension which is widely available on most common platforms, but not available on very old X servers, and occasionally the implementation will be buggy. On servers without the shape extension, this function will do nothing. This function works on both toplevel and child windows.

shape mask X position of shape mask with respect to @window Y position of shape mask with respect to @window Makes pixels in @window outside @shape_region be transparent, so that the window may be nonrectangular. See also gdk_window_shape_combine_mask() to use a bitmap as the mask. If @shape_region is %NULL, the shape will be unset, so the whole window will be opaque again. @offset_x and @offset_y are ignored if @shape_region is %NULL. On the X11 platform, this uses an X server extension which is widely available on most common platforms, but not available on very old X servers, and occasionally the implementation will be buggy. On servers without the shape extension, this function will do nothing. This function works on both toplevel and child windows.

region of window to be non-transparent X position of @shape_region in @window coordinates Y position of @shape_region in @window coordinates Like gdk_window_show_unraised(), but also raises the window to the top of the window stack (moves the window to the front of the Z-order). This function maps a window so it's visible onscreen. Its opposite is gdk_window_hide(). When implementing a #GtkWidget, you should call this function on the widget's #GdkWindow as part of the "map" method.

Shows a #GdkWindow onscreen, but does not modify its stacking order. In contrast, gdk_window_show() will raise the window to the top of the window stack. On the X11 platform, in Xlib terms, this function calls XMapWindow() (it also updates some internal GDK state, which means that you can't really use XMapWindow() directly on a GDK window).

"Pins" a window such that it's on all workspaces and does not scroll with viewports, for window managers that have scrollable viewports. (When using #GtkWindow, gtk_window_stick() may be more useful.) On the X11 platform, this function depends on window manager support, so may have no effect with many window managers. However, GDK will do the best it can to convince the window manager to stick the window. For window managers that don't support this operation, there's nothing you can do to force it to happen.

Thaws a window frozen with gdk_window_freeze_toplevel_updates_libgtk_only(). This function is not part of the GDK public API and is only for use by GTK+.

Thaws a window frozen with gdk_window_freeze_updates().

Moves the window out of fullscreen mode. If the window was not fullscreen, does nothing. On X11, asks the window manager to move @window out of the fullscreen state, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or don't have a concept of "fullscreen"; so you can't rely on the unfullscreenification actually happening. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen.

Unmaximizes the window. If the window wasn't maximized, then this function does nothing. On X11, asks the window manager to unmaximize @window, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or don't have a concept of "maximized"; so you can't rely on the unmaximization actually happening. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen. On Windows, reliably unmaximizes the window.

Reverse operation for gdk_window_stick(); see gdk_window_stick(), and gtk_window_unstick().

Withdraws a window (unmaps it and asks the window manager to forget about it). This function is not really useful as gdk_window_hide() automatically withdraws toplevel windows before hiding them.

The mouse pointer for a #GdkWindow. See gdk_window_set_cursor() and gdk_window_get_cursor() for details. The ::from-embedder signal is emitted to translate coordinates in the embedder of an offscreen window to the offscreen window. See also #GtkWindow::to-embedder.

x coordinate in the embedder window y coordinate in the embedder window return location for the x coordinate in the offscreen window return location for the y coordinate in the offscreen window The ::pick-embedded-child signal is emitted to find an embedded child at the given position.

the #GdkWindow of the embedded child at @x, @y, or %NULL

x coordinate in the window y coordinate in the window The ::to-embedder signal is emitted to translate coordinates in an offscreen window to its embedder. See also #GtkWindow::from-embedder.

x coordinate in the offscreen window y coordinate in the offscreen window return location for the x coordinate in the embedder window return location for the y coordinate in the embedder window Attributes to use for a newly-created window. Used to indicate which fields in the #GdkWindowAttr struct should be honored. For example, if you filled in the "cursor" and "x" fields of #GdkWindowAttr, pass "@GDK_WA_X | @GDK_WA_CURSOR" to gdk_window_new(). Fields in #GdkWindowAttr not covered by a bit in this enum are required; for example, the @width/@height, @wclass, and @window_type fields are required, they have no corresponding flag in #GdkWindowAttributesType. Such windows receive events and are also displayed on screen. windows in order to trap or filter the events. You can't draw on Determines a window edge or corner. Used to indicate which fields of a #GdkGeometry struct should be paid attention to. Also, the presence/absence of @GDK_HINT_POS, directly refer to #GdkGeometry fields. @GDK_HINT_USER_POS will be set automatically by #GtkWindow if you call gtk_window_move(). specified a size/position using a --geometry command-line argument; gtk_window_parse_geometry() automatically sets these flags. Describes the kind of window. 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. See the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink> specification for more details about window types. Adds a filter to the default display to be called when X ClientMessage events are received. See gdk_display_add_client_message_filter().

the type of ClientMessage events to receive. This will be checked against the <structfield>message_type</structfield> field of the XClientMessage event struct. the function to call to process the event. user data to pass to @func. Appends gdk option entries to the passed in option group. This is not public API and must not be used by applications.

An option group.

Finds or creates an atom corresponding to a given string. Note that this function is identical to gdk_atom_intern() except that if a new #GdkAtom is created the string itself is used rather than a copy. This saves memory, but can only be used if the string will <emphasis>always</emphasis> exist. It can be used with statically allocated strings in the main program, but not with statically allocated memory in dynamically loaded modules, if you expect to ever unload the module again (e.g. do not use this function in GTK+ theme engines).

the atom corresponding to @atom_name

a static string

Emits a short beep on the default display.

Creates a Cairo context for drawing to @drawable. <note><para> Note that due to double-buffering, Cairo contexts created in a GTK+ expose event handler cannot be cached and reused between different expose events. </para></note> cairo_destroy() when you are done drawing.

A newly created Cairo context. Free with

a #GdkDrawable Adds the given rectangle to the current path of @cr.

a #cairo_t a #GdkRectangle Adds the given region to the current path of @cr.

a #cairo_t a #cairo_region_t Resets the clip region for a Cairo context created by gdk_cairo_create(). This resets the clip region to the "empty" state for the given drawable. This is required for non-native windows since a direct call to cairo_reset_clip() would unset the clip region inherited from the drawable (i.e. the window clip region), and thus let you e.g. draw outside your window. This is rarely needed though, since most code just create a new cairo_t using gdk_cairo_create() each time they want to draw something.

a #cairo_t a #GdkDrawable Sets the specified #GdkColor as the source color of @cr.

a #cairo_t a #GdkColor Sets the given pixbuf as the source pattern for the Cairo context. The pattern has an extend mode of %CAIRO_EXTEND_NONE and is aligned so that the origin of @pixbuf is @pixbuf_x, @pixbuf_y

a #Cairo context a #GdkPixbuf X coordinate of location to place upper left corner of @pixbuf Y coordinate of location to place upper left corner of @pixbuf Sets the given pixmap as the source pattern for the Cairo context. The pattern has an extend mode of %CAIRO_EXTEND_NONE and is aligned so that the origin of @pixmap is @pixmap_x, @pixmap_y

a #Cairo context a #GdkPixmap X coordinate of location to place upper left corner of @pixmap Y coordinate of location to place upper left corner of @pixmap Parses a textual specification of a color and fill in the <structfield>red</structfield>, <structfield>green</structfield>, and <structfield>blue</structfield> fields of a #GdkColor structure. The color is <emphasis>not</emphasis> allocated, you must call gdk_colormap_alloc_color() yourself. The string can either one of a large set of standard names. (Taken from the X11 <filename>rgb.txt</filename> file), or it can be a hex value in the form '&num;rgb' '&num;rrggbb' '&num;rrrgggbbb' or '&num;rrrrggggbbbb' where 'r', 'g' and 'b' are hex digits of the red, green, and blue components of the color, respectively. (White in the four forms is '&num;fff' '&num;ffffff' '&num;fffffffff' and '&num;ffffffffffff')

%TRUE if the parsing succeeded.

the string specifying the color. the #GdkColor to fill in Returns the list of available input devices for the default display. The list is statically allocated and should not be freed.

a list of #GdkDevice

Aborts a drag without dropping. This function is called by the drag source.

a #GdkDragContext. the timestamp for this operation. Starts a drag and creates a new drag context for it. This function is called by the drag source.

a newly created #GdkDragContext.

the source window for this drag. the offered targets, as list of #GdkAtoms Drops on the current destination. This function is called by the drag source.

a #GdkDragContext. the timestamp for this operation. Returns whether the dropped data has been successfully transferred. This function is intended to be used while handling a %GDK_DROP_FINISHED event, its return value is meaningless at other times.

%TRUE if the drop was successful.

a #GdkDragContext Finds the destination window and DND protocol to use at the given pointer position. This function is called by the drag source to obtain the

a #GdkDragContext. a window which may be at the pointer position, but should be ignored, since it is put up by the drag source as an icon. the x position of the pointer in root coordinates. the y position of the pointer in root coordinates. location to store the destination window in. location to store the DND protocol in. Finds the destination window and DND protocol to use at the given pointer position. This function is called by the drag source to obtain the

a #GdkDragContext a window which may be at the pointer position, but should be ignored, since it is put up by the drag source as an icon. the screen where the destination window is sought. the x position of the pointer in root coordinates. the y position of the pointer in root coordinates. location to store the destination window in. location to store the DND protocol in. Finds out the DND protocol supported by a window. the drop should happen. This may be @xid or the id of a proxy window, or zero if @xid doesn't support Drag and Drop.

the windowing system specific id for the window where

the windowing system id of the destination window. location where the supported DND protocol is returned. Finds out the DND protocol supported by a window.

the windowing system id of the window where the drop should happen. This may be @xid or the id of a proxy window, or zero if @xid doesn't support Drag and Drop.

the #GdkDisplay where the destination window resides the windowing system id of the destination window. location where the supported DND protocol is returned. Returns the selection atom for the current source window.

the selection atom.

a #GdkDragContext. Updates the drag context when the pointer moves or the set of actions changes. This function is called by the drag source.

FIXME

a #GdkDragContext. the new destination window, obtained by gdk_drag_find_window(). the DND protocol in use, obtained by gdk_drag_find_window(). the x position of the pointer in root coordinates. the y position of the pointer in root coordinates. the suggested action. the possible actions. the timestamp for this operation. Selects one of the actions offered by the drag source. This function is called by the drag destination in response to gdk_drag_motion() called by the drag source.

a #GdkDragContext. the selected action which will be taken when a drop happens, or 0 to indicate that a drop will not be accepted. the timestamp for this operation. Ends the drag operation after a drop. This function is called by the drag destination.

a #GtkDragContext. %TRUE if the data was successfully received. the timestamp for this operation. Accepts or rejects a drop. This function is called by the drag destination in response to a drop initiated by the drag source.

a #GdkDragContext. %TRUE if the drop is accepted. the timestamp for this operation. Enables multidevice support in GDK. This call must happen prior to gdk_display_open(), gtk_init(), gtk_init_with_args() or gtk_init_check() in order to take effect. Note that individual #GdkWindows still need to explicitly enable multidevice awareness through gdk_window_set_support_multidevice(). This function must be called before initializing GDK.

Removes an error trap pushed with gdk_error_trap_push(). May block until an error has been definitively received or not received from the X server. gdk_error_trap_pop_ignored() is preferred if you don't need to know whether an error occurred, because it never has to block. If you don't need the return value of gdk_error_trap_pop(), use gdk_error_trap_pop_ignored(). Prior to GDK 3.0, this function would not automatically sync for you, so you had to gdk_flush() if your last call to Xlib was not a blocking round trip.

X error code or 0 on success

Removes an error trap pushed with gdk_error_trap_push(), but without bothering to wait and see whether an error occurred. If an error arrives later asynchronously that was triggered while the trap was pushed, that error will be ignored.

This function allows X errors to be trapped instead of the normal behavior of exiting the application. It should only be used if it is not possible to avoid the X error in any other way. Errors are ignored on all #GdkDisplay currently known to the #GdkDisplayManager. If you don't care which error happens and just want to ignore everything, pop with gdk_error_trap_pop_ignored(). If you need the error code, use gdk_error_trap_pop() which may have to block and wait for the error to arrive from the X server. This API exists on all platforms but only does anything on X. You can use gdk_x11_display_error_trap_push() to ignore errors on only a single display. <example> <title>Trapping an X error</title> <programlisting> gdk_error_trap_push (); // ... Call the X function which may cause an error here ... if (gdk_error_trap_pop ()) { // ... Handle the error here ... } </programlisting> </example>

Checks all open displays for a #GdkEvent to process,to be processed on, fetching events from the windowing system if necessary. See gdk_display_get_event(). are pending. The returned #GdkEvent should be freed with gdk_event_free().

the next #GdkEvent to be processed, or %NULL if no events

Sets the function to call to handle all events from GDK. Note that GTK+ uses this to install its own event handler, so it is usually not useful for GTK+ applications. (Although an application can call this function then call gtk_main_do_event() to pass events to GTK+.)

the function to call to handle events from GDK. user data to pass to the function. the function to call when the handler function is removed, i.e. when gdk_event_handler_set() is called with another event handler. If there is an event waiting in the event queue of some open display, returns a copy of it. See gdk_display_peek_event(). events are in any queues. The returned #GdkEvent should be freed with gdk_event_free().

a copy of the first #GdkEvent on some event queue, or %NULL if no

Request more motion notifies if @event is a motion notify hint event. This function should be used instead of gdk_window_get_pointer() to request further motion notifies, because it also works for extension events where motion notifies are provided for devices other than the core pointer. Coordinate extraction, processing and requesting more motion events from a %GDK_MOTION_NOTIFY event usually works like this: |[ { /&ast; motion_event handler &ast;/ x = motion_event->x; y = motion_event->y; /&ast; handle (x,y) motion &ast;/ gdk_event_request_motions (motion_event); /&ast; handles is_hint events &ast;/ } ]|

a valid #GdkEvent On X11, sends an X ClientMessage event to a given window. On Windows, sends a message registered with the name GDK_WIN32_CLIENT_MESSAGE. This could be used for communicating between different applications, though the amount of data is limited to 20 bytes on X11, and to just four bytes on Windows.

non-zero on success.

the #GdkDisplay for the window where the message is to be sent. the #GdkEvent to send, which should be a #GdkEventClient. the window to send the client message to. Checks if any events are ready to be processed for any display.

%TRUE if any events are pending.

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

the default root window

Gets whether event debugging output is enabled.

%TRUE if event debugging output is enabled.

Initialize the library for use. Arguments: "argc" is the number of arguments. "argv" is an array of strings. Results: "argc" and "argv" are modified to reflect any arguments which were not handled. (Such arguments should either be handled by the application or dismissed). If initialization fails, returns FALSE, otherwise TRUE. Side effects: The library is initialized. --------------------------------------------------------------

Turns extension events on or off for a particular window, and specifies the event mask for extension events.

a #GdkWindow. the event mask the type of extension events that are desired. Grabs the keyboard so that all events are passed to this application until the keyboard is ungrabbed with gdk_keyboard_ungrab(). This overrides any previous keyboard grab by this client. If you set up anything at the time you take the grab that needs to be cleaned up when the grab ends, you should handle the #GdkEventGrabBroken events that are emitted when the grab ends unvoluntarily.

%GDK_GRAB_SUCCESS if the grab was successful.

the #GdkWindow which will own the grab (the grab window). if %FALSE then all keyboard events are reported with respect to reported as normal, but keyboard events outside this application are reported with respect to @window. Both key press and key release events are always reported, independant of the event mask set by the application. Ungrabs the keyboard on the default display, if it is grabbed by this application. instead.

a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no timestamp is available. Obtains the upper- and lower-case versions of the keyval @symbol. Examples of keyvals are #GDK_KEY_a, #GDK_KEY_Enter, #GDK_KEY_F1, etc.

a keyval return location for lowercase version of @symbol return location for uppercase version of @symbol

Convert from a GDK key symbol to the corresponding ISO10646 (Unicode) character. is no corresponding character.

the corresponding unicode character, or 0 if there

a GDK key symbol

Lists the available visuals for the default screen. (See gdk_screen_list_visuals()) A visual describes a hardware image data format. For example, a visual might support 24-bit color, or 8-bit color, and might expect pixels to be in a certain format. Call g_list_free() on the return value when you're finished with it. a list of visuals; the list must be freed, but not its contents

Indicates to the GUI environment that the application has finished loading. If the applications opens windows, this function is normally called after opening the application's initial set of windows. GTK+ will call this function automatically after opening the first #GtkWindow unless gtk_window_set_auto_startup_notification() is called to disable that feature.

Indicates to the GUI environment that the application has finished loading, using a given identifier. GTK+ will call this function automatically for #GtkWindow with custom startup-notification identifier unless gtk_window_set_auto_startup_notification() is called to disable that feature.

a startup-notification identifier, for which notification process should be completed Gets the window that @window is embedded in. embedded offscreen window

the embedding #GdkWindow, or %NULL if @window is not an

a #GdkWindow Gets the offscreen pixmap that an offscreen window renders into. If you need to keep this around over window resizes, you need to add a reference to it.

The offscreen pixmap, or %NULL if not offscreen

a #GdkWindow Sets @window to be embedded in @embedder. To fully embed an offscreen window, in addition to calling this function, it is also necessary to handle the #GdkWindow::pick-embedded-child signal on the @embedder and the #GdkWindow::to-embedder and #GdkWindow::from-embedder signals on @window.

a #GdkWindow the #GdkWindow that @window gets embedded in Creates a #PangoContext for the default GDK screen. The context must be freed when you're finished with it. When using GTK+, normally you should use gtk_widget_get_pango_context() instead of this function, to get the appropriate context for the widget you intend to render text onto. The newly created context will have the default font options (see #cairo_font_options_t) for the default screen; if these options change it will not be updated. Using gtk_widget_get_pango_context() is more convenient if you want to keep a context around and track changes to the screen's font rendering settings.

a new #PangoContext for the default display

Creates a #PangoContext for @screen. The context must be freed when you're finished with it. When using GTK+, normally you should use gtk_widget_get_pango_context() instead of this function, to get the appropriate context for the widget you intend to render text onto. The newly created context will have the default font options (see #cairo_font_options_t) for the screen; if these options change it will not be updated. Using gtk_widget_get_pango_context() is more convenient if you want to keep a context around and track changes to the screen's font rendering settings.

a new #PangoContext for @screen

the #GdkScreen for which the context is to be created. Obtains a clip region which contains the areas where the given ranges of text would be drawn. @x_origin and @y_origin are the top left point to center the layout. @index_ranges should contain ranges of bytes in the layout's text. Note that the regions returned correspond to logical extents of the text ranges, not ink extents. So the drawn layout may in fact touch areas out of the clip region. The clip region is mainly useful for highlightling parts of text, such as when text is selected.

a clip region containing the given ranges

a #PangoLayout X pixel where you intend to draw the layout with this clip Y pixel where you intend to draw the layout with this clip array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes number of ranges in @index_ranges, i.e. half the size of @index_ranges Obtains a clip region which contains the areas where the given ranges of text would be drawn. @x_origin and @y_origin are the top left position of the layout. @index_ranges should contain ranges of bytes in the layout's text. The clip region will include space to the left or right of the line (to the layout bounding box) if you have indexes above or below the indexes contained inside the line. This is to draw the selection all the way to the side of the layout. However, the clip region is in line coordinates, not layout coordinates. Note that the regions returned correspond to logical extents of the text ranges, not ink extents. So the drawn line may in fact touch areas out of the clip region. The clip region is mainly useful for highlightling parts of text, such as when text is selected.

a clip region containing the given ranges

a #PangoLayoutLine X pixel where you intend to draw the layout line with this clip baseline pixel where you intend to draw the layout line with this clip array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes number of ranges in @index_ranges, i.e. half the size of @index_ranges Parse command line arguments, and store for future use by calls to gdk_display_open(). Any arguments used by GDK are removed from the array and @argc and @argv are updated accordingly. You shouldn't call this function explicitely if you are using gtk_init(), gtk_init_check(), gdk_init(), or gdk_init_check().

the number of command line arguments. the array of command line arguments. Transfers image data from a #GdkDrawable and converts it to an RGB(A) representation inside a #GdkPixbuf. In other words, copies image data from a server-side drawable to a client-side RGB(A) buffer. This allows you to efficiently read individual pixels on the client side. If the drawable @src has no colormap (gdk_drawable_get_colormap() returns %NULL), then a suitable colormap must be specified. Typically a #GdkWindow or a pixmap created by passing a #GdkWindow to gdk_pixmap_new() will already have a colormap associated with it. If the drawable has a colormap, the @cmap argument will be ignored. If the drawable is a bitmap (1 bit per pixel pixmap), then a colormap is not required; pixels with a value of 1 are assumed to be white, and pixels with a value of 0 are assumed to be black. For taking screenshots, gdk_colormap_get_system() returns the correct colormap to use. If the specified destination pixbuf @dest is %NULL, then this function will create an RGB pixbuf with 8 bits per channel and no alpha, with the same size specified by the @width and @height arguments. In this case, the @dest_x and @dest_y arguments must be specified as 0. If the specified destination pixbuf is not %NULL and it contains alpha information, then the filled pixels will be set to full opacity (alpha = 255). If the specified drawable is a pixmap, then the requested source rectangle must be completely contained within the pixmap, otherwise the function will return %NULL. For pixmaps only (not for windows) passing -1 for width or height is allowed to mean the full width or height of the pixmap. If the specified drawable is a window, and the window is off the screen, then there is no image data in the obscured/offscreen regions to be placed in the pixbuf. The contents of portions of the pixbuf corresponding to the offscreen region are undefined. If the window you're obtaining data from is partially obscured by other windows, then the contents of the pixbuf areas corresponding to the obscured regions are undefined. If the target drawable is not mapped (typically because it's iconified/minimized or not on the current workspace), then %NULL will be returned. If memory can't be allocated for the return value, %NULL will be returned instead. (In short, there are several ways this function can fail, and if it fails it returns %NULL; so check the return value.) pixbuf with a reference count of 1 if no destination pixbuf was specified, or %NULL on error

The same pixbuf as @dest if it was non-%NULL, or a newly-created

Destination pixbuf, or %NULL if a new pixbuf should be created. Source drawable. A colormap if @src doesn't have one set. Source X coordinate within drawable. Source Y coordinate within drawable. Destination X coordinate in pixbuf, or 0 if @dest is NULL. Destination Y coordinate in pixbuf, or 0 if @dest is NULL. Width in pixels of region to get. Height in pixels of region to get. Transfers image data from a #cairo_surface_t and converts it to an RGB(A) representation inside a #GdkPixbuf. This allows you to efficiently read individual pixels from Cairo surfaces. For #GdkWindows, use gdk_pixbuf_get_from_drawable() instead. If the specified destination pixbuf @dest is %NULL, then this function will create an RGB pixbuf with 8 bits per channel. The pixbuf will contain an alpha channel if the @surface contains one. In this case, the @dest_x and @dest_y arguments must be specified as 0. If the specified drawable is a window, and the window is off the screen, then there is no image data in the obscured/offscreen regions to be placed in the pixbuf. The contents of portions of the pixbuf corresponding to the offscreen region are undefined. If the window you're obtaining data from is partially obscured by other windows, then the contents of the pixbuf areas corresponding to the obscured regions are undefined. If memory can't be allocated for the return value, %NULL will be returned instead. (In short, there are several ways this function can fail, and if it fails it returns %NULL; so check the return value.) pixbuf with a reference count of 1 if no destination pixbuf was specified, or %NULL on error

The same pixbuf as @dest if it was non-%NULL, or a newly-created

Destination pixbuf, or %NULL if a new pixbuf should be created. surface to copy from Source X coordinate within drawable. Source Y coordinate within drawable. Destination X coordinate in pixbuf, or 0 if @dest is NULL. Destination Y coordinate in pixbuf, or 0 if @dest is NULL. Width in pixels of region to get. Height in pixels of region to get. Creates a pixmap and a mask bitmap which are returned in the @pixmap_return and @mask_return arguments, respectively, and renders a pixbuf and its corresponding thresholded alpha mask to them. This is merely a convenience function; applications that need to render pixbufs with dither offsets or to given drawables should use Cairo and gdk_pixbuf_render_threshold_alpha(). The pixmap that is created is created for the colormap returned by gdk_colormap_get_system(). You normally will want to instead use the actual colormap for a widget, and use gdk_pixbuf_render_pixmap_and_mask_for_colormap(). If the pixbuf does not have an alpha channel, then *@mask_return will be set to %NULL.

A pixbuf. Location to store a pointer to the created pixmap, or %NULL if the pixmap is not needed. Location to store a pointer to the created mask, or %NULL if the mask is not needed. Threshold value for opacity values. Creates a pixmap and a mask bitmap which are returned in the @pixmap_return and @mask_return arguments, respectively, and renders a pixbuf and its corresponding tresholded alpha mask to them. This is merely a convenience function; applications that need to render pixbufs with dither offsets or to given drawables should use Cairo and gdk_pixbuf_render_threshold_alpha(). The pixmap that is created uses the #GdkColormap specified by @colormap. This colormap must match the colormap of the window where the pixmap will eventually be used or an error will result. If the pixbuf does not have an alpha channel, then *@mask_return will be set to %NULL.

A pixbuf. A #GdkColormap Location to store a pointer to the created pixmap, or %NULL if the pixmap is not needed. Location to store a pointer to the created mask, or %NULL if the mask is not needed. Threshold value for opacity values. Takes the opacity values in a rectangular portion of a pixbuf and thresholds them to produce a bi-level alpha mask that can be used as a clipping mask for a drawable.

A pixbuf. Bitmap where the bilevel mask will be painted to. Source X coordinate. source Y coordinate. Destination X coordinate. Destination Y coordinate. Width of region to threshold, or -1 to use pixbuf width Height of region to threshold, or -1 to use pixbuf height Opacity values below this will be painted as zero; all other values will be painted as one. Grabs the pointer (usually a mouse) so that all events are passed to this application until the pointer is ungrabbed with gdk_pointer_ungrab(), or the grab window becomes unviewable. This overrides any previous pointer grab by this client. Pointer grabs are used for operations which need complete control over mouse events, even if the mouse leaves the application. For example in GTK+ it is used for Drag and Drop, for dragging the handle in the #GtkHPaned and #GtkVPaned widgets, and for resizing columns in #GtkCList widgets. Note that if the event mask of an X window has selected both button press and button release events, then a button press event will cause an automatic pointer grab until the button is released. X does this automatically since most applications expect to receive button press and release events in pairs. It is equivalent to a pointer grab on the window with @owner_events set to %TRUE. If you set up anything at the time you take the grab that needs to be cleaned up when the grab ends, you should handle the #GdkEventGrabBroken events that are emitted when the grab ends unvoluntarily.

%GDK_GRAB_SUCCESS if the grab was successful.

the #GdkWindow which will own the grab (the grab window). if %FALSE then all pointer events are reported with respect to events for this application are reported as normal, but pointer events outside this application are reported with respect to @window and only if selected by specifies the event mask, which is used in accordance with may be selected. If non-%NULL, the pointer will be confined to this window during the grab. If the pointer is outside @confine_to, it will automatically be moved to the closest edge of @confine_to and enter and leave events will be generated as necessary. the cursor to display while the grab is active. If this is %NULL then the normal cursors are used for @window and its descendants, and the cursor for @window is used for all other windows. the timestamp of the event which led to this pointer grab. This usually comes from a #GdkEventButton struct, though %GDK_CURRENT_TIME can be used if the time isn't known. Returns %TRUE if the pointer on the default display is currently grabbed by this application. Note that this does not take the inmplicit pointer grab on button presses into account.

%TRUE if the pointer is currently grabbed by this application.

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

a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no timestamp is available.

This function returns the available bit depths for the default screen. It's equivalent to listing the visuals (gdk_list_visuals()) and then looking at the depth field in each visual, removing duplicates. The array returned by this function should not be freed.

return location for available depths return location for number of available depths This function returns the available visual types for the default screen. It's equivalent to listing the visuals (gdk_list_visuals()) and then looking at the type field in each visual, removing duplicates. The array returned by this function should not be freed.

return location for the available visual types return location for the number of available visual types

Calculates the intersection of two rectangles. It is allowed for do not intersect, @dest's width and height is set to 0 and its x and y values are undefined. If you are only interested in whether the rectangles intersect, but not in the intersecting area itself, pass %NULL for @dest.

%TRUE if the rectangles intersect.

a #GdkRectangle a #GdkRectangle return location for the intersection of @src1 and @src2, or %NULL Calculates the union of two rectangles. The union of rectangles @src1 and @src2 is the smallest rectangle which includes both @src1 and @src2 within it. It is allowed for @dest to be the same as either @src1 or @src2.

a #GdkRectangle a #GdkRectangle return location for the union of @src1 and @src2

Determine the owner of the given selection. Note that the return value may be owned by a different process if a foreign window was previously created for that window, but a new foreign window will never be created by this call. window known to the current process, the #GdkWindow that owns the selection, otherwise %NULL.

if there is a selection owner for this window, and it is a

a #GdkDisplay. an atom indentifying a selection.

Sets the #GdkWindow @owner as the current owner of the selection @selection. otherwise %FALSE.

%TRUE if the selection owner was successfully changed to owner,

the #GdkDisplay. a #GdkWindow or %NULL to indicate that the owner for the given should be unset. an atom identifying a selection. timestamp to use when setting the selection. If this is older than the timestamp given last time the owner was set for the given selection, the request will be ignored. if %TRUE, and the new owner is different from the current owner, the current owner will be sent a SelectionClear event. Retrieves selection data that was stored by the selection data in response to a call to gdk_selection_convert(). This function will not be used by applications, who should use the #GtkClipboard API instead.

the length of the retrieved data.

the window on which the data is stored location to store a pointer to the retrieved data. location to store the type of the property. location to store the format of the property.

Send a response to SelectionRequest event.

the #GdkDisplay where @requestor is realized window to which to deliver response. selection that was requested. target that was selected. property in which the selection owner stored the data, or %GDK_NONE to indicate that the request was rejected. timestamp. Set the double click time for the default display. See gdk_display_set_double_click_time(). See also gdk_display_set_double_click_distance(). Applications should <emphasis>not</emphasis> set this, it is a global user-configured setting.

double click time in milliseconds (thousandths of a second)

This function allows for hooking into the operation of getting the current location of the pointer. This is only useful for such low-level tools as an event recorder. Applications should never have any reason to use this facility. This function is not multihead safe. For multihead operation, see gdk_display_set_pointer_hooks().

the previous pointer hook table

a table of pointers to functions for getting quantities related to the current pointer position, or %NULL to restore the default table.

Sets whether a trace of received events is output. Note that GTK+ must be compiled with debugging (that is, configured using the <option>--enable-debug</option> option) to use this option.

%TRUE to output event debugging information. Sets the <literal>SM_CLIENT_ID</literal> property on the application's leader window so that the window manager can save the application's state using the X11R6 ICCCM session management protocol. See the X Session Management Library documentation for more information on session management and the Inter-Client Communication Conventions Manual (ICCCM) for information on the <literal>WM_CLIENT_LEADER</literal> property. (Both documents are part of the X Window System distribution.)

the client id assigned by the session manager when the connection was opened, or %NULL to remove the property. Obtains a desktop-wide setting, such as the double-click time, for the default screen. See gdk_screen_get_setting(). in @value, %FALSE otherwise.

%TRUE if the setting existed and a value was stored

the name of the setting. location to store the value of the setting. Like g_spawn_command_line_async(), except the child process is spawned in such an environment that on calling gdk_display_open() it would be returned a #GdkDisplay with @screen as the default screen. This is useful for applications which wish to launch an application on a specific screen.

%TRUE on success, %FALSE if error is set.

a #GdkScreen a command line Like g_spawn_async(), except the child process is spawned in such an environment that on calling gdk_display_open() it would be returned a #GdkDisplay with @screen as the default screen. This is useful for applications which wish to launch an application on a specific screen.

%TRUE on success, %FALSE if error is set

a #GdkScreen child's current working directory, or %NULL to inherit parent's child's argument vector child's environment, or %NULL to inherit parent's flags from #GSpawnFlags function to run in the child just before exec() user data for @child_setup return location for child process ID, or %NULL Like g_spawn_async_with_pipes(), except the child process is spawned in such an environment that on calling gdk_display_open() it would be returned a #GdkDisplay with @screen as the default screen. This is useful for applications which wish to launch an application on a specific screen.

%TRUE on success, %FALSE if an error was set

a #GdkScreen child's current working directory, or %NULL to inherit parent's child's argument vector child's environment, or %NULL to inherit parent's flags from #GSpawnFlags function to run in the child just before exec() user data for @child_setup return location for child process ID, or %NULL return location for file descriptor to write to child's stdin, or %NULL return location for file descriptor to read child's stdout, or %NULL return location for file descriptor to read child's stderr, or %NULL

Convert a string from the encoding of the current locale into a form suitable for storing in a window property.

0 upon success, non-zero upon failure.

the #GdkDisplay where the encoding is defined. a nul-terminated string. location to store the encoding atom (to be used as the type for the property). location to store the format of the property location to store newly allocated data for the property. the length of @text, in bytes

This function retrieves a pixel from @window to force the windowing system to carry out any pending rendering commands. This function is intended to be used to syncronize with rendering pipelines, to benchmark windowing system rendering operations.

a mapped #GdkWindow

Convert a text string from the encoding as it is stored in a property into an array of strings in the encoding of the current locale. (The elements of the array represent the nul-separated elements of the original text string.) if the conversion failed.

the number of strings stored in list, or 0,

The #GdkDisplay where the encoding is defined. an atom representing the encoding. The most common values for this are STRING, or COMPOUND_TEXT. This is value used as the type for the property. the format of the property. The text data. The number of items to transform. location to store a terminated array of strings in the encoding of the current locale. This array should be freed using gdk_free_text_list(). Convert a text property in the giving encoding to a list of UTF-8 strings. list.

the number of strings in the resulting

an atom representing the encoding of the text the format of the property the text to convert the length of @text, in bytes location to store the list of strings or %NULL. The list should be freed with g_strfreev(). Converts a text property in the given encoding to a list of UTF-8 strings. list.

the number of strings in the resulting

a #GdkDisplay an atom representing the encoding of the text the format of the property the text to convert the length of @text, in bytes location to store the list of strings or %NULL. The list should be freed with g_strfreev(). A wrapper for the common usage of gdk_threads_add_idle_full() assigning the default priority, #G_PRIORITY_DEFAULT_IDLE. See gdk_threads_add_idle_full().