Screen

gdk.Screen objects are the GDK representation of the screen on which windows can be displayed and on which the pointer moves. X originally identified screens with physical screens, but nowadays it is more common to have a single gdk.Screen which combines several physical monitors (see Screen.getNMonitors).

GdkScreen is used throughout GDK and GTK+ to specify which screen the top level windows are to be displayed on. it is also used to query the screen specification and default settings such as the default visual (Screen.getSystemVisual), the dimensions of the physical monitors (Screen.getMonitorGeometry), etc.

Constructors

this
this(GdkScreen* gdkScreen, bool ownedRef = false)

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

Members

Functions

addOnCompositedChanged
gulong addOnCompositedChanged(void delegate(Screen) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::composited-changed signal is emitted when the composited status of the screen changes

addOnMonitorsChanged
gulong addOnMonitorsChanged(void delegate(Screen) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::monitors-changed signal is emitted when the number, size or position of the monitors attached to the screen change.

addOnSizeChanged
gulong addOnSizeChanged(void delegate(Screen) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::size-changed signal is emitted when the pixel width or height of a screen changes.

getActiveWindow
Window getActiveWindow()

Returns the screen’s currently active window.

getDisplay
Display getDisplay()

Gets the display to which the screen belongs.

getFontOptions
FontOption getFontOptions()

Gets any options previously set with Screen.setFontOptions.

getHeight
int getHeight()

Gets the height of screen in pixels. The returned size is in ”application pixels”, not in ”device pixels” (see Screen.getMonitorScaleFactor).

getHeightMm
int getHeightMm()

Returns the height of screen in millimeters.

getMonitorAtPoint
int getMonitorAtPoint(int x, int y)

Returns the monitor number in which the point (x,y) is located.

getMonitorAtWindow
int getMonitorAtWindow(Window window)

Returns the number of the monitor in which the largest area of the bounding rectangle of window resides.

getMonitorGeometry
void getMonitorGeometry(int monitorNum, out GdkRectangle dest)

Retrieves the gdk.Rectangle representing the size and position of the individual monitor within the entire screen area. The returned geometry is in ”application pixels”, not in ”device pixels” (see Screen.getMonitorScaleFactor).

getMonitorHeightMm
int getMonitorHeightMm(int monitorNum)

Gets the height in millimeters of the specified monitor.

getMonitorPlugName
string getMonitorPlugName(int monitorNum)

Returns the output name of the specified monitor. Usually something like VGA, DVI, or TV, not the actual product name of the display device.

getMonitorScaleFactor
int getMonitorScaleFactor(int monitorNum)

Returns the internal scale factor that maps from monitor coordinates to the actual device pixels. On traditional systems this is 1, but on very high density outputs this can be a higher value (often 2).

getMonitorWidthMm
int getMonitorWidthMm(int monitorNum)

Gets the width in millimeters of the specified monitor, if available.

getMonitorWorkarea
void getMonitorWorkarea(int monitorNum, out GdkRectangle dest)

Retrieves the gdk.Rectangle representing the size and position of the “work area” on a monitor within the entire screen area. The returned geometry is in ”application pixels”, not in ”device pixels” (see Screen.getMonitorScaleFactor).

getNMonitors
int getNMonitors()

Returns the number of monitors which screen consists of.

getNumber
int getNumber()

Gets the index of screen among the screens in the display to which it belongs. (See Screen.getDisplay)

getPrimaryMonitor
int getPrimaryMonitor()

Gets the primary monitor for screen. The primary monitor is considered the monitor where the “main desktop” lives. While normal application windows typically allow the window manager to place the windows, specialized desktop applications such as panels should place themselves on the primary monitor.

getResolution
double getResolution()

Gets the resolution for font handling on the screen; see Screen.setResolution for full details.

getRgbaVisual
Visual getRgbaVisual()

Gets a visual to use for creating windows with an alpha channel. The windowing system on which GTK+ is running may not support this capability, in which case NULL will be returned. Even if a non-NULL value is returned, its possible that the window’s alpha channel won’t be honored when displaying the window on the screen: in particular, for X an appropriate windowing manager and compositing manager must be running to provide appropriate display.

getRootWindow
Window getRootWindow()

Gets the root window of screen.

getScreenStruct
GdkScreen* getScreenStruct(bool transferOwnership = false)

Get the main Gtk struct

getSetting
bool getSetting(string name, Value value)

Retrieves a desktop-wide setting such as double-click time for the gdk.Screen screen.

getStruct
void* getStruct()

the main Gtk struct as a void*

getSystemVisual
Visual getSystemVisual()

Get the system’s default visual for screen. This is the visual for the root window of the display. The return value should not be freed.

getToplevelWindows
ListG getToplevelWindows()

Obtains a list of all toplevel windows known to GDK on the screen screen. A toplevel window is a child of the root window (see gdk_get_default_root_window()).

getWidth
int getWidth()

Gets the width of screen in pixels. The returned size is in ”application pixels”, not in ”device pixels” (see Screen.getMonitorScaleFactor).

getWidthMm
int getWidthMm()

Gets the width of screen in millimeters.

getWindowStack
ListG getWindowStack()

Returns a GList of gdk.Windows representing the current window stack.

isComposited
bool isComposited()

Returns whether windows with an RGBA visual can reasonably be expected to have their alpha channel drawn correctly on the screen.

listVisuals
ListG listVisuals()

Lists the available visuals for the specified screen. 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.

makeDisplayName
string makeDisplayName()

Determines the name to pass to Display.open to get a gdk.Display with this screen as the default screen.

setFontOptions
void setFontOptions(FontOption options)

Sets the default font options for the screen. These options will be set on any gstreamer.Context’s newly created with Pango.contextGetForScreen. Changing the default set of font options does not affect contexts that have already been created.

setResolution
void setResolution(double dpi)

Sets the resolution for font handling on the screen. This is a scale factor between points specified in a PangoFontDescription and cairo units. The default value is 96, meaning that a 10 point font will be 13 units high. (10 * 96. / 72. = 13.3).

Static functions

getDefault
Screen getDefault()

Gets the default screen for the default display. (See gdk_display_get_default ()).

getType
GType getType()
height
int height()

Gets the height of the default screen in pixels. The returned size is in ”application pixels”, not in ”device pixels” (see Screen.getMonitorScaleFactor).

heightMm
int heightMm()

Returns the height of the default screen in millimeters. Note that on many X servers this value will not be correct.

width
int width()

Gets the width of the default screen in pixels. The returned size is in ”application pixels”, not in ”device pixels” (see Screen.getMonitorScaleFactor).

widthMm
int widthMm()

Returns the width of the default screen in millimeters. Note that on many X servers this value will not be correct.

Variables

gdkScreen
GdkScreen* gdkScreen;

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