Display

gdk.display.Display objects are the GDK 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 gdk.seat.Seat objects. Every display has a one or more seats, which can be accessed with gdk.display.Display.getDefaultSeat and gdk.display.Display.listSeats.

Output devices are represented by gdk.monitor.MonitorG objects, which can be accessed with gdk.display.Display.getMonitorAtSurface and similar APIs.

class Display : ObjectG {

static gdk.display.Display getDefault();

static gdk.display.Display open(string displayName);

void beep();

void close();

gdk.glcontext.GLContext createGlContext();

bool deviceIsGrabbed(gdk.device.Device device);

void flush();

gdk.app_launch_context.AppLaunchContext getAppLaunchContext();

gdk.clipboard.Clipboard getClipboard();

gdk.seat.Seat getDefaultSeat();

gdk.dmabuf_formats.DmabufFormats getDmabufFormats();

gdk.monitor.MonitorG getMonitorAtSurface(gdk.surface.Surface surface);

gio.list_model.ListModel getMonitors();

string getName();

gdk.clipboard.Clipboard getPrimaryClipboard();

bool getSetting(string name, gobject.value.Value value);

string getStartupNotificationId();

bool isClosed();

bool isComposited();

bool isRgba();

gdk.seat.Seat[] listSeats();

bool mapKeycode(uint keycode, gdk.types.KeymapKey[] keys, uint[] keyvals);

bool mapKeyval(uint keyval, gdk.types.KeymapKey[] keys);

void notifyStartupComplete(string startupId);

bool prepareGl();

void putEvent(gdk.event.Event event);

bool supportsInputShapes();

bool supportsShadowWidth();

void sync();

bool translateKey(uint keycode, gdk.types.ModifierType state, int group, uint keyval, int effectiveGroup, int level, gdk.types.ModifierType consumed);

ulong connectClosed(T callback, Flag!"After" after);

ulong connectOpened(T callback, Flag!"After" after);

ulong connectSeatAdded(T callback, Flag!"After" after);

ulong connectSeatRemoved(T callback, Flag!"After" after);

ulong connectSettingChanged(T callback, Flag!"After" after);

}

Members

Functions

beep void beep(): Emits a short beep on display
close void close(): Closes the connection to the windowing system for the given display.
connectClosed ulong connectClosed(T callback, Flag!"After" after): Connect to Closed signal.
connectOpened ulong connectOpened(T callback, Flag!"After" after): Connect to Opened signal.
connectSeatAdded ulong connectSeatAdded(T callback, Flag!"After" after): Connect to SeatAdded signal.
connectSeatRemoved ulong connectSeatRemoved(T callback, Flag!"After" after): Connect to SeatRemoved signal.
connectSettingChanged ulong connectSettingChanged(T callback, Flag!"After" after): Connect to SettingChanged signal.
createGlContext gdk.glcontext.GLContext createGlContext(): Creates a new gdk.glcontext.GLContext for the gdk.display.Display.
deviceIsGrabbed bool deviceIsGrabbed(gdk.device.Device device): Returns true if there is an ongoing grab on device for display.
flush void flush(): Flushes any requests queued for the windowing system.
getAppLaunchContext gdk.app_launch_context.AppLaunchContext getAppLaunchContext(): Returns a gdk.app_launch_context.AppLaunchContext suitable for launching applications on the given display.
getClipboard gdk.clipboard.Clipboard getClipboard(): Gets the clipboard used for copy/paste operations.
getDefaultSeat gdk.seat.Seat getDefaultSeat(): Returns the default gdk.seat.Seat for this display.
getDmabufFormats gdk.dmabuf_formats.DmabufFormats getDmabufFormats(): Returns the dma-buf formats that are supported on this display.
getMonitorAtSurface gdk.monitor.MonitorG getMonitorAtSurface(gdk.surface.Surface surface): Gets the monitor in which the largest area of surface resides.
getMonitors gio.list_model.ListModel getMonitors(): Gets the list of monitors associated with this display.
getName string getName(): Gets the name of the display.
getPrimaryClipboard gdk.clipboard.Clipboard getPrimaryClipboard(): Gets the clipboard used for the primary selection.
getSetting bool getSetting(string name, gobject.value.Value value): Retrieves a desktop-wide setting such as double-click time for the display.
getStartupNotificationId string getStartupNotificationId(): Gets the startup notification ID for a Wayland display, or null if no ID has been defined.
isClosed bool isClosed(): Finds out if the display has been closed.
isComposited bool isComposited(): Returns whether surfaces can reasonably be expected to have their alpha channel drawn correctly on the screen.
isRgba bool isRgba(): Returns whether surfaces on this display are created with an alpha channel.
listSeats gdk.seat.Seat[] listSeats(): Returns the list of seats known to display.
mapKeycode bool mapKeycode(uint keycode, gdk.types.KeymapKey[] keys, uint[] keyvals): Returns the keyvals bound to keycode.
mapKeyval bool mapKeyval(uint keyval, gdk.types.KeymapKey[] keys): Obtains a list of keycode/group/level combinations that will generate keyval.
notifyStartupComplete void notifyStartupComplete(string startupId): Indicates to the GUI environment that the application has finished loading, using a given identifier.
prepareGl bool prepareGl(): 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.
putEvent void putEvent(gdk.event.Event event): Adds the given event to the event queue for display.
supportsInputShapes bool supportsInputShapes(): Returns true if the display supports input shapes.
supportsShadowWidth bool supportsShadowWidth(): Returns whether it's possible for a surface to draw outside of the window area.
sync void sync(): Flushes any requests queued for the windowing system and waits until all requests have been handled.
translateKey bool translateKey(uint keycode, gdk.types.ModifierType state, int group, uint keyval, int effectiveGroup, int level, gdk.types.ModifierType consumed): Translates the contents of a gdk.event_key.EventKey into a keyval, effective group, and level.

Static functions

getDefault gdk.display.Display getDefault(): Gets the default gdk.display.Display.
open gdk.display.Display open(string displayName): Opens a display.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

gdk display classes

Display