GI.Gdk.Objects.Monitor

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.

Exported types

newtype Monitor

Constructors

Monitor (ManagedPtr Monitor)

Instances

GObject Monitor

Methods

gobjectType :: Monitor -> IO GType

IsObject Monitor

IsMonitor Monitor

class GObject o => IsMonitor o

Instances

(GObject a, UnknownAncestorError Constraint Monitor a) => IsMonitor a

IsMonitor Monitor

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

noMonitor :: Maybe Monitor

Methods

getDisplay

monitorGetDisplay

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

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

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

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

monitorGetModel

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

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

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

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

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

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

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

constructMonitorDisplay :: (IsMonitor o, IsDisplay a) => a -> IO (GValueConstruct o)

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

geometry

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

heightMm

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

manufacturer

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

model

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

refreshRate

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

scaleFactor

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

subpixelLayout

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

widthMm

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

workarea

getMonitorWorkarea :: (MonadIO m, IsMonitor o) => o -> m (Maybe Rectangle)

Signals

invalidate

type C_MonitorInvalidateCallback = Ptr () -> Ptr () -> IO ()

type MonitorInvalidateCallback = IO ()

afterMonitorInvalidate :: (IsMonitor a, MonadIO m) => a -> MonitorInvalidateCallback -> m SignalHandlerId

genClosure_MonitorInvalidate :: MonitorInvalidateCallback -> IO Closure

mk_MonitorInvalidateCallback :: C_MonitorInvalidateCallback -> IO (FunPtr C_MonitorInvalidateCallback)

noMonitorInvalidateCallback :: Maybe MonitorInvalidateCallback

onMonitorInvalidate :: (IsMonitor a, MonadIO m) => a -> MonitorInvalidateCallback -> m SignalHandlerId

wrap_MonitorInvalidateCallback :: MonitorInvalidateCallback -> Ptr () -> Ptr () -> IO ()