Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gio.Interfaces.DBusObject

Contents

Exported types
Methods
Signals
- interfaceAdded
- interfaceRemoved

Description

The DBusObject 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)
noDBusObject :: Maybe DBusObject
class GObject o => IsDBusObject o
toDBusObject :: (MonadIO m, IsDBusObject o) => o -> m DBusObject
dBusObjectGetInterface :: (HasCallStack, MonadIO m, IsDBusObject a) => a -> Text -> m DBusInterface
dBusObjectGetInterfaces :: (HasCallStack, MonadIO m, IsDBusObject a) => a -> m [DBusInterface]
dBusObjectGetObjectPath :: (HasCallStack, MonadIO m, IsDBusObject a) => a -> m Text
type C_DBusObjectInterfaceAddedCallback = Ptr () -> Ptr DBusInterface -> Ptr () -> IO ()
type DBusObjectInterfaceAddedCallback = DBusInterface -> IO ()
afterDBusObjectInterfaceAdded :: (IsDBusObject a, MonadIO m) => a -> DBusObjectInterfaceAddedCallback -> m SignalHandlerId
genClosure_DBusObjectInterfaceAdded :: DBusObjectInterfaceAddedCallback -> IO Closure
mk_DBusObjectInterfaceAddedCallback :: C_DBusObjectInterfaceAddedCallback -> IO (FunPtr C_DBusObjectInterfaceAddedCallback)
noDBusObjectInterfaceAddedCallback :: Maybe DBusObjectInterfaceAddedCallback
onDBusObjectInterfaceAdded :: (IsDBusObject a, MonadIO m) => a -> DBusObjectInterfaceAddedCallback -> m SignalHandlerId
wrap_DBusObjectInterfaceAddedCallback :: DBusObjectInterfaceAddedCallback -> C_DBusObjectInterfaceAddedCallback
type C_DBusObjectInterfaceRemovedCallback = Ptr () -> Ptr DBusInterface -> Ptr () -> IO ()
type DBusObjectInterfaceRemovedCallback = DBusInterface -> IO ()
afterDBusObjectInterfaceRemoved :: (IsDBusObject a, MonadIO m) => a -> DBusObjectInterfaceRemovedCallback -> m SignalHandlerId
genClosure_DBusObjectInterfaceRemoved :: DBusObjectInterfaceRemovedCallback -> IO Closure
mk_DBusObjectInterfaceRemovedCallback :: C_DBusObjectInterfaceRemovedCallback -> IO (FunPtr C_DBusObjectInterfaceRemovedCallback)
noDBusObjectInterfaceRemovedCallback :: Maybe DBusObjectInterfaceRemovedCallback
onDBusObjectInterfaceRemoved :: (IsDBusObject a, MonadIO m) => a -> DBusObjectInterfaceRemovedCallback -> m SignalHandlerId
wrap_DBusObjectInterfaceRemovedCallback :: DBusObjectInterfaceRemovedCallback -> C_DBusObjectInterfaceRemovedCallback

Exported types

newtype DBusObject Source #

Memory-managed wrapper type.

Constructors

DBusObject (ManagedPtr DBusObject)

Instances

GObject DBusObject Source #
Instance details Defined in GI.Gio.Interfaces.DBusObject Methods gobjectType :: DBusObject -> IO GType #
IsObject DBusObject Source #
Instance details Defined in GI.Gio.Interfaces.DBusObject
IsDBusObject DBusObject Source #
Instance details Defined in GI.Gio.Interfaces.DBusObject

noDBusObject :: Maybe DBusObject Source #

A convenience alias for Nothing :: Maybe DBusObject.

class GObject o => IsDBusObject o Source #

Type class for types which can be safely cast to DBusObject, for instance with toDBusObject.

Instances

(GObject a, (UnknownAncestorError DBusObject a :: Constraint)) => IsDBusObject a Source #
Instance details Defined in GI.Gio.Interfaces.DBusObject
IsDBusObject DBusObject Source #
Instance details Defined in GI.Gio.Interfaces.DBusObject
IsDBusObject DBusObjectProxy Source #
Instance details Defined in GI.Gio.Objects.DBusObjectProxy
IsDBusObject DBusObjectSkeleton Source #
Instance details Defined in GI.Gio.Objects.DBusObjectSkeleton

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

