GI.Gdk.Objects.DisplayManager

The purpose of the DisplayManager singleton object is to offer notification when displays appear or disappear or the default display changes.

You can use displayManagerGet to obtain the DisplayManager singleton, but that should be rarely necessary. Typically, initializing GTK+ opens a display that you can work with without ever accessing the DisplayManager.

The GDK library can be built with support for multiple backends. The DisplayManager object determines which backend is used at runtime.

When writing backend-specific code that is supposed to work with multiple GDK backends, you have to consider both compile time and runtime. At compile time, use the GDK_WINDOWING_X11, GDK_WINDOWING_WIN32 macros, etc. to find out which backends are present in the GDK library you are building your application against. At runtime, use type-check macros like GDK_IS_X11_DISPLAY() to find out which backend is in use:

## {backend-specific}

C code

#ifdef GDK_WINDOWING_X11
  if (GDK_IS_X11_DISPLAY (display))
    {
      // make X11-specific calls here
    }
  else
#endif
#ifdef GDK_WINDOWING_QUARTZ
  if (GDK_IS_QUARTZ_DISPLAY (display))
    {
      // make Quartz-specific calls here
    }
  else
#endif
  g_error ("Unsupported GDK backend");

Exported types

newtype DisplayManager

Constructors

DisplayManager (ManagedPtr DisplayManager)

Instances

GObject DisplayManager

Methods

gobjectType :: DisplayManager -> IO GType

IsObject DisplayManager

IsDisplayManager DisplayManager

((~) * info (ResolveDisplayManagerMethod t DisplayManager), MethodInfo * info DisplayManager p) => IsLabel t (DisplayManager -> p)

Methods

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

((~) * info (ResolveDisplayManagerMethod t DisplayManager), MethodInfo * info DisplayManager p) => IsLabelProxy t (DisplayManager -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> DisplayManager -> p

HasAttributeList * DisplayManager

type AttributeList DisplayManager

type AttributeList DisplayManager

type SignalList DisplayManager

type SignalList DisplayManager

class GObject o => IsDisplayManager o

Instances

(GObject a, UnknownAncestorError Constraint DisplayManager a) => IsDisplayManager a

IsDisplayManager DisplayManager

toDisplayManager :: IsDisplayManager o => o -> IO DisplayManager

noDisplayManager :: Maybe DisplayManager

Methods

get

displayManagerGet

Arguments

:: (HasCallStack, MonadIO m)

=> m DisplayManager

Returns: The global DisplayManager singleton; parseArgs, init, or initCheck must have been called first.

Gets the singleton DisplayManager object.

When called for the first time, this function consults the GDK_BACKEND environment variable to find out which of the supported GDK backends to use (in case GDK has been compiled with multiple backends). Applications can use setAllowedBackends to limit what backends can be used.

Since: 2.2

getDefaultDisplay

data DisplayManagerGetDefaultDisplayMethodInfo

Instances

((~) * signature (m (Maybe Display)), MonadIO m, IsDisplayManager a) => MethodInfo * DisplayManagerGetDefaultDisplayMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DisplayManagerGetDefaultDisplayMethodInfo a -> signature -> s

displayManagerGetDefaultDisplay

Arguments

:: (HasCallStack, MonadIO m, IsDisplayManager a)

=> a

manager: a DisplayManager

-> m (Maybe Display)

Returns: a Display, or Nothing if there is no default display.

Gets the default Display.

Since: 2.2

listDisplays

data DisplayManagerListDisplaysMethodInfo

Instances

((~) * signature (m [Display]), MonadIO m, IsDisplayManager a) => MethodInfo * DisplayManagerListDisplaysMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DisplayManagerListDisplaysMethodInfo a -> signature -> s

displayManagerListDisplays

Arguments

:: (HasCallStack, MonadIO m, IsDisplayManager a)

=> a

manager: a DisplayManager

-> m [Display]

Returns: a newly allocated SList of Display objects. Free with g_slist_free() when you are done with it.

List all currently open displays.

Since: 2.2

openDisplay

data DisplayManagerOpenDisplayMethodInfo

Instances

((~) * signature (Text -> m (Maybe Display)), MonadIO m, IsDisplayManager a) => MethodInfo * DisplayManagerOpenDisplayMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DisplayManagerOpenDisplayMethodInfo a -> signature -> s

displayManagerOpenDisplay

Arguments

:: (HasCallStack, MonadIO m, IsDisplayManager a)

=> a

manager: a DisplayManager

-> Text

name: the name of the display to open

-> m (Maybe Display)

Returns: a Display, or Nothing if the display could not be opened

Opens a display.

Since: 3.0

setDefaultDisplay

data DisplayManagerSetDefaultDisplayMethodInfo

Instances

((~) * signature (b -> m ()), MonadIO m, IsDisplayManager a, IsDisplay b) => MethodInfo * DisplayManagerSetDefaultDisplayMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DisplayManagerSetDefaultDisplayMethodInfo a -> signature -> s

displayManagerSetDefaultDisplay

Arguments

:: (HasCallStack, MonadIO m, IsDisplayManager a, IsDisplay b)

=> a

manager: a DisplayManager

-> b

display: a Display

-> m ()

Sets display as the default display.

Since: 2.2

Properties

defaultDisplay

data DisplayManagerDefaultDisplayPropertyInfo

Instances

AttrInfo DisplayManagerDefaultDisplayPropertyInfo

Associated Types

type AttrAllowedOps DisplayManagerDefaultDisplayPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint DisplayManagerDefaultDisplayPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint DisplayManagerDefaultDisplayPropertyInfo :: * -> Constraint

type AttrGetType DisplayManagerDefaultDisplayPropertyInfo :: *

type AttrLabel DisplayManagerDefaultDisplayPropertyInfo :: Symbol

type AttrOrigin DisplayManagerDefaultDisplayPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint DisplayManagerDefaultDisplayPropertyInfo o => Proxy * DisplayManagerDefaultDisplayPropertyInfo -> o -> IO (AttrGetType DisplayManagerDefaultDisplayPropertyInfo)

attrSet :: (AttrBaseTypeConstraint DisplayManagerDefaultDisplayPropertyInfo o, AttrSetTypeConstraint DisplayManagerDefaultDisplayPropertyInfo b) => Proxy * DisplayManagerDefaultDisplayPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint DisplayManagerDefaultDisplayPropertyInfo o => Proxy * DisplayManagerDefaultDisplayPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint DisplayManagerDefaultDisplayPropertyInfo o, AttrSetTypeConstraint DisplayManagerDefaultDisplayPropertyInfo b) => Proxy * DisplayManagerDefaultDisplayPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin DisplayManagerDefaultDisplayPropertyInfo

