gdk.global

Global functions for gdk3 library

fn addOptionEntriesLibgtkOnly beep cairoCreate cairoDrawFromGl cairoGetClipRectangle cairoGetDrawingContext cairoRectangle cairoRegion cairoRegionCreateFromSurface cairoSetSourceColor cairoSetSourcePixbuf cairoSetSourceRgba cairoSetSourceWindow cairoSurfaceCreateFromPixbuf disableMultidevice dragAbort dragDrop dragDropDone dragDropSucceeded dragFindWindowForScreen dragGetSelection dragMotion dragStatus dropFinish dropReply errorTrapPop errorTrapPopIgnored errorTrapPush eventsGetAngle eventsGetCenter eventsGetDistance eventsPending flush getDefaultRootWindow getDisplay getDisplayArgName getProgramClass getShowEvents keyboardGrab keyboardUngrab keyvalConvertCase keyvalFromName keyvalIsLower keyvalIsUpper keyvalName keyvalToLower keyvalToUnicode keyvalToUpper listVisuals notifyStartupComplete notifyStartupCompleteWithId offscreenWindowGetEmbedder offscreenWindowGetSurface offscreenWindowSetEmbedder pangoContextGet pangoContextGetForDisplay pangoContextGetForScreen pixbufGetFromSurface pixbufGetFromWindow pointerGrab pointerIsGrabbed pointerUngrab preParseLibgtkOnly propertyDelete propertyGet queryDepths queryVisualTypes selectionConvert selectionOwnerGet selectionOwnerGetForDisplay selectionOwnerSet selectionOwnerSetForDisplay selectionSendNotify selectionSendNotifyForDisplay setAllowedBackends setDoubleClickTime setProgramClass setShowEvents settingGet synthesizeWindowState testRenderSync testSimulateButton testSimulateKey textPropertyToUtf8ListForDisplay threadsAddIdle threadsAddTimeout threadsAddTimeoutSeconds threadsEnter threadsInit threadsLeave unicodeToKeyval utf8ToStringTarget

Functions 92