getInterface

dBusObjectGetInterface Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusObject a)
=> a	`object`: A `DBusObject`.
-> Text	`interfaceName`: A D-Bus interface name.
-> m DBusInterface	Returns: `Nothing` if not found, otherwise a `DBusInterface` that must be freed with `objectUnref`.

Gets the D-Bus interface with name interfaceName associated with object, if any.

Since: 2.30

getInterfaces

dBusObjectGetInterfaces Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusObject a)
=> a	`object`: A `DBusObject`.
-> m [DBusInterface]	Returns: A list of `DBusInterface` instances. The returned list must be freed by `g_list_free()` after each element has been freed with `objectUnref`.

Gets the D-Bus interfaces associated with object.

Since: 2.30

getObjectPath

dBusObjectGetObjectPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusObject a)
=> a	`object`: A `DBusObject`.
-> m Text	Returns: A string owned by `object`. Do not free.

Gets the object path for object.

Since: 2.30

Signals

interfaceAdded

type C_DBusObjectInterfaceAddedCallback = Ptr () -> Ptr DBusInterface -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type DBusObjectInterfaceAddedCallback Source #

Arguments

= DBusInterface	`interface`: The `DBusInterface` that was added.
-> IO ()

Emitted when interface is added to object.

Since: 2.30

afterDBusObjectInterfaceAdded :: (IsDBusObject a, MonadIO m) => a -> DBusObjectInterfaceAddedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “interface-added” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dBusObject #interfaceAdded callback

genClosure_DBusObjectInterfaceAdded :: DBusObjectInterfaceAddedCallback -> IO Closure Source #

Wrap the callback into a Closure.

mk_DBusObjectInterfaceAddedCallback :: C_DBusObjectInterfaceAddedCallback -> IO (FunPtr C_DBusObjectInterfaceAddedCallback) Source #

Generate a function pointer callable from C code, from a C_DBusObjectInterfaceAddedCallback.

noDBusObjectInterfaceAddedCallback :: Maybe DBusObjectInterfaceAddedCallback Source #

A convenience synonym for Nothing :: Maybe DBusObjectInterfaceAddedCallback.

onDBusObjectInterfaceAdded :: (IsDBusObject a, MonadIO m) => a -> DBusObjectInterfaceAddedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “interface-added” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dBusObject #interfaceAdded callback

wrap_DBusObjectInterfaceAddedCallback :: DBusObjectInterfaceAddedCallback -> C_DBusObjectInterfaceAddedCallback Source #

Wrap a DBusObjectInterfaceAddedCallback into a C_DBusObjectInterfaceAddedCallback.

interfaceRemoved

type C_DBusObjectInterfaceRemovedCallback = Ptr () -> Ptr DBusInterface -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type DBusObjectInterfaceRemovedCallback Source #

Arguments

= DBusInterface	`interface`: The `DBusInterface` that was removed.
-> IO ()

Emitted when interface is removed from object.

Since: 2.30

afterDBusObjectInterfaceRemoved :: (IsDBusObject a, MonadIO m) => a -> DBusObjectInterfaceRemovedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “interface-removed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dBusObject #interfaceRemoved callback

genClosure_DBusObjectInterfaceRemoved :: DBusObjectInterfaceRemovedCallback -> IO Closure Source #

Wrap the callback into a Closure.

mk_DBusObjectInterfaceRemovedCallback :: C_DBusObjectInterfaceRemovedCallback -> IO (FunPtr C_DBusObjectInterfaceRemovedCallback) Source #

Generate a function pointer callable from C code, from a C_DBusObjectInterfaceRemovedCallback.

noDBusObjectInterfaceRemovedCallback :: Maybe DBusObjectInterfaceRemovedCallback Source #

A convenience synonym for Nothing :: Maybe DBusObjectInterfaceRemovedCallback.

onDBusObjectInterfaceRemoved :: (IsDBusObject a, MonadIO m) => a -> DBusObjectInterfaceRemovedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “interface-removed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dBusObject #interfaceRemoved callback

wrap_DBusObjectInterfaceRemovedCallback :: DBusObjectInterfaceRemovedCallback -> C_DBusObjectInterfaceRemovedCallback Source #

Wrap a DBusObjectInterfaceRemovedCallback into a C_DBusObjectInterfaceRemovedCallback.