gdk.global

Global functions for gdk3 library

Members

Functions

addOptionEntriesLibgtkOnly
void addOptionEntriesLibgtkOnly(glib.option_group.OptionGroup group)

Appends gdk option entries to the passed in option group. This is not public API and must not be used by applications.

beep
void beep()

Emits a short beep on the default display.

cairoCreate
cairo.context.Context cairoCreate(gdk.window.Window window)

Creates a Cairo context for drawing to window.

cairoDrawFromGl
void cairoDrawFromGl(cairo.context.Context cr, gdk.window.Window window, int source, int sourceType, int bufferScale, int x, int y, int width, int height)

This is the main way to draw GL content in GTK+. It takes a render buffer ID (source_type == #GL_RENDERBUFFER) or a texture id (source_type == #GL_TEXTURE) and draws it onto cr with an OVER operation, respecting the current clip. The top left corner of the rectangle specified by x, y, width and height will be drawn at the current (0,0) position of the cairo_t.

cairoGetClipRectangle
bool cairoGetClipRectangle(cairo.context.Context cr, gdk.rectangle.Rectangle rect)

This is a convenience function around cairo.context.Context.clipExtents. It rounds the clip extents to integer coordinates and returns a boolean indicating if a clip area exists.

cairoGetDrawingContext
gdk.drawing_context.DrawingContext cairoGetDrawingContext(cairo.context.Context cr)

Retrieves the #GdkDrawingContext that created the Cairo context cr.

cairoRectangle
void cairoRectangle(cairo.context.Context cr, gdk.rectangle.Rectangle rectangle)

Adds the given rectangle to the current path of cr.

cairoRegion
void cairoRegion(cairo.context.Context cr, cairo.region.Region region)

Adds the given region to the current path of cr.

cairoRegionCreateFromSurface
cairo.region.Region cairoRegionCreateFromSurface(cairo.surface.Surface surface)

Creates region that describes covers the area where the given surface is more than 50% opaque.

cairoSetSourceColor
void cairoSetSourceColor(cairo.context.Context cr, gdk.color.Color color)

Sets the specified #GdkColor as the source color of cr.

cairoSetSourcePixbuf
void cairoSetSourcePixbuf(cairo.context.Context cr, gdkpixbuf.pixbuf.Pixbuf pixbuf, double pixbufX, double pixbufY)

Sets the given pixbuf as the source pattern for cr.

cairoSetSourceRgba
void cairoSetSourceRgba(cairo.context.Context cr, gdk.rgba.RGBA rgba)

Sets the specified #GdkRGBA as the source color of cr.

cairoSetSourceWindow
void cairoSetSourceWindow(cairo.context.Context cr, gdk.window.Window window, double x, double y)

Sets the given window as the source pattern for cr.

cairoSurfaceCreateFromPixbuf
cairo.surface.Surface cairoSurfaceCreateFromPixbuf(gdkpixbuf.pixbuf.Pixbuf pixbuf, int scale, gdk.window.Window forWindow)

Creates an image surface with the same contents as the pixbuf.

disableMultidevice
void disableMultidevice()

Disables multidevice support in GDK. This call must happen prior to gdk.display.Display.open, gtk.global.init_, gtk.global.initWithArgs or gtk.global.initCheck in order to take effect.

dragAbort
void dragAbort(gdk.drag_context.DragContext context, uint time)

Aborts a drag without dropping.

dragDrop
void dragDrop(gdk.drag_context.DragContext context, uint time)

Drops on the current destination.

dragDropDone
void dragDropDone(gdk.drag_context.DragContext context, bool success)

Inform GDK if the drop ended successfully. Passing false for success may trigger a drag cancellation animation.

dragDropSucceeded
bool dragDropSucceeded(gdk.drag_context.DragContext context)

Returns whether the dropped data has been successfully transferred. This function is intended to be used while handling a gdk.types.EventType.DropFinished event, its return value is meaningless at other times.

dragFindWindowForScreen
void dragFindWindowForScreen(gdk.drag_context.DragContext context, gdk.window.Window dragWindow, gdk.screen.Screen screen, int xRoot, int yRoot, gdk.window.Window destWindow, gdk.types.DragProtocol protocol)

Finds the destination window and DND protocol to use at the given pointer position.

dragGetSelection
gdk.atom.Atom dragGetSelection(gdk.drag_context.DragContext context)

Returns the selection atom for the current source window.

dragMotion
bool dragMotion(gdk.drag_context.DragContext context, gdk.window.Window destWindow, gdk.types.DragProtocol protocol, int xRoot, int yRoot, gdk.types.DragAction suggestedAction, gdk.types.DragAction possibleActions, uint time)

Updates the drag context when the pointer moves or the set of actions changes.

dragStatus
void dragStatus(gdk.drag_context.DragContext context, gdk.types.DragAction action, uint time)

Selects one of the actions offered by the drag source.

dropFinish
void dropFinish(gdk.drag_context.DragContext context, bool success, uint time)

Ends the drag operation after a drop.

dropReply
void dropReply(gdk.drag_context.DragContext context, bool accepted, uint time)

Accepts or rejects a drop.

errorTrapPop
int errorTrapPop()

Removes an error trap pushed with gdk.global.errorTrapPush. May block until an error has been definitively received or not received from the X server. gdk.global.errorTrapPopIgnored 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.global.errorTrapPop, use gdk.global.errorTrapPopIgnored.

errorTrapPopIgnored
void errorTrapPopIgnored()

Removes an error trap pushed with gdk.global.errorTrapPush, 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.

errorTrapPush
void errorTrapPush()

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.global.errorTrapPopIgnored. If you need the error code, use gdk.global.errorTrapPop which may have to block and wait for the error to arrive from the X server.

eventsGetAngle
bool eventsGetAngle(gdk.event.Event event1, gdk.event.Event event2, double angle)

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.

eventsGetCenter
bool eventsGetCenter(gdk.event.Event event1, gdk.event.Event event2, double x, double y)

If both events contain X/Y information, the center of both coordinates will be returned in x and y.

eventsGetDistance
bool eventsGetDistance(gdk.event.Event event1, gdk.event.Event event2, double distance)

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.

eventsPending
bool eventsPending()

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

flush
void flush()

Flushes the output buffers of all display connections and waits until all requests have been processed. This is rarely needed by applications.

getDefaultRootWindow
gdk.window.Window getDefaultRootWindow()

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

getDisplay
string getDisplay()

Gets the name of the display, which usually comes from the DISPLAY environment variable or the --display command line option.

getDisplayArgName
string getDisplayArgName()

Gets the display name specified in the command line arguments passed to gdk.global.init_ or gdk.global.parseArgs, if any.

getProgramClass
string getProgramClass()

Gets the program class. Unless the program class has explicitly been set with gdk.global.setProgramClass or with the --class commandline option, the default value is the program name (determined with glib.global.getPrgname) with the first character converted to uppercase.

getShowEvents
bool getShowEvents()

Gets whether event debugging output is enabled.

keyboardGrab
gdk.types.GrabStatus keyboardGrab(gdk.window.Window window, bool ownerEvents, uint time)

Grabs the keyboard so that all events are passed to this application until the keyboard is ungrabbed with gdk.global.keyboardUngrab. This overrides any previous keyboard grab by this client.

keyboardUngrab
void keyboardUngrab(uint time)

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

keyvalConvertCase
void keyvalConvertCase(uint symbol, uint lower, uint upper)

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.

keyvalFromName
uint keyvalFromName(string keyvalName)

Converts a key name to a key value.

keyvalIsLower
bool keyvalIsLower(uint keyval)

Returns true if the given key value is in lower case.

keyvalIsUpper
bool keyvalIsUpper(uint keyval)

Returns true if the given key value is in upper case.

keyvalName
string keyvalName(uint keyval)

Converts a key value into a symbolic name.

keyvalToLower
uint keyvalToLower(uint keyval)

Converts a key value to lower case, if applicable.

keyvalToUnicode
uint keyvalToUnicode(uint keyval)

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

keyvalToUpper
uint keyvalToUpper(uint keyval)

Converts a key value to upper case, if applicable.

listVisuals
gdk.visual.Visual[] listVisuals()

Lists the available visuals for the default screen. (See gdk.screen.Screen.listVisuals) 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.

notifyStartupComplete
void notifyStartupComplete()

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.

notifyStartupCompleteWithId
void notifyStartupCompleteWithId(string startupId)

Indicates to the GUI environment that the application has finished loading, using a given identifier.

offscreenWindowGetEmbedder
gdk.window.Window offscreenWindowGetEmbedder(gdk.window.Window window)

Gets the window that window is embedded in.

offscreenWindowGetSurface
cairo.surface.Surface offscreenWindowGetSurface(gdk.window.Window window)

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

offscreenWindowSetEmbedder
void offscreenWindowSetEmbedder(gdk.window.Window window, gdk.window.Window embedder)

Sets window to be embedded in embedder.

pangoContextGet
pango.context.Context pangoContextGet()

Creates a #PangoContext for the default GDK screen.

pangoContextGetForDisplay
pango.context.Context pangoContextGetForDisplay(gdk.display.Display display)

Creates a #PangoContext for display.

pangoContextGetForScreen
pango.context.Context pangoContextGetForScreen(gdk.screen.Screen screen)

Creates a #PangoContext for screen.

pixbufGetFromSurface
gdkpixbuf.pixbuf.Pixbuf pixbufGetFromSurface(cairo.surface.Surface surface, int srcX, int srcY, int width, int height)

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.global.pixbufGetFromWindow instead.

pixbufGetFromWindow
gdkpixbuf.pixbuf.Pixbuf pixbufGetFromWindow(gdk.window.Window window, int srcX, int srcY, int width, int height)

Transfers image data from a #GdkWindow and converts it to an RGB(A) representation inside a #GdkPixbuf.

pointerGrab
gdk.types.GrabStatus pointerGrab(gdk.window.Window window, bool ownerEvents, gdk.types.EventMask eventMask, gdk.window.Window confineTo, gdk.cursor.Cursor cursor, uint time)

Grabs the pointer (usually a mouse) so that all events are passed to this application until the pointer is ungrabbed with gdk.global.pointerUngrab, or the grab window becomes unviewable. This overrides any previous pointer grab by this client.

pointerIsGrabbed
bool pointerIsGrabbed()

Returns true if the pointer on the default display is currently grabbed by this application.

pointerUngrab
void pointerUngrab(uint time)

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

preParseLibgtkOnly
void preParseLibgtkOnly()

Prepare for parsing command line arguments for GDK. This is not public API and should not be used in application code.

propertyDelete
void propertyDelete(gdk.window.Window window, gdk.atom.Atom property)

Deletes a property from a window.

propertyGet
bool propertyGet(gdk.window.Window window, gdk.atom.Atom property, gdk.atom.Atom type, gulong offset, gulong length, int pdelete, gdk.atom.Atom actualPropertyType, int actualFormat, ubyte[] data)

Retrieves a portion of the contents of a property. If the property does not exist, then the function returns false, and GDK_NONE will be stored in actual_property_type.

queryDepths
void queryDepths(int[] depths)

This function returns the available bit depths for the default screen. It’s equivalent to listing the visuals (gdk.global.listVisuals) and then looking at the depth field in each visual, removing duplicates.

queryVisualTypes
void queryVisualTypes(gdk.types.VisualType[] visualTypes)

This function returns the available visual types for the default screen. It’s equivalent to listing the visuals (gdk.global.listVisuals) and then looking at the type field in each visual, removing duplicates.

selectionConvert
void selectionConvert(gdk.window.Window requestor, gdk.atom.Atom selection, gdk.atom.Atom target, uint time)

Retrieves the contents of a selection in a given form.

selectionOwnerGet
gdk.window.Window selectionOwnerGet(gdk.atom.Atom selection)

Determines the owner of the given selection.

selectionOwnerGetForDisplay
gdk.window.Window selectionOwnerGetForDisplay(gdk.display.Display display, gdk.atom.Atom selection)

Determine the owner of the given selection.

selectionOwnerSet
bool selectionOwnerSet(gdk.window.Window owner, gdk.atom.Atom selection, uint time, bool sendEvent)

Sets the owner of the given selection.

selectionOwnerSetForDisplay
bool selectionOwnerSetForDisplay(gdk.display.Display display, gdk.window.Window owner, gdk.atom.Atom selection, uint time, bool sendEvent)

Sets the #GdkWindow owner as the current owner of the selection selection.

selectionSendNotify
void selectionSendNotify(gdk.window.Window requestor, gdk.atom.Atom selection, gdk.atom.Atom target, gdk.atom.Atom property, uint time)

Sends a response to SelectionRequest event.

selectionSendNotifyForDisplay
void selectionSendNotifyForDisplay(gdk.display.Display display, gdk.window.Window requestor, gdk.atom.Atom selection, gdk.atom.Atom target, gdk.atom.Atom property, uint time)

Send a response to SelectionRequest event.

setAllowedBackends
void setAllowedBackends(string backends)

Sets a list of backends that GDK should try to use.

setDoubleClickTime
void setDoubleClickTime(uint msec)

Set the double click time for the default display. See gdk.display.Display.setDoubleClickTime. See also gdk.display.Display.setDoubleClickDistance. Applications should not set this, it is a global user-configured setting.

setProgramClass
void setProgramClass(string programClass)

Sets the program class. The X11 backend uses the program class to set the class name part of the WM_CLASS property on toplevel windows; see the ICCCM.

setShowEvents
void setShowEvents(bool showEvents)

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

settingGet
bool settingGet(string name, gobject.value.Value value)

Obtains a desktop-wide setting, such as the double-click time, for the default screen. See gdk.screen.Screen.getSetting.

synthesizeWindowState
void synthesizeWindowState(gdk.window.Window window, gdk.types.WindowState unsetFlags, gdk.types.WindowState setFlags)
testRenderSync
void testRenderSync(gdk.window.Window window)

Retrieves a pixel from window to force the windowing system to carry out any pending rendering commands.

testSimulateButton
bool testSimulateButton(gdk.window.Window window, int x, int y, uint button, gdk.types.ModifierType modifiers, gdk.types.EventType buttonPressrelease)

This function is intended to be used in GTK+ test programs. It will warp the mouse pointer to the given (x,y) coordinates within window and simulate a button press or release event. Because the mouse pointer needs to be warped to the target location, use of this function outside of test programs that run in their own virtual windowing system (e.g. Xvfb) is not recommended.

testSimulateKey
bool testSimulateKey(gdk.window.Window window, int x, int y, uint keyval, gdk.types.ModifierType modifiers, gdk.types.EventType keyPressrelease)

This function is intended to be used in GTK+ test programs. If (x,y) are > (-1,-1), it will warp the mouse pointer to the given (x,y) coordinates within window and simulate a key press or release event.

textPropertyToUtf8ListForDisplay
int textPropertyToUtf8ListForDisplay(gdk.display.Display display, gdk.atom.Atom encoding, int format, ubyte[] text, string[] list)

Converts a text property in the given encoding to a list of UTF-8 strings.

threadsAddIdle
uint threadsAddIdle(int priority, glib.types.SourceFunc function_)

Adds a function to be called whenever there are no higher priority events pending. If the function returns false it is automatically removed from the list of event sources and will not be called again.

threadsAddTimeout
uint threadsAddTimeout(int priority, uint interval, glib.types.SourceFunc function_)

Sets a function to be called at regular intervals holding the GDK lock, with the given priority. The function is called repeatedly until it returns false, at which point the timeout is automatically destroyed and the function will not be called again. The notify function is called when the timeout is destroyed. The first call to the function will be at the end of the first interval.

threadsAddTimeoutSeconds
uint threadsAddTimeoutSeconds(int priority, uint interval, glib.types.SourceFunc function_)

A variant of gdk.global.threadsAddTimeoutFull with second-granularity. See glib.global.timeoutAddSecondsFull for a discussion of why it is a good idea to use this function if you don’t need finer granularity.

threadsEnter
void threadsEnter()

This function marks the beginning of a critical section in which GDK and GTK+ functions can be called safely and without causing race conditions. Only one thread at a time can be in such a critial section.

threadsInit
void threadsInit()

Initializes GDK so that it can be used from multiple threads in conjunction with gdk.global.threadsEnter and gdk.global.threadsLeave.

threadsLeave
void threadsLeave()

Leaves a critical region begun with gdk.global.threadsEnter.

unicodeToKeyval
uint unicodeToKeyval(uint wc)

Convert from a ISO10646 character to a key symbol.

utf8ToStringTarget
string utf8ToStringTarget(string str)

Converts an UTF-8 string into the best possible representation as a STRING. The representation of characters not in STRING is not specified; it may be as pseudo-escape sequences \x{ABCD}, or it may be in some other form of approximation.