type AttrOrigin DisplayManagerDefaultDisplayPropertyInfo = DisplayManager

type AttrLabel DisplayManagerDefaultDisplayPropertyInfo

type AttrLabel DisplayManagerDefaultDisplayPropertyInfo = "default-display"

type AttrGetType DisplayManagerDefaultDisplayPropertyInfo

type AttrGetType DisplayManagerDefaultDisplayPropertyInfo = Maybe Display

type AttrBaseTypeConstraint DisplayManagerDefaultDisplayPropertyInfo

type AttrBaseTypeConstraint DisplayManagerDefaultDisplayPropertyInfo = IsDisplayManager

type AttrSetTypeConstraint DisplayManagerDefaultDisplayPropertyInfo

type AttrSetTypeConstraint DisplayManagerDefaultDisplayPropertyInfo = IsDisplay

type AttrAllowedOps DisplayManagerDefaultDisplayPropertyInfo

type AttrAllowedOps DisplayManagerDefaultDisplayPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructDisplayManagerDefaultDisplay :: (IsDisplayManager o, IsDisplay a) => a -> IO (GValueConstruct o)

displayManagerDefaultDisplay :: AttrLabelProxy "defaultDisplay"

getDisplayManagerDefaultDisplay :: (MonadIO m, IsDisplayManager o) => o -> m (Maybe Display)

setDisplayManagerDefaultDisplay :: (MonadIO m, IsDisplayManager o, IsDisplay a) => o -> a -> m ()

Signals

displayOpened

type C_DisplayManagerDisplayOpenedCallback = Ptr () -> Ptr Display -> Ptr () -> IO ()

type DisplayManagerDisplayOpenedCallback = Display -> IO ()

data DisplayManagerDisplayOpenedSignalInfo

Instances

SignalInfo DisplayManagerDisplayOpenedSignalInfo

Associated Types

type HaskellCallbackType DisplayManagerDisplayOpenedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o DisplayManagerDisplayOpenedSignalInfo -> o -> HaskellCallbackType DisplayManagerDisplayOpenedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType DisplayManagerDisplayOpenedSignalInfo

type HaskellCallbackType DisplayManagerDisplayOpenedSignalInfo = DisplayManagerDisplayOpenedCallback

afterDisplayManagerDisplayOpened :: (GObject a, MonadIO m) => a -> DisplayManagerDisplayOpenedCallback -> m SignalHandlerId

genClosure_DisplayManagerDisplayOpened :: DisplayManagerDisplayOpenedCallback -> IO Closure

mk_DisplayManagerDisplayOpenedCallback :: C_DisplayManagerDisplayOpenedCallback -> IO (FunPtr C_DisplayManagerDisplayOpenedCallback)

noDisplayManagerDisplayOpenedCallback :: Maybe DisplayManagerDisplayOpenedCallback

onDisplayManagerDisplayOpened :: (GObject a, MonadIO m) => a -> DisplayManagerDisplayOpenedCallback -> m SignalHandlerId

wrap_DisplayManagerDisplayOpenedCallback :: DisplayManagerDisplayOpenedCallback -> Ptr () -> Ptr Display -> Ptr () -> IO ()