Display

gdk.Display objects purpose are two fold:

- To manage and provide information about input devices (pointers and keyboards)

- To manage and provide information about the available gdk.Screens

GdkDisplay objects are the GDK representation of an X Display, which can be described as a workstation consisting of a keyboard, a pointing device (such as a mouse) and one or more screens. It is used to open and keep track of various GdkScreen objects currently instantiated by the application. It is also used to access the keyboard(s) and mouse pointer(s) of the display.

Most of the input device handling has been factored out into the separate gdk.DeviceManager object. Every display has a device manager, which you can obtain using Display.getDeviceManager.

class Display : ObjectG {}

Constructors

this
this(GdkDisplay* gdkDisplay, bool ownedRef = false)

Sets our main struct and passes it to the parent class.

Members

Functions

addOnClosed
gulong addOnClosed(void delegate(bool, Display) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::closed signal is emitted when the connection to the windowing system for display is closed.

addOnMonitorAdded
gulong addOnMonitorAdded(void delegate(MonitorG, Display) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::monitor-added signal is emitted whenever a monitor is added.

addOnMonitorRemoved
gulong addOnMonitorRemoved(void delegate(MonitorG, Display) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::monitor-removed signal is emitted whenever a monitor is removed.

addOnOpened
gulong addOnOpened(void delegate(Display) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::opened signal is emitted when the connection to the windowing system for display is opened.

addOnSeatAdded
gulong addOnSeatAdded(void delegate(Seat, Display) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::seat-added signal is emitted whenever a new seat is made known to the windowing system.

addOnSeatRemoved
gulong addOnSeatRemoved(void delegate(Seat, Display) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::seat-removed signal is emitted whenever a seat is removed by the windowing system.

beep
void beep()

Emits a short beep on display

close
void close()

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

deviceIsGrabbed
bool deviceIsGrabbed(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; 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.

getAppLaunchContext
AppLaunchContext getAppLaunchContext()

Returns a gdk.AppLaunchContext suitable for launching applications on the given display.

getDefaultCursorSize
uint getDefaultCursorSize()

Returns the default size to use for cursors on display.

getDefaultGroup
Window getDefaultGroup()

Returns the default group leader window for all toplevel windows on display. This window is implicitly created by GDK. See Window.setGroup.

getDefaultScreen
Screen getDefaultScreen()

Get the default gdk.Screen for display.

getDefaultSeat
Seat getDefaultSeat()

Returns the default gdk.Seat for this display.

getDeviceManager
DeviceManager getDeviceManager()

Returns the gdk.DeviceManager associated to display.

getDisplayStruct
GdkDisplay* getDisplayStruct(bool transferOwnership = false)

Get the main Gtk struct

getEvent
Event getEvent()

Gets the next gdk.Event to be processed for display, fetching events from the windowing system if necessary.

getMaximalCursorSize
void getMaximalCursorSize(out uint width, out uint height)

Gets the maximal size to use for cursors on display.

getMonitor
MonitorG getMonitor(int monitorNum)

Gets a monitor associated with this display.

getMonitorAtPoint
MonitorG getMonitorAtPoint(int x, int y)

Gets the monitor in which the point (x, y) is located, or a nearby monitor if the point is not in any monitor.

getMonitorAtWindow
MonitorG getMonitorAtWindow(Window window)

Gets the monitor in which the largest area of window resides, or a monitor close to window if it is outside of all monitors.

getNMonitors
int getNMonitors()

Gets the number of monitors that belong to display.

getNScreens
int getNScreens()

Gets the number of screen managed by the display.

getName
string getName()

Gets the name of the display.

getPointer
void getPointer(out Screen screen, out int x, out int y, out GdkModifierType mask)

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

getPrimaryMonitor
MonitorG getPrimaryMonitor()

Gets the primary monitor for the display.

getScreen
Screen getScreen(int screenNum)

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

getStruct
void* getStruct()

the main Gtk struct as a void*

getWindowAtPointer
Window getWindowAtPointer(out int winX, out int winY)

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

hasPending
bool hasPending()

Returns whether the display has events that are waiting to be processed.

isClosed
bool isClosed()

Finds out if the display has been closed.

keyboardUngrab
void keyboardUngrab(uint time)

Release any keyboard grab

listDevices
ListG listDevices()

Returns the list of available input devices attached to display. The list is statically allocated and should not be freed.

listSeats
ListG listSeats()

Returns the list of seats known to display.

notifyStartupComplete
void notifyStartupComplete(string startupId)

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

peekEvent
Event peekEvent()

Gets a copy of the first gdk.Event 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.)

pointerIsGrabbed
bool pointerIsGrabbed()

Test if the pointer is grabbed.

pointerUngrab
void pointerUngrab(uint time)

Release any pointer grab.

putEvent
void putEvent(Event event)

Appends a copy of the given event onto the front of the event queue for display.

requestSelectionNotification
bool requestSelectionNotification(GdkAtom selection)

Request GdkEventOwnerChange events for ownership changes of the selection named by the given atom.

setDoubleClickDistance
void setDoubleClickDistance(uint distance)

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 Display.setDoubleClickTime. Applications should not set this, it is a global user-configured setting.

setDoubleClickTime
void setDoubleClickTime(uint msec)

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 not set this, it is a global user-configured setting.

storeClipboard
void storeClipboard(Window clipboardWindow, uint time, GdkAtom[] targets)

Issues a request to the clipboard manager to store the clipboard data. On X11, this is a special program that works according to the FreeDesktop Clipboard Specification.

supportsClipboardPersistence
bool supportsClipboardPersistence()

Returns whether the speicifed display supports clipboard persistance; i.e. if it’s possible to store the clipboard data after an application has quit. On X11 this checks if a clipboard daemon is running.

supportsComposite
bool supportsComposite()

Returns TRUE if Window.setComposited can be used to redirect drawing on the window using compositing.

supportsCursorAlpha
bool supportsCursorAlpha()

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

supportsCursorColor
bool supportsCursorColor()

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

supportsInputShapes
bool supportsInputShapes()

Returns TRUE if Window.inputShapeCombineMask can be used to modify the input shape of windows on display.

supportsSelectionNotification
bool supportsSelectionNotification()

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

supportsShapes
bool supportsShapes()

Returns TRUE if Window.shapeCombineMask can be used to create shaped windows on display.

sync
void 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 Display.sync before gdk_error_trap_pop() makes sure that any errors generated from earlier requests are handled before the error trap is removed.

warpPointer
void warpPointer(Screen screen, int x, int y)

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.

Static functions

getDefault
Display getDefault()

Gets the default gdk.Display This is a convenience function for: gdk_display_manager_get_default_display (gdk_display_manager_get ()).

getType
GType getType()
open
Display open(string displayName)

Opens a display.

openDefaultLibgtkOnly
Display openDefaultLibgtkOnly()

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.

Variables

gdkDisplay
GdkDisplay* gdkDisplay;

the main Gtk struct

Inherited Members

From ObjectG

gObject
GObject* gObject;

the main Gtk struct

getObjectGStruct
GObject* getObjectGStruct(bool transferOwnership = false)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

opCast
T opCast()
getDObject
RT getDObject(U obj, bool ownedRef = false)

Gets a D Object from the objects table of associations.

setProperty
void setProperty(string propertyName, T value)
addOnNotify
gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property = "", ConnectFlags connectFlags = cast(ConnectFlags)0)

The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.

getType
GType getType()
compatControl
size_t compatControl(size_t what, void* data)
interfaceFindProperty
ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName)

Find the gobject.ParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

interfaceInstallProperty
void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec)

Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created gobject.ParamSpec, but normally ObjectClass.overrideProperty will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

interfaceListProperties
ParamSpec[] interfaceListProperties(TypeInterface gIface)

Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

addToggleRef
void addToggleRef(GToggleNotify notify, void* data)

Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.

addWeakPointer
void addWeakPointer(ref void* weakPointerLocation)

Adds a weak reference from weak_pointer to object to indicate that the pointer located at weak_pointer_location is only valid during the lifetime of object. When the object is finalized, weak_pointer will be set to NULL.

bindProperty
Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags)

Creates a binding between source_property on source and target_property on target. Whenever the source_property is changed the target_property is updated using the same value. For instance:

bindPropertyFull
Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify)

Complete version of g_object_bind_property().

bindPropertyWithClosures
Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, 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.

dupData
void* dupData(string key, GDuplicateFunc dupFunc, void* userData)

This is a variant of g_object_get_data() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.

dupQdata
void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData)

