Screen

#GdkScreen 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 #GdkScreen which combines several physical monitors (see gdk.screen.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 (gdk.screen.Screen.getSystemVisual), the dimensions of the physical monitors (gdk.screen.Screen.getMonitorGeometry), etc.

class Screen : ObjectWrap {}

Constructors

this
this(void* ptr, Flag!"Take" take)

Members

Functions

connectCompositedChanged
gulong connectCompositedChanged(T callback, Flag!"After" after)

Connect to CompositedChanged signal.

connectMonitorsChanged
gulong connectMonitorsChanged(T callback, Flag!"After" after)

Connect to MonitorsChanged signal.

connectSizeChanged
gulong connectSizeChanged(T callback, Flag!"After" after)

Connect to SizeChanged signal.

getActiveWindow
gdk.window.Window getActiveWindow()

Returns the screen’s currently active window.

getDisplay
gdk.display.Display getDisplay()

Gets the display to which the screen belongs.

getFontOptions
cairo.font_options.FontOptions getFontOptions()

Gets any options previously set with gdk.screen.Screen.setFontOptions.

getHeight
int getHeight()

Gets the height of screen in pixels. The returned size is in ”application pixels”, not in ”device pixels” (see gdk.screen.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(gdk.window.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, gdk.rectangle.Rectangle dest)

Retrieves the #GdkRectangle 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 gdk.screen.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, gdk.rectangle.Rectangle dest)

Retrieves the #GdkRectangle 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 gdk.screen.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 gdk.screen.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 gdk.screen.Screen.setResolution for full details.

getRgbaVisual
gdk.visual.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
gdk.window.Window getRootWindow()

Gets the root window of screen.

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

Retrieves a desktop-wide setting such as double-click time for the #GdkScreen screen.

getSystemVisual
gdk.visual.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
gdk.window.Window[] 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.global.getDefaultRootWindow).

getWidth
int getWidth()

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

getWidthMm
int getWidthMm()

Gets the width of screen in millimeters.

getWindowStack
gdk.window.Window[] getWindowStack()

Returns a #GList of #GdkWindows 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
gdk.visual.Visual[] 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 gdk.display.Display.open to get a #GdkDisplay with this screen as the default screen.

self
Screen self()

Returns this, for use in with statements.

setFontOptions
void setFontOptions(cairo.font_options.FontOptions options)

Sets the default font options for the screen. These options will be set on any #PangoContext’s newly created with gdk.global.pangoContextGetForScreen. 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).

Properties

_gType
GType _gType [@property getter]
fontOptions
void* fontOptions [@property getter]
fontOptions
void* fontOptions [@property setter]
resolution
double resolution [@property getter]
resolution
double resolution [@property setter]

Static functions

_getGType
GType _getGType()
builder
ScreenGidBuilder builder()

Get builder for gdk.screen.Screen

getDefault
gdk.screen.Screen getDefault()

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

height
int height()

Gets the height of the default screen in pixels. The returned size is in ”application pixels”, not in ”device pixels” (see gdk.screen.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 gdk.screen.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.

Inherited Members

From ObjectWrap

_setGObject
void _setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectWrap 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.

_getGType
GType _getGType()

Get the GType of an object.

_gType
GType _gType [@property getter]

GObject GType property.

self
ObjectWrap 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
gulong 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.ObjectWrap 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.ObjectWrap 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.ObjectWrap.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.ObjectWrap.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.ObjectWrap.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.ObjectWrap 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.ObjectWrap.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.ObjectWrap.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.ObjectWrap.ref_ and gobject.object.ObjectWrap.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
gulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.