gi-gdk-3.0.11: Gdk bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gdk.Objects.Monitor

Contents

Description

GdkMonitor objects represent the individual outputs that are associated with a Display. GdkDisplay has APIs to enumerate monitors with gdk_display_get_monitors() and to find particular monitors with displayGetPrimaryMonitor or displayGetMonitorAtWindow.

GdkMonitor was introduced in GTK+ 3.22 and supersedes earlier APIs in GdkScreen to obtain monitor-related information.

Synopsis

Exported types

newtype Monitor Source #

Constructors

Monitor (ManagedPtr Monitor) 

Instances

GObject Monitor Source # 
IsObject Monitor Source # 
IsMonitor Monitor Source # 
((~) * info (ResolveMonitorMethod t Monitor), MethodInfo * info Monitor p) => IsLabel t (Monitor -> p) Source # 

Methods

fromLabel :: Proxy# Symbol t -> Monitor -> p #

((~) * info (ResolveMonitorMethod t Monitor), MethodInfo * info Monitor p) => IsLabelProxy t (Monitor -> p) Source # 

Methods

fromLabelProxy :: Proxy Symbol t -> Monitor -> p #

HasAttributeList * Monitor Source # 
type AttributeList Monitor Source # 
type SignalList Monitor Source # 

Methods

getDisplay

monitorGetDisplay Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a) 
=> a

monitor: a Monitor

-> m Display

Returns: the display

Gets the display that this monitor belongs to.

Since: 3.22

getGeometry

monitorGetGeometry Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a) 
=> a

monitor: a Monitor

-> m Rectangle 

Retrieves the size and position of an individual monitor within the display coordinate space. The returned geometry is in ”application pixels”, not in ”device pixels” (see monitorGetScaleFactor).

Since: 3.22

getHeightMm

monitorGetHeightMm Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a) 
=> a

monitor: a Monitor

-> m Int32

Returns: the physical height of the monitor

Gets the height in millimeters of the monitor.

Since: 3.22

getManufacturer

monitorGetManufacturer Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a) 
=> a

monitor: a Monitor

-> m (Maybe Text)

Returns: the name of the manufacturer, or Nothing

Gets the name of the monitor's manufacturer, if available.

getModel

data MonitorGetModelMethodInfo Source #

Instances

((~) * signature (m (Maybe Text)), MonadIO m, IsMonitor a) => MethodInfo * MonitorGetModelMethodInfo a signature Source # 

monitorGetModel Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a) 
=> a

monitor: a Monitor

-> m (Maybe Text)

Returns: the monitor model, or Nothing

Gets the a string identifying the monitor model, if available.

getRefreshRate

monitorGetRefreshRate Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a) 
=> a

monitor: a Monitor

-> m Int32

Returns: the refresh rate in milli-Hertz, or 0

Gets the refresh rate of the monitor, if available.

The value is in milli-Hertz, so a refresh rate of 60Hz is returned as 60000.

Since: 3.22

getScaleFactor

monitorGetScaleFactor Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a) 
=> a

monitor: a Monitor

-> m Int32

Returns: the scale factor

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

This can be used if you want to create pixel based data for a particular monitor, but most of the time you’re drawing to a window where it is better to use windowGetScaleFactor instead.

Since: 3.22

getSubpixelLayout

monitorGetSubpixelLayout Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a) 
=> a

monitor: a Monitor

-> m SubpixelLayout

Returns: the subpixel layout

Gets information about the layout of red, green and blue primaries for each pixel in this monitor, if available.

Since: 3.22

getWidthMm

monitorGetWidthMm Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a) 
=> a

monitor: a Monitor

-> m Int32

Returns: the physical width of the monitor

Gets the width in millimeters of the monitor.

Since: 3.22

getWorkarea

monitorGetWorkarea Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a) 
=> a

monitor: a Monitor

-> m Rectangle 

Retrieves the size and position of the “work area” on a monitor within the display coordinate space. The returned geometry is in ”application pixels”, not in ”device pixels” (see monitorGetScaleFactor).

The work area should be considered when positioning menus and similar popups, to avoid placing them below panels, docks or other desktop components.

Note that not all backends may have a concept of workarea. This function will return the monitor geometry if a workarea is not available, or does not apply.

Since: 3.22

isPrimary

monitorIsPrimary Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a) 
=> a

monitor: a Monitor

-> m Bool

Returns: True if monitor is primary

Gets whether this monitor should be considered primary (see displayGetPrimaryMonitor).

Since: 3.22

Properties

display

data MonitorDisplayPropertyInfo Source #

Instances

AttrInfo MonitorDisplayPropertyInfo Source # 
type AttrOrigin MonitorDisplayPropertyInfo Source # 
type AttrLabel MonitorDisplayPropertyInfo Source # 
type AttrGetType MonitorDisplayPropertyInfo Source # 
type AttrBaseTypeConstraint MonitorDisplayPropertyInfo Source # 
type AttrSetTypeConstraint MonitorDisplayPropertyInfo Source # 
type AttrAllowedOps MonitorDisplayPropertyInfo Source # 

geometry

data MonitorGeometryPropertyInfo Source #

Instances