This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.

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 g_object_ref_sink().

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 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 g_object_set_data()).

getProperty
void getProperty(string propertyName, Value value)

Gets a property of an object. value must have been initialized to the expected type of the property (or a type to which the expected type can be transformed) using Value.init.

getQdata
void* getQdata(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata().

getValist
void getValist(string firstPropertyName, void* varArgs)

Gets properties of an object.

getv
void getv(string[] names, 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(ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

doref
ObjectG doref()

Increases the reference count of object.

refSink
ObjectG refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

removeToggleRef
void removeToggleRef(GToggleNotify notify, void* data)

Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.

removeWeakPointer
void removeWeakPointer(ref void* weakPointerLocation)

Removes a weak reference from object that was previously added using g_object_add_weak_pointer(). The weak_pointer_location has to match the one used with g_object_add_weak_pointer().

replaceData
bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, out GDestroyNotify oldDestroy)

Compares the user data for the key key on object with oldval, and if they are the same, replaces oldval with newval.

replaceQdata
bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, out GDestroyNotify oldDestroy)

Compares the user data for the key quark on object with oldval, and if they are the same, replaces oldval with newval.

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.

setDataFull
void setDataFull(string key, void* data, GDestroyNotify destroy)

Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.

setProperty
void setProperty(string propertyName, Value value)

Sets a property on an object.

setQdata
void setQdata(GQuark quark, void* data)

This sets an opaque, named pointer on an object. The name is specified through a GQuark (retrived e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the object with g_object_get_qdata() until the object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using NULL as pointer essentially removes the data stored.

setQdataFull
void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy)

This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with data as argument when the object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same quark.

setValist
void setValist(string firstPropertyName, void* varArgs)

Sets properties on an object.

setv
void setv(string[] names, Value[] values)

Sets n_properties properties for an object. Properties to be set will be taken from values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

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(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata() 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 g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

unref
void unref()

Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

watchClosure
void watchClosure(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 Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_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.

weakRef
void weakRef(GWeakNotify notify, void* data)

Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).

weakUnref
void weakUnref(GWeakNotify notify, void* data)

Removes a weak reference callback to an object.

clearObject
void clearObject(ref ObjectG objectPtr)

Clears a reference to a GObject

Meta