fnvoid 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.
fnvoid beep()Emits a short beep on the default display.
fncairo.context.Context cairoCreate(gdk.window.Window window)Creates a Cairo context for drawing to window.
fnvoid 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 (sourcetype == #GLRENDERBUFFER) or a texture id (sourcetype == #GLTEXTURE) and draws it onto cr with an OVER operation, ...
fnbool cairoGetClipRectangle(cairo.context.Context cr, out 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.
fngdk.drawing_context.DrawingContext cairoGetDrawingContext(cairo.context.Context cr)Retrieves the #GdkDrawingContext that created the Cairo context cr.
fnvoid cairoRectangle(cairo.context.Context cr, gdk.rectangle.Rectangle rectangle)Adds the given rectangle to the current path of cr.
fnvoid cairoRegion(cairo.context.Context cr, cairo.region.Region region)Adds the given region to the current path of cr.
fncairo.region.Region cairoRegionCreateFromSurface(cairo.surface.Surface surface)Creates region that describes covers the area where the given surface is more than 50% opaque.
fnvoid cairoSetSourceColor(cairo.context.Context cr, gdk.color.Color color)Sets the specified #GdkColor as the source color of cr.
fnvoid cairoSetSourcePixbuf(cairo.context.Context cr, gdkpixbuf.pixbuf.Pixbuf pixbuf, double pixbufX, double pixbufY)Sets the given pixbuf as the source pattern for cr.
fnvoid cairoSetSourceRgba(cairo.context.Context cr, gdk.rgba.RGBA rgba)Sets the specified #GdkRGBA as the source color of cr.
fnvoid cairoSetSourceWindow(cairo.context.Context cr, gdk.window.Window window, double x, double y)Sets the given window as the source pattern for cr.
fncairo.surface.Surface cairoSurfaceCreateFromPixbuf(gdkpixbuf.pixbuf.Pixbuf pixbuf, int scale, gdk.window.Window forWindow = null)Creates an image surface with the same contents as the pixbuf.
fnvoid 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.
fnvoid dragAbort(gdk.drag_context.DragContext context, uint time)Aborts a drag without dropping.
fnvoid dragDrop(gdk.drag_context.DragContext context, uint time)Drops on the current destination.
fnvoid 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.
fnbool 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 a...
fnvoid dragFindWindowForScreen(gdk.drag_context.DragContext context, gdk.window.Window dragWindow, gdk.screen.Screen screen, int xRoot, int yRoot, out gdk.window.Window destWindow, out gdk.types.DragProtocol protocol)Finds the destination window and DND protocol to use at the given pointer position.
fngdk.atom.Atom dragGetSelection(gdk.drag_context.DragContext context)Returns the selection atom for the current source window.
fnbool 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.
fnvoid dragStatus(gdk.drag_context.DragContext context, gdk.types.DragAction action, uint time)Selects one of the actions offered by the drag source.
fnvoid dropFinish(gdk.drag_context.DragContext context, bool success, uint time)Ends the drag operation after a drop.
fnvoid dropReply(gdk.drag_context.DragContext context, bool accepted, uint time)Accepts or rejects a drop.
fnint 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 preferre...
fnvoid 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...
fnvoid 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...
fnbool eventsGetAngle(gdk.event.Event event1, gdk.event.Event event2, out 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 ...
fnbool eventsGetCenter(gdk.event.Event event1, gdk.event.Event event2, out double x, out double y)If both events contain X/Y information, the center of both coordinates will be returned in `x` and `y`.
fnbool eventsGetDistance(gdk.event.Event event1, gdk.event.Event event2, out 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.
fnbool eventsPending()Checks if any events are ready to be processed for any display. Returns: true if any events are pending.
fnvoid flush()Flushes the output buffers of all display connections and waits until all requests have been processed. This is rarely needed by applications.
fngdk.window.Window getDefaultRootWindow()Obtains the root window (parent all other windows are inside) for the default display and screen. Returns: the default root window
fnstring getDisplay()Gets the name of the display, which usually comes from the `DISPLAY` environment variable or the `--display` command line option. Returns: the name of the display.
fnstring getDisplayArgName()Gets the display name specified in the command line arguments passed to [gdk.global.init_] or [gdk.global.parseArgs], if any. Returns: the display name, if specified explicitly, otherwise null this...
fnstring 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 (determine...
fnbool getShowEvents()Gets whether event debugging output is enabled. Returns: true if event debugging output is enabled.
fngdk.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.
fnvoid keyboardUngrab(uint time)Ungrabs the keyboard on the default display, if it is grabbed by this application.
fnvoid keyvalConvertCase(uint symbol, out uint lower, out uint upper)Obtains the upper- and lower-case versions of the keyval symbol. Examples of keyvals are #GDKKEYa, #GDKKEYEnter, #GDKKEYF1, etc.
fnuint keyvalFromName(string keyvalName)Converts a key name to a key value.
fnbool keyvalIsLower(uint keyval)Returns true if the given key value is in lower case.
fnbool keyvalIsUpper(uint keyval)Returns true if the given key value is in upper case.
fnstring keyvalName(uint keyval)Converts a key value into a symbolic name.
fnuint keyvalToLower(uint keyval)Converts a key value to lower case, if applicable.
fnuint keyvalToUnicode(uint keyval)Convert from a GDK key symbol to the corresponding ISO10646 (Unicode) character.
fnuint keyvalToUpper(uint keyval)Converts a key value to upper case, if applicable.
fngdk.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...
fnvoid 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 wind...
fnvoid notifyStartupCompleteWithId(string startupId)Indicates to the GUI environment that the application has finished loading, using a given identifier.
fngdk.window.Window offscreenWindowGetEmbedder(gdk.window.Window window)Gets the window that window is embedded in.
fncairo.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.
fnvoid offscreenWindowSetEmbedder(gdk.window.Window window, gdk.window.Window embedder)Sets window to be embedded in embedder.
fnpango.context.Context pangoContextGet()Creates a #PangoContext for the default GDK screen.
fnpango.context.Context pangoContextGetForDisplay(gdk.display.Display display)Creates a #PangoContext for display.
fnpango.context.Context pangoContextGetForScreen(gdk.screen.Screen screen)Creates a #PangoContext for screen.
fngdkpixbuf.pixbuf.Pixbuf pixbufGetFromSurface(cairo.surface.Surface surface, int srcX, int srcY, int width, int height)Transfers image data from a #cairosurfacet and converts it to an RGB(A) representation inside a #GdkPixbuf. This allows you to efficiently read individual pixels from cairo surfaces. For #GdkWindow...
fngdkpixbuf.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.
fngdk.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 ove...
fnbool pointerIsGrabbed()Returns true if the pointer on the default display is currently grabbed by this application.
fnvoid pointerUngrab(uint time)Ungrabs the pointer on the default display, if it is grabbed by this application.
fnvoid preParseLibgtkOnly()Prepare for parsing command line arguments for GDK. This is not public API and should not be used in application code.
fnvoid propertyDelete(gdk.window.Window window, gdk.atom.Atom property)Deletes a property from a window.
fnbool propertyGet(gdk.window.Window window, gdk.atom.Atom property, gdk.atom.Atom type, gulong offset, gulong length, int pdelete, out gdk.atom.Atom actualPropertyType, out int actualFormat, out ubyte[] data)Retrieves a portion of the contents of a property. If the property does not exist, then the function returns false, and `GDKNONE` will be stored in actualproperty_type.
fnvoid queryDepths(out 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, removi...
fnvoid queryVisualTypes(out 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, remov...
fnvoid 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.
fngdk.window.Window selectionOwnerGet(gdk.atom.Atom selection)Determines the owner of the given selection.
fngdk.window.Window selectionOwnerGetForDisplay(gdk.display.Display display, gdk.atom.Atom selection)Determine the owner of the given selection.
fnbool selectionOwnerSet(gdk.window.Window owner, gdk.atom.Atom selection, uint time, bool sendEvent)Sets the owner of the given selection.
fnbool 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.
fnvoid 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.
fnvoid 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.
fnvoid setAllowedBackends(string backends)Sets a list of backends that GDK should try to use.
fnvoid 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 glo...
fnvoid 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.
fnvoid 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.
fnbool 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].
fnvoid synthesizeWindowState(gdk.window.Window window, gdk.types.WindowState unsetFlags, gdk.types.WindowState setFlags)
fnvoid testRenderSync(gdk.window.Window window)Retrieves a pixel from window to force the windowing system to carry out any pending rendering commands.
fnbool 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...
fnbool 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 r...
fnint textPropertyToUtf8ListForDisplay(gdk.display.Display display, gdk.atom.Atom encoding, int format, ubyte[] text, out string[] list)Converts a text property in the given encoding to a list of UTF-8 strings.
fnuint 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 a...
fnuint 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 automatical...
fnuint 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 f...
fnvoid 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 ...
fnvoid threadsInit()Initializes GDK so that it can be used from multiple threads in conjunction with [gdk.global.threadsEnter] and [gdk.global.threadsLeave].
fnvoid threadsLeave()Leaves a critical region begun with [gdk.global.threadsEnter].
fnuint unicodeToKeyval(uint wc)Convert from a ISO10646 character to a key symbol.
fnstring 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...