gi-clutter-1.0.3: clutter GObject bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Clutter.Objects.DeviceManager

Description

The DeviceManager structure contains only private data

Since: 1.2

Synopsis

Exported types

newtype DeviceManager Source #

Memory-managed wrapper type.

Constructors

DeviceManager (ManagedPtr DeviceManager) 

Instances

Instances details
Eq DeviceManager Source # 
Instance details

Defined in GI.Clutter.Objects.DeviceManager

GObject DeviceManager Source # 
Instance details

Defined in GI.Clutter.Objects.DeviceManager

ManagedPtrNewtype DeviceManager Source # 
Instance details

Defined in GI.Clutter.Objects.DeviceManager

Methods

toManagedPtr :: DeviceManager -> ManagedPtr DeviceManager

TypedObject DeviceManager Source # 
Instance details

Defined in GI.Clutter.Objects.DeviceManager

Methods

glibType :: IO GType

HasParentTypes DeviceManager Source # 
Instance details

Defined in GI.Clutter.Objects.DeviceManager

IsGValue (Maybe DeviceManager) Source #

Convert DeviceManager to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Clutter.Objects.DeviceManager

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe DeviceManager -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe DeviceManager)

type ParentTypes DeviceManager Source # 
Instance details

Defined in GI.Clutter.Objects.DeviceManager

type ParentTypes DeviceManager = '[Object]

class (GObject o, IsDescendantOf DeviceManager o) => IsDeviceManager o Source #

Type class for types which can be safely cast to DeviceManager, for instance with toDeviceManager.

Instances

Instances details
(GObject o, IsDescendantOf DeviceManager o) => IsDeviceManager o Source # 
Instance details

Defined in GI.Clutter.Objects.DeviceManager

toDeviceManager :: (MonadIO m, IsDeviceManager o) => o -> m DeviceManager Source #

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

Methods

getCoreDevice

deviceManagerGetCoreDevice Source #

Arguments

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

deviceManager: a DeviceManager

-> InputDeviceType

deviceType: the type of the core device

-> m InputDevice

Returns: a InputDevice or Nothing. The returned device is owned by the DeviceManager and should not be modified or freed

Retrieves the core InputDevice of type deviceType

Core devices are devices created automatically by the default Clutter backend

Since: 1.2

getDefault

deviceManagerGetDefault Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m DeviceManager

Returns: the DeviceManager singleton. The returned instance is owned by Clutter and it should not be modified or freed

Retrieves the device manager singleton

Since: 1.2

getDevice

deviceManagerGetDevice Source #

Arguments

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

deviceManager: a DeviceManager

-> Int32

deviceId: the integer id of a device

-> m InputDevice

Returns: a InputDevice or Nothing. The returned device is owned by the DeviceManager and should never be modified or freed

Retrieves the InputDevice with the given deviceId

Since: 1.2

listDevices

deviceManagerListDevices Source #

Arguments

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

deviceManager: a DeviceManager

-> m [InputDevice]

Returns: a newly allocated list of InputDevice objects. Use g_slist_free() to deallocate it when done

Lists all currently registered input devices

Since: 1.2

peekDevices

deviceManagerPeekDevices Source #

Arguments

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

deviceManager: a DeviceManager

-> m [InputDevice]

Returns: a pointer to the internal list of InputDevice objects. The returned list is owned by the DeviceManager and should never be modified or freed

Lists all currently registered input devices

Since: 1.2

Properties

backend

No description available in the introspection data.

constructDeviceManagerBackend :: (IsDeviceManager o, MonadIO m, IsBackend a) => a -> m (GValueConstruct o) Source #

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

getDeviceManagerBackend :: (MonadIO m, IsDeviceManager o) => o -> m (Maybe Backend) Source #

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

get deviceManager #backend

Signals

deviceAdded

type DeviceManagerDeviceAddedCallback Source #

Arguments

 = InputDevice

device: the newly added InputDevice

-> IO () 

The deviceAdded signal is emitted each time a device has been added to the DeviceManager

Since: 1.2

afterDeviceManagerDeviceAdded :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceAddedCallback) -> m SignalHandlerId Source #

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

after deviceManager #deviceAdded 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.

onDeviceManagerDeviceAdded :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceAddedCallback) -> m SignalHandlerId Source #

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

on deviceManager #deviceAdded callback

deviceRemoved

type DeviceManagerDeviceRemovedCallback Source #

Arguments

 = InputDevice

device: the removed InputDevice

-> IO () 

The deviceRemoved signal is emitted each time a device has been removed from the DeviceManager

Since: 1.2

afterDeviceManagerDeviceRemoved :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceRemovedCallback) -> m SignalHandlerId Source #

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

after deviceManager #deviceRemoved 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.

onDeviceManagerDeviceRemoved :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceRemovedCallback) -> m SignalHandlerId Source #

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

on deviceManager #deviceRemoved callback