class: DisplaySeataddedCallback

[724:7] extends: object

Generated low-level callback wrapper for GIR callback seat-added.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• DisplaySeataddedCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, seat, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: DisplaySettingchangedCallback

[866:7] extends: object

Generated low-level callback wrapper for GIR callback setting-changed.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• DisplaySettingchangedCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, setting, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: DisplayMeta

[936:14] static extends: object

Generated metadata helpers for Display class surfaces.

Methods

• properties ()

  Returns property metadata for Display.

  • @r A list.

• signals ()

  Returns signal metadata for Display.

  • @r A list.

class: DisplaySeatremovedCallback

[795:7] extends: object

Generated low-level callback wrapper for GIR callback seat-removed.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• DisplaySeatremovedCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, seat, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: DisplayClosedCallback

[583:7] extends: object

Generated low-level callback wrapper for GIR callback closed.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• DisplayClosedCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, is_error, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: DisplayOpenedCallback

[654:7] extends: object

Generated low-level callback wrapper for GIR callback opened.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• DisplayOpenedCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: Display

[21:7] extends: object

A representation of a workstation. Their purpose are two-fold: - To manage and provide information about input devices (pointers, keyboards, etc) - To manage and provide information about output devices (monitors, projectors, etc) Most of the input device handling has been factored out into separate [class@Gdk.Seat] objects. Every display has a one or more seats, which can be accessed with [method@Gdk.Display.get_default_seat] and [method@Gdk.Display.list_seats]. Output devices are represented by [class@Gdk.Monitor] objects, which can be accessed with [method@Gdk.Display.get_monitor_at_surface] and similar APIs.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• Display (Handle = null)

  Creates a new Display by wrapping a native handle or another wrapper.

  • @p Handle is the native handle or another wrapper whose handle to adopt.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asObject ()

  Wraps this handle as Object.

  • @r A Object object.

• connectSignal (string Name, CallbackObj)

  Connects one generated callback wrapper to a named signal.

  • @p Name is the signal name.
  • @p CallbackObj is the generated callback wrapper to connect.
  • @r The connected handler id.

• disconnectSignalHandler (int HandlerId)

  Disconnects one retained signal handler id.

  • @p HandlerId is the signal handler id to disconnect.
  • @r None.

• setOnClosed (callback Fn, UserData = null)

  Emitted when the connection to the windowing system for @display is closed.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Display Self, bool Is_error).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnOpened (callback Fn, UserData = null)

  Emitted when the connection to the windowing system for @display is opened.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Display Self).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnSeatadded (callback Fn, UserData = null)

  Emitted whenever a new seat is made known to the windowing system.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Display Self, Seat Seat).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnSeatremoved (callback Fn, UserData = null)

  Emitted whenever a seat is removed by the windowing system.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Display Self, Seat Seat).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnSettingchanged (callback Fn, UserData = null)

  Emitted whenever a setting changes its value.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Display Self, string Setting).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• beep ()

  Emits a short beep on @display

  • @r None.

• close ()

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

  • @r None.

• create_gl_context ()

  Creates a new GdkGLContext for the GdkDisplay. The context is disconnected from any particular surface or surface and cannot be used to draw to any surface. It can only be used to draw to non-surface framebuffers like textures. If the creation of the GdkGLContext failed,

  • @error will be set. Before using the returned GdkGLContext, you will need to call [method@Gdk.GLContext.make_current] or [method@Gdk.GLContext.realize].

• device_is_grabbed (object device)

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

  • @p device is a GdkDevice.

• flush ()

  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 explicitly. 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.

  • @r None.

• get_app_launch_context ()

  Returns a GdkAppLaunchContext suitable for launching applications on the given display.

• get_clipboard ()

  Gets the clipboard used for copy/paste operations.

• get_default_seat ()

  Returns the default GdkSeat for this display. Note that a display may not have a seat. In this case, this function will return %NULL.

• get_dmabuf_formats ()

  Returns the dma-buf formats that are supported on this display. GTK may use OpenGL or Vulkan to support some formats. Calling this function will then initialize them if they aren't yet. The formats returned by this function can be used for negotiating buffer formats with producers such as v4l, pipewire or GStreamer. To learn more about dma-bufs, see [class@Gdk.DmabufTextureBuilder]. This function is threadsafe. It can be called from any thread.

• get_monitor_at_surface (object surface)

  Gets the monitor in which the largest area of @surface resides.

  • @p surface is a GdkSurface.

• get_monitors ()

  Gets the list of monitors associated with this display. Subsequent calls to this function will always return the same list for the same display. You can listen to the GListModel::items-changed signal on this list to monitor changes to the monitor of this display.

• get_name ()

  Gets the name of the display.

• get_primary_clipboard ()

  Gets the clipboard used for the primary selection. On backends where the primary clipboard is not supported natively, GDK emulates this clipboard locally.

• get_setting (string name, object value)

  Retrieves a desktop-wide setting such as double-click time for the

  • @display. ``
  • @p name is the name of the setting.
  • @p value is location to store the value of the setting.

• get_startup_notification_id ()

  Gets the startup notification ID for a Wayland display, or %NULL if no ID has been defined.

• is_closed ()

  Finds out if the display has been closed.

• is_composited ()

  Returns whether surfaces can reasonably be expected to have their alpha channel drawn correctly on the screen. Check [method@Gdk.Display.is_rgba] for whether the display supports an alpha channel. On X11 this function returns whether a compositing manager is compositing on @display. On modern displays, this value is always %TRUE.

• is_rgba ()

  Returns whether surfaces on this @display are created with an alpha channel. Even if a %TRUE is returned, it is possible that the surface’s alpha channel won’t be honored when displaying the surface on the screen: in particular, for X an appropriate windowing manager and compositing manager must be running to provide appropriate display. Use [method@Gdk.Display.is_composited] to check if that is the case. On modern displays, this value is always %TRUE.

• list_seats ()

  Returns the list of seats known to @display.

• notify_startup_complete (string startup_id)

  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.

  • @p startup_id is a startup-notification identifier, for which notification process should be completed.
  • @r None.

• prepare_gl ()

  Checks that OpenGL is available for @self and ensures that it is properly initialized. When this fails, an @error will be set describing the error and this function returns %FALSE. Note that even if this function succeeds, creating a GdkGLContext may still fail. This function is idempotent. Calling it multiple times will just return the same value or error. You never need to call this function, GDK will call it automatically as needed. But you can use it as a check when setting up code that might make use of OpenGL.

• put_event (object event)

  Adds the given event to the event queue for @display.

  • @p event is a GdkEvent.
  • @r None.

• supports_input_shapes ()

  Returns %TRUE if the display supports input shapes. This means that [method@Gdk.Surface.set_input_region] can be used to modify the input shape of surfaces on @display. On modern displays, this value is always %TRUE.

• supports_shadow_width ()

  Returns whether it's possible for a surface to draw outside of the window area. If %TRUE is returned the application decides if it wants to draw shadows. If %FALSE is returned, the compositor decides if it wants to draw shadows.

• sync ()

  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 [method@Gdk.Display.sync] before [method@GdkX11.Display.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.

  • @r None.

• monitors ()

  Returns get_monitors as an Aussom list of wrapper objects. This companion method materializes the full collection up front; use get_monitors() when lazy or change-notify access is required.

  • @r An Aussom list of elements.

• seats ()

  Returns list_seats as an Aussom list of wrapper objects. This companion method materializes the full collection up front; use list_seats() when lazy or change-notify access is required.

  • @r An Aussom list of elements.