AttrInfo MonitorGeometryPropertyInfo Source # 
type AttrOrigin MonitorGeometryPropertyInfo Source # 
type AttrLabel MonitorGeometryPropertyInfo Source # 
type AttrGetType MonitorGeometryPropertyInfo Source # 
type AttrBaseTypeConstraint MonitorGeometryPropertyInfo Source # 
type AttrSetTypeConstraint MonitorGeometryPropertyInfo Source # 
type AttrAllowedOps MonitorGeometryPropertyInfo Source # 

heightMm

data MonitorHeightMmPropertyInfo Source #

Instances

AttrInfo MonitorHeightMmPropertyInfo Source # 
type AttrOrigin MonitorHeightMmPropertyInfo Source # 
type AttrLabel MonitorHeightMmPropertyInfo Source # 
type AttrGetType MonitorHeightMmPropertyInfo Source # 
type AttrBaseTypeConstraint MonitorHeightMmPropertyInfo Source # 
type AttrSetTypeConstraint MonitorHeightMmPropertyInfo Source # 
type AttrAllowedOps MonitorHeightMmPropertyInfo Source # 

manufacturer

data MonitorManufacturerPropertyInfo Source #

Instances

AttrInfo MonitorManufacturerPropertyInfo Source # 
type AttrOrigin MonitorManufacturerPropertyInfo Source # 
type AttrLabel MonitorManufacturerPropertyInfo Source # 
type AttrGetType MonitorManufacturerPropertyInfo Source # 
type AttrBaseTypeConstraint MonitorManufacturerPropertyInfo Source # 
type AttrSetTypeConstraint MonitorManufacturerPropertyInfo Source # 
type AttrAllowedOps MonitorManufacturerPropertyInfo Source # 

model

data MonitorModelPropertyInfo Source #

Instances

AttrInfo MonitorModelPropertyInfo Source # 
type AttrOrigin MonitorModelPropertyInfo Source # 
type AttrLabel MonitorModelPropertyInfo Source # 
type AttrGetType MonitorModelPropertyInfo Source # 
type AttrBaseTypeConstraint MonitorModelPropertyInfo Source # 
type AttrSetTypeConstraint MonitorModelPropertyInfo Source # 
type AttrAllowedOps MonitorModelPropertyInfo Source # 

refreshRate

data MonitorRefreshRatePropertyInfo Source #

Instances

AttrInfo MonitorRefreshRatePropertyInfo Source # 
type AttrOrigin MonitorRefreshRatePropertyInfo Source # 
type AttrLabel MonitorRefreshRatePropertyInfo Source # 
type AttrGetType MonitorRefreshRatePropertyInfo Source # 
type AttrBaseTypeConstraint MonitorRefreshRatePropertyInfo Source # 
type AttrSetTypeConstraint MonitorRefreshRatePropertyInfo Source # 
type AttrAllowedOps MonitorRefreshRatePropertyInfo Source # 

scaleFactor

data MonitorScaleFactorPropertyInfo Source #

Instances

AttrInfo MonitorScaleFactorPropertyInfo Source # 
type AttrOrigin MonitorScaleFactorPropertyInfo Source # 
type AttrLabel MonitorScaleFactorPropertyInfo Source # 
type AttrGetType MonitorScaleFactorPropertyInfo Source # 
type AttrBaseTypeConstraint MonitorScaleFactorPropertyInfo Source # 
type AttrSetTypeConstraint MonitorScaleFactorPropertyInfo Source # 
type AttrAllowedOps MonitorScaleFactorPropertyInfo Source # 

subpixelLayout

data MonitorSubpixelLayoutPropertyInfo Source #

Instances

AttrInfo MonitorSubpixelLayoutPropertyInfo Source # 
type AttrOrigin MonitorSubpixelLayoutPropertyInfo Source # 
type AttrLabel MonitorSubpixelLayoutPropertyInfo Source # 
type AttrGetType MonitorSubpixelLayoutPropertyInfo Source # 
type AttrBaseTypeConstraint MonitorSubpixelLayoutPropertyInfo Source # 
type AttrSetTypeConstraint MonitorSubpixelLayoutPropertyInfo Source # 
type AttrAllowedOps MonitorSubpixelLayoutPropertyInfo Source # 

widthMm

data MonitorWidthMmPropertyInfo Source #

Instances

AttrInfo MonitorWidthMmPropertyInfo Source # 
type AttrOrigin MonitorWidthMmPropertyInfo Source # 
type AttrLabel MonitorWidthMmPropertyInfo Source # 
type AttrGetType MonitorWidthMmPropertyInfo Source # 
type AttrBaseTypeConstraint MonitorWidthMmPropertyInfo Source # 
type AttrSetTypeConstraint MonitorWidthMmPropertyInfo Source # 
type AttrAllowedOps MonitorWidthMmPropertyInfo Source # 

workarea

data MonitorWorkareaPropertyInfo Source #

Instances

AttrInfo MonitorWorkareaPropertyInfo Source # 
type AttrOrigin MonitorWorkareaPropertyInfo Source # 
type AttrLabel MonitorWorkareaPropertyInfo Source # 
type AttrGetType MonitorWorkareaPropertyInfo Source # 
type AttrBaseTypeConstraint MonitorWorkareaPropertyInfo Source # 
type AttrSetTypeConstraint MonitorWorkareaPropertyInfo Source # 
type AttrAllowedOps MonitorWorkareaPropertyInfo Source # 

Signals

invalidate