Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
GI.Gio.Interfaces.DBusObject
Description
The GDBusObject
type is the base type for D-Bus objects on both
the service side (see DBusObjectSkeleton
) and the client side
(see DBusObjectProxy
). It is essentially just a container of
interfaces.
Synopsis
- newtype DBusObject = DBusObject (ManagedPtr DBusObject)
- class (GObject o, IsDescendantOf DBusObject o) => IsDBusObject o
- toDBusObject :: (MonadIO m, IsDBusObject o) => o -> m DBusObject
- type family ResolveDBusObjectMethod (t :: Symbol) o where ...
- data DBusObjectGetInterfaceMethodInfo
- dBusObjectGetInterface :: (HasCallStack, MonadIO m, IsDBusObject a) => a -> Text -> m (Maybe DBusInterface)
- data DBusObjectGetInterfacesMethodInfo
- dBusObjectGetInterfaces :: (HasCallStack, MonadIO m, IsDBusObject a) => a -> m [DBusInterface]
- data DBusObjectGetObjectPathMethodInfo
- dBusObjectGetObjectPath :: (HasCallStack, MonadIO m, IsDBusObject a) => a -> m Text
- type DBusObjectInterfaceAddedCallback = DBusInterface -> IO ()
- data DBusObjectInterfaceAddedSignalInfo
- afterDBusObjectInterfaceAdded :: (IsDBusObject a, MonadIO m) => a -> ((?self :: a) => DBusObjectInterfaceAddedCallback) -> m SignalHandlerId
- onDBusObjectInterfaceAdded :: (IsDBusObject a, MonadIO m) => a -> ((?self :: a) => DBusObjectInterfaceAddedCallback) -> m SignalHandlerId
- type DBusObjectInterfaceRemovedCallback = DBusInterface -> IO ()
- data DBusObjectInterfaceRemovedSignalInfo
- afterDBusObjectInterfaceRemoved :: (IsDBusObject a, MonadIO m) => a -> ((?self :: a) => DBusObjectInterfaceRemovedCallback) -> m SignalHandlerId
- onDBusObjectInterfaceRemoved :: (IsDBusObject a, MonadIO m) => a -> ((?self :: a) => DBusObjectInterfaceRemovedCallback) -> m SignalHandlerId
Exported types
newtype DBusObject Source #
Memory-managed wrapper type.
Constructors
DBusObject (ManagedPtr DBusObject) |
Instances
class (GObject o, IsDescendantOf DBusObject o) => IsDBusObject o Source #
Type class for types which can be safely cast to DBusObject
, for instance with toDBusObject
.
Instances
(GObject o, IsDescendantOf DBusObject o) => IsDBusObject o Source # | |
Defined in GI.Gio.Interfaces.DBusObject |
toDBusObject :: (MonadIO m, IsDBusObject o) => o -> m DBusObject Source #
Cast to DBusObject
, 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
Methods
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getInterface, getInterfaces, getObjectPath, getProperty, getQdata.
Setters
type family ResolveDBusObjectMethod (t :: Symbol) o where ... Source #
Equations
getInterface
data DBusObjectGetInterfaceMethodInfo Source #
Instances
(signature ~ (Text -> m (Maybe DBusInterface)), MonadIO m, IsDBusObject a) => OverloadedMethod DBusObjectGetInterfaceMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DBusObject Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DBusObjectGetInterfaceMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DBusObject Methods |
dBusObjectGetInterface Source #
Arguments
:: (HasCallStack, MonadIO m, IsDBusObject a) | |
=> a |
|
-> Text |
|
-> m (Maybe DBusInterface) | Returns: |
Gets the D-Bus interface with name interfaceName
associated with
object
, if any.
Since: 2.30
getInterfaces
data DBusObjectGetInterfacesMethodInfo Source #
Instances
(signature ~ m [DBusInterface], MonadIO m, IsDBusObject a) => OverloadedMethod DBusObjectGetInterfacesMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DBusObject Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DBusObjectGetInterfacesMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DBusObject Methods |
dBusObjectGetInterfaces Source #
Arguments
:: (HasCallStack, MonadIO m, IsDBusObject a) | |
=> a |
|
-> m [DBusInterface] | Returns: A list of |
Gets the D-Bus interfaces associated with object
.
Since: 2.30
getObjectPath
data DBusObjectGetObjectPathMethodInfo Source #
Instances
(signature ~ m Text, MonadIO m, IsDBusObject a) => OverloadedMethod DBusObjectGetObjectPathMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DBusObject Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DBusObjectGetObjectPathMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DBusObject Methods |
dBusObjectGetObjectPath Source #
Arguments
:: (HasCallStack, MonadIO m, IsDBusObject a) | |
=> a |
|
-> m Text | Returns: A string owned by |
Gets the object path for object
.
Since: 2.30
Signals
interfaceAdded
type DBusObjectInterfaceAddedCallback Source #
Arguments
= DBusInterface |
|
-> IO () |
Emitted when interface
is added to object
.
Since: 2.30
data DBusObjectInterfaceAddedSignalInfo Source #
Instances
SignalInfo DBusObjectInterfaceAddedSignalInfo Source # | |||||
Defined in GI.Gio.Interfaces.DBusObject Associated Types
Methods connectSignal :: GObject o => o -> (o -> HaskellCallbackType DBusObjectInterfaceAddedSignalInfo) -> SignalConnectMode -> Maybe Text -> IO SignalHandlerId # | |||||
type HaskellCallbackType DBusObjectInterfaceAddedSignalInfo Source # | |||||
afterDBusObjectInterfaceAdded :: (IsDBusObject a, MonadIO m) => a -> ((?self :: a) => DBusObjectInterfaceAddedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the interfaceAdded signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
dBusObject #interfaceAdded 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.
onDBusObjectInterfaceAdded :: (IsDBusObject a, MonadIO m) => a -> ((?self :: a) => DBusObjectInterfaceAddedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the interfaceAdded signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
dBusObject #interfaceAdded callback
interfaceRemoved
type DBusObjectInterfaceRemovedCallback Source #
Arguments
= DBusInterface |
|
-> IO () |
Emitted when interface
is removed from object
.
Since: 2.30
data DBusObjectInterfaceRemovedSignalInfo Source #
Instances
SignalInfo DBusObjectInterfaceRemovedSignalInfo Source # | |||||
Defined in GI.Gio.Interfaces.DBusObject Associated Types
Methods connectSignal :: GObject o => o -> (o -> HaskellCallbackType DBusObjectInterfaceRemovedSignalInfo) -> SignalConnectMode -> Maybe Text -> IO SignalHandlerId # | |||||
type HaskellCallbackType DBusObjectInterfaceRemovedSignalInfo Source # | |||||
afterDBusObjectInterfaceRemoved :: (IsDBusObject a, MonadIO m) => a -> ((?self :: a) => DBusObjectInterfaceRemovedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the interfaceRemoved signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
dBusObject #interfaceRemoved 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.
onDBusObjectInterfaceRemoved :: (IsDBusObject a, MonadIO m) => a -> ((?self :: a) => DBusObjectInterfaceRemovedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the interfaceRemoved signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
dBusObject #interfaceRemoved callback