Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Gdk.Objects.Monitor

Contents

Exported types
Methods
Properties
Signals
- invalidate

Description

GdkMonitor objects represent the individual outputs that are associated with a GdkDisplay.

GdkDisplay keeps a GListModel to enumerate and monitor monitors with displayGetMonitors. You can use displayGetMonitorAtSurface to find a particular monitor.

Synopsis

newtype Monitor = Monitor (ManagedPtr Monitor)
class (GObject o, IsDescendantOf Monitor o) => IsMonitor o
toMonitor :: (MonadIO m, IsMonitor o) => o -> m Monitor
monitorGetConnector :: (HasCallStack, MonadIO m, IsMonitor a) => a -> m (Maybe Text)
monitorGetDescription :: (HasCallStack, MonadIO m, IsMonitor a) => a -> m (Maybe Text)
monitorGetDisplay :: (HasCallStack, MonadIO m, IsMonitor a) => a -> m Display
monitorGetGeometry :: (HasCallStack, MonadIO m, IsMonitor a) => a -> m Rectangle
monitorGetHeightMm :: (HasCallStack, MonadIO m, IsMonitor a) => a -> m Int32
monitorGetManufacturer :: (HasCallStack, MonadIO m, IsMonitor a) => a -> m (Maybe Text)
monitorGetModel :: (HasCallStack, MonadIO m, IsMonitor a) => a -> m (Maybe Text)
monitorGetRefreshRate :: (HasCallStack, MonadIO m, IsMonitor a) => a -> m Int32
monitorGetScaleFactor :: (HasCallStack, MonadIO m, IsMonitor a) => a -> m Int32
monitorGetSubpixelLayout :: (HasCallStack, MonadIO m, IsMonitor a) => a -> m SubpixelLayout
monitorGetWidthMm :: (HasCallStack, MonadIO m, IsMonitor a) => a -> m Int32
monitorIsValid :: (HasCallStack, MonadIO m, IsMonitor a) => a -> m Bool
getMonitorConnector :: (MonadIO m, IsMonitor o) => o -> m (Maybe Text)
getMonitorDescription :: (MonadIO m, IsMonitor o) => o -> m (Maybe Text)
constructMonitorDisplay :: (IsMonitor o, MonadIO m, IsDisplay a) => a -> m (GValueConstruct o)
getMonitorDisplay :: (MonadIO m, IsMonitor o) => o -> m Display
getMonitorGeometry :: (MonadIO m, IsMonitor o) => o -> m (Maybe Rectangle)
getMonitorHeightMm :: (MonadIO m, IsMonitor o) => o -> m Int32
getMonitorManufacturer :: (MonadIO m, IsMonitor o) => o -> m (Maybe Text)
getMonitorModel :: (MonadIO m, IsMonitor o) => o -> m (Maybe Text)
getMonitorRefreshRate :: (MonadIO m, IsMonitor o) => o -> m Int32
getMonitorScaleFactor :: (MonadIO m, IsMonitor o) => o -> m Int32
getMonitorSubpixelLayout :: (MonadIO m, IsMonitor o) => o -> m SubpixelLayout
getMonitorValid :: (MonadIO m, IsMonitor o) => o -> m Bool
getMonitorWidthMm :: (MonadIO m, IsMonitor o) => o -> m Int32
type MonitorInvalidateCallback = IO ()
afterMonitorInvalidate :: (IsMonitor a, MonadIO m) => a -> ((?self :: a) => MonitorInvalidateCallback) -> m SignalHandlerId
onMonitorInvalidate :: (IsMonitor a, MonadIO m) => a -> ((?self :: a) => MonitorInvalidateCallback) -> m SignalHandlerId

Exported types

newtype Monitor Source #

Memory-managed wrapper type.

Constructors

Monitor (ManagedPtr Monitor)

Instances

Instances details

Eq Monitor Source #
Instance details Defined in GI.Gdk.Objects.Monitor Methods (==) :: Monitor -> Monitor -> Bool # (/=) :: Monitor -> Monitor -> Bool #
GObject Monitor Source #
Instance details Defined in GI.Gdk.Objects.Monitor
ManagedPtrNewtype Monitor Source #
Instance details Defined in GI.Gdk.Objects.Monitor Methods toManagedPtr :: Monitor -> ManagedPtr Monitor
TypedObject Monitor Source #
Instance details Defined in GI.Gdk.Objects.Monitor Methods glibType :: IO GType
HasParentTypes Monitor Source #
Instance details Defined in GI.Gdk.Objects.Monitor
IsGValue (Maybe Monitor) Source #	Convert `Monitor` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gdk.Objects.Monitor Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Monitor -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Monitor)
type ParentTypes Monitor Source #
Instance details Defined in GI.Gdk.Objects.Monitor type ParentTypes Monitor = '[Object]

class (GObject o, IsDescendantOf Monitor o) => IsMonitor o Source #

Type class for types which can be safely cast to Monitor, for instance with toMonitor.

Instances

Instances details

(GObject o, IsDescendantOf Monitor o) => IsMonitor o Source #
Instance details Defined in GI.Gdk.Objects.Monitor

toMonitor :: (MonadIO m, IsMonitor o) => o -> m Monitor Source #

Cast to Monitor, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Expand

getConnector

monitorGetConnector Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a)
=> a	`monitor`: a `GdkMonitor`
-> m (Maybe Text)	Returns: the name of the connector

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

These are strings such as "eDP-1", or "HDMI-2". They depend on software and hardware configuration, and should not be relied on as stable identifiers of a specific monitor.

getDescription

monitorGetDescription Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a)
=> a	`monitor`: a `GdkMonitor`
-> m (Maybe Text)	Returns: the monitor description

Gets a string describing the monitor, if available.

This can be used to identify a monitor in the UI.

Since: 4.10

getDisplay

monitorGetDisplay Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a)
=> a	`monitor`: a `GdkMonitor`
-> m Display	Returns: the display

Gets the display that this monitor belongs to.

getGeometry

monitorGetGeometry Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a)
=> a	`monitor`: a `GdkMonitor`
-> m Rectangle

Retrieves the size and position of the monitor within the display coordinate space.

The returned geometry is in ”application pixels”, not in ”device pixels” (see monitorGetScaleFactor).

getHeightMm

monitorGetHeightMm Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a)
=> a	`monitor`: a `GdkMonitor`
-> m Int32	Returns: the physical height of the monitor

Gets the height in millimeters of the monitor.

getManufacturer

monitorGetManufacturer Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a)
=> a	`monitor`: a `GdkMonitor`
-> m (Maybe Text)	Returns: the name of the manufacturer

Gets the name or PNP ID of the monitor's manufacturer.

Note that this value might also vary depending on actual display backend.

The PNP ID registry is located at https://uefi.org/pnp_id_list.

getModel

monitorGetModel Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a)
=> a	`monitor`: a `GdkMonitor`
-> m (Maybe Text)	Returns: the monitor model

Gets the string identifying the monitor model, if available.

getRefreshRate

monitorGetRefreshRate Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a)
=> a	`monitor`: a `GdkMonitor`
-> 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.

getScaleFactor

monitorGetScaleFactor Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a)
=> a	`monitor`: a `GdkMonitor`
-> m Int32	Returns: the scale factor

Gets the internal scale factor that maps from monitor coordinates to device pixels.

On traditional systems this is 1, but on very high density outputs it 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 surface where it is better to use surfaceGetScaleFactor instead.

getSubpixelLayout

monitorGetSubpixelLayout Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a)
=> a	`monitor`: a `GdkMonitor`
-> m SubpixelLayout	Returns: the subpixel layout

Gets information about the layout of red, green and blue primaries for pixels.

getWidthMm

monitorGetWidthMm Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a)
=> a	`monitor`: a `GdkMonitor`
-> m Int32	Returns: the physical width of the monitor

Gets the width in millimeters of the monitor.

isValid

monitorIsValid Source #

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a)
=> a	`monitor`: a `GdkMonitor`
-> m Bool	Returns: `True` if the object corresponds to a physical monitor

Returns True if the monitor object corresponds to a physical monitor.

The monitor becomes invalid when the physical monitor is unplugged or removed.

Properties

connector

The connector name.

getMonitorConnector :: (MonadIO m, IsMonitor o) => o -> m (Maybe Text) Source #

Get the value of the “connector” property. When overloading is enabled, this is equivalent to

get monitor #connector

description

A short description of the monitor, meant for display to the user.

Since: 4.10

getMonitorDescription :: (MonadIO m, IsMonitor o) => o -> m (Maybe Text) Source #

Get the value of the “description” property. When overloading is enabled, this is equivalent to

get monitor #description

display

The GdkDisplay of the monitor.

constructMonitorDisplay :: (IsMonitor o, MonadIO m, IsDisplay a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “display” property. This is rarely needed directly, but it is used by new.

getMonitorDisplay :: (MonadIO m, IsMonitor o) => o -> m Display Source #

Get the value of the “display” property. When overloading is enabled, this is equivalent to

get monitor #display

geometry

The geometry of the monitor.

getMonitorGeometry :: (MonadIO m, IsMonitor o) => o -> m (Maybe Rectangle) Source #

Get the value of the “geometry” property. When overloading is enabled, this is equivalent to

get monitor #geometry

heightMm

The height of the monitor, in millimeters.

getMonitorHeightMm :: (MonadIO m, IsMonitor o) => o -> m Int32 Source #

Get the value of the “height-mm” property. When overloading is enabled, this is equivalent to

get monitor #heightMm

manufacturer

The manufacturer name.

getMonitorManufacturer :: (MonadIO m, IsMonitor o) => o -> m (Maybe Text) Source #

Get the value of the “manufacturer” property. When overloading is enabled, this is equivalent to

get monitor #manufacturer

model

The model name.

getMonitorModel :: (MonadIO m, IsMonitor o) => o -> m (Maybe Text) Source #

Get the value of the “model” property. When overloading is enabled, this is equivalent to

get monitor #model

refreshRate

The refresh rate, in milli-Hertz.

getMonitorRefreshRate :: (MonadIO m, IsMonitor o) => o -> m Int32 Source #

Get the value of the “refresh-rate” property. When overloading is enabled, this is equivalent to

get monitor #refreshRate

scaleFactor

The scale factor.

getMonitorScaleFactor :: (MonadIO m, IsMonitor o) => o -> m Int32 Source #

Get the value of the “scale-factor” property. When overloading is enabled, this is equivalent to

get monitor #scaleFactor

subpixelLayout

The subpixel layout.

getMonitorSubpixelLayout :: (MonadIO m, IsMonitor o) => o -> m SubpixelLayout Source #

Get the value of the “subpixel-layout” property. When overloading is enabled, this is equivalent to

get monitor #subpixelLayout

valid

Whether the object is still valid.

getMonitorValid :: (MonadIO m, IsMonitor o) => o -> m Bool Source #

Get the value of the “valid” property. When overloading is enabled, this is equivalent to

get monitor #valid

widthMm

The width of the monitor, in millimeters.

getMonitorWidthMm :: (MonadIO m, IsMonitor o) => o -> m Int32 Source #

Get the value of the “width-mm” property. When overloading is enabled, this is equivalent to

get monitor #widthMm

Signals

invalidate

type MonitorInvalidateCallback = IO () Source #

Emitted when the output represented by monitor gets disconnected.

afterMonitorInvalidate :: (IsMonitor a, MonadIO m) => a -> ((?self :: a) => MonitorInvalidateCallback) -> m SignalHandlerId Source #

Connect a signal handler for the invalidate signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after monitor #invalidate callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onMonitorInvalidate :: (IsMonitor a, MonadIO m) => a -> ((?self :: a) => MonitorInvalidateCallback) -> m SignalHandlerId Source #

Connect a signal handler for the invalidate signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on monitor #invalidate callback

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

getConnector

getDescription

getDisplay

getGeometry

getHeightMm

getManufacturer

getModel

getRefreshRate

getScaleFactor

getSubpixelLayout

getWidthMm

isValid

Properties

connector

description

display

geometry

heightMm

manufacturer

model

refreshRate

scaleFactor

subpixelLayout

valid

widthMm

Signals

invalidate