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.DBusObjectManager

Contents

Exported types
Methods
Signals

Description

The DBusObjectManager type is the base type for service- and client-side implementations of the standardized org.freedesktop.DBus.ObjectManager interface.

See DBusObjectManagerClient for the client-side implementation and DBusObjectManagerServer for the service-side implementation.

Synopsis

newtype DBusObjectManager = DBusObjectManager (ManagedPtr DBusObjectManager)
noDBusObjectManager :: Maybe DBusObjectManager
class GObject o => IsDBusObjectManager o
toDBusObjectManager :: (MonadIO m, IsDBusObjectManager o) => o -> m DBusObjectManager
dBusObjectManagerGetInterface :: (HasCallStack, MonadIO m, IsDBusObjectManager a) => a -> Text -> Text -> m DBusInterface
dBusObjectManagerGetObject :: (HasCallStack, MonadIO m, IsDBusObjectManager a) => a -> Text -> m DBusObject
dBusObjectManagerGetObjectPath :: (HasCallStack, MonadIO m, IsDBusObjectManager a) => a -> m Text
dBusObjectManagerGetObjects :: (HasCallStack, MonadIO m, IsDBusObjectManager a) => a -> m [DBusObject]
type C_DBusObjectManagerInterfaceAddedCallback = Ptr () -> Ptr DBusObject -> Ptr DBusInterface -> Ptr () -> IO ()
type DBusObjectManagerInterfaceAddedCallback = DBusObject -> DBusInterface -> IO ()
afterDBusObjectManagerInterfaceAdded :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerInterfaceAddedCallback -> m SignalHandlerId
genClosure_DBusObjectManagerInterfaceAdded :: DBusObjectManagerInterfaceAddedCallback -> IO Closure
mk_DBusObjectManagerInterfaceAddedCallback :: C_DBusObjectManagerInterfaceAddedCallback -> IO (FunPtr C_DBusObjectManagerInterfaceAddedCallback)
noDBusObjectManagerInterfaceAddedCallback :: Maybe DBusObjectManagerInterfaceAddedCallback
onDBusObjectManagerInterfaceAdded :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerInterfaceAddedCallback -> m SignalHandlerId
wrap_DBusObjectManagerInterfaceAddedCallback :: DBusObjectManagerInterfaceAddedCallback -> C_DBusObjectManagerInterfaceAddedCallback
type C_DBusObjectManagerInterfaceRemovedCallback = Ptr () -> Ptr DBusObject -> Ptr DBusInterface -> Ptr () -> IO ()
type DBusObjectManagerInterfaceRemovedCallback = DBusObject -> DBusInterface -> IO ()
afterDBusObjectManagerInterfaceRemoved :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerInterfaceRemovedCallback -> m SignalHandlerId
genClosure_DBusObjectManagerInterfaceRemoved :: DBusObjectManagerInterfaceRemovedCallback -> IO Closure
mk_DBusObjectManagerInterfaceRemovedCallback :: C_DBusObjectManagerInterfaceRemovedCallback -> IO (FunPtr C_DBusObjectManagerInterfaceRemovedCallback)
noDBusObjectManagerInterfaceRemovedCallback :: Maybe DBusObjectManagerInterfaceRemovedCallback
onDBusObjectManagerInterfaceRemoved :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerInterfaceRemovedCallback -> m SignalHandlerId
wrap_DBusObjectManagerInterfaceRemovedCallback :: DBusObjectManagerInterfaceRemovedCallback -> C_DBusObjectManagerInterfaceRemovedCallback
type C_DBusObjectManagerObjectAddedCallback = Ptr () -> Ptr DBusObject -> Ptr () -> IO ()
type DBusObjectManagerObjectAddedCallback = DBusObject -> IO ()
afterDBusObjectManagerObjectAdded :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerObjectAddedCallback -> m SignalHandlerId
genClosure_DBusObjectManagerObjectAdded :: DBusObjectManagerObjectAddedCallback -> IO Closure
mk_DBusObjectManagerObjectAddedCallback :: C_DBusObjectManagerObjectAddedCallback -> IO (FunPtr C_DBusObjectManagerObjectAddedCallback)
noDBusObjectManagerObjectAddedCallback :: Maybe DBusObjectManagerObjectAddedCallback
onDBusObjectManagerObjectAdded :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerObjectAddedCallback -> m SignalHandlerId
wrap_DBusObjectManagerObjectAddedCallback :: DBusObjectManagerObjectAddedCallback -> C_DBusObjectManagerObjectAddedCallback
type C_DBusObjectManagerObjectRemovedCallback = Ptr () -> Ptr DBusObject -> Ptr () -> IO ()
type DBusObjectManagerObjectRemovedCallback = DBusObject -> IO ()
afterDBusObjectManagerObjectRemoved :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerObjectRemovedCallback -> m SignalHandlerId
genClosure_DBusObjectManagerObjectRemoved :: DBusObjectManagerObjectRemovedCallback -> IO Closure
mk_DBusObjectManagerObjectRemovedCallback :: C_DBusObjectManagerObjectRemovedCallback -> IO (FunPtr C_DBusObjectManagerObjectRemovedCallback)
noDBusObjectManagerObjectRemovedCallback :: Maybe DBusObjectManagerObjectRemovedCallback
onDBusObjectManagerObjectRemoved :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerObjectRemovedCallback -> m SignalHandlerId
wrap_DBusObjectManagerObjectRemovedCallback :: DBusObjectManagerObjectRemovedCallback -> C_DBusObjectManagerObjectRemovedCallback

Exported types

newtype DBusObjectManager Source #

Memory-managed wrapper type.

Constructors

DBusObjectManager (ManagedPtr DBusObjectManager)

Instances

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

noDBusObjectManager :: Maybe DBusObjectManager Source #

A convenience alias for Nothing :: Maybe DBusObjectManager.

class GObject o => IsDBusObjectManager o Source #

Type class for types which can be safely cast to DBusObjectManager, for instance with toDBusObjectManager.

Instances

(GObject a, (UnknownAncestorError DBusObjectManager a :: Constraint)) => IsDBusObjectManager a Source #
Instance details Defined in GI.Gio.Interfaces.DBusObjectManager
IsDBusObjectManager DBusObjectManager Source #
Instance details Defined in GI.Gio.Interfaces.DBusObjectManager
IsDBusObjectManager DBusObjectManagerClient Source #
Instance details Defined in GI.Gio.Objects.DBusObjectManagerClient
IsDBusObjectManager DBusObjectManagerServer Source #
Instance details Defined in GI.Gio.Objects.DBusObjectManagerServer

toDBusObjectManager :: (MonadIO m, IsDBusObjectManager o) => o -> m DBusObjectManager Source #

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

Methods

getInterface

dBusObjectManagerGetInterface Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusObjectManager a)
=> a	`manager`: A `DBusObjectManager`.
-> Text	`objectPath`: Object path to lookup.
-> Text	`interfaceName`: D-Bus interface name to lookup.
-> m DBusInterface	Returns: A `DBusInterface` instance or `Nothing`. Free with `objectUnref`.

Gets the interface proxy for interfaceName at objectPath, if any.

Since: 2.30

getObject

dBusObjectManagerGetObject Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusObjectManager a)
=> a	`manager`: A `DBusObjectManager`.
-> Text	`objectPath`: Object path to lookup.
-> m DBusObject	Returns: A `DBusObject` or `Nothing`. Free with `objectUnref`.

Gets the DBusObjectProxy at objectPath, if any.

Since: 2.30

getObjectPath

dBusObjectManagerGetObjectPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusObjectManager a)
=> a	`manager`: A `DBusObjectManager`.
-> m Text	Returns: A string owned by `manager`. Do not free.

Gets the object path that manager is for.

Since: 2.30

getObjects

dBusObjectManagerGetObjects Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusObjectManager a)
=> a	`manager`: A `DBusObjectManager`.
-> m [DBusObject]	Returns: A list of `DBusObject` objects. The returned list should be freed with `g_list_free()` after each element has been freed with `objectUnref`.

Gets all DBusObject objects known to manager.

Since: 2.30

Signals

interfaceAdded

type C_DBusObjectManagerInterfaceAddedCallback = Ptr () -> Ptr DBusObject -> Ptr DBusInterface -> Ptr () -> IO () Source #

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

type DBusObjectManagerInterfaceAddedCallback Source #

Arguments

= DBusObject	`object`: The `DBusObject` on which an interface was added.
-> DBusInterface	`interface`: The `DBusInterface` that was added.
-> IO ()

Emitted when interface is added to object.

This signal exists purely as a convenience to avoid having to connect signals to all objects managed by manager.

Since: 2.30

afterDBusObjectManagerInterfaceAdded :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerInterfaceAddedCallback -> 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 dBusObjectManager #interfaceAdded callback

genClosure_DBusObjectManagerInterfaceAdded :: DBusObjectManagerInterfaceAddedCallback -> IO Closure Source #

Wrap the callback into a Closure.

mk_DBusObjectManagerInterfaceAddedCallback :: C_DBusObjectManagerInterfaceAddedCallback -> IO (FunPtr C_DBusObjectManagerInterfaceAddedCallback) Source #

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

noDBusObjectManagerInterfaceAddedCallback :: Maybe DBusObjectManagerInterfaceAddedCallback Source #

A convenience synonym for Nothing :: Maybe DBusObjectManagerInterfaceAddedCallback.

onDBusObjectManagerInterfaceAdded :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerInterfaceAddedCallback -> 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 dBusObjectManager #interfaceAdded callback

wrap_DBusObjectManagerInterfaceAddedCallback :: DBusObjectManagerInterfaceAddedCallback -> C_DBusObjectManagerInterfaceAddedCallback Source #

Wrap a DBusObjectManagerInterfaceAddedCallback into a C_DBusObjectManagerInterfaceAddedCallback.

interfaceRemoved

type C_DBusObjectManagerInterfaceRemovedCallback = Ptr () -> Ptr DBusObject -> Ptr DBusInterface -> Ptr () -> IO () Source #

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

type DBusObjectManagerInterfaceRemovedCallback Source #

Arguments

= DBusObject	`object`: The `DBusObject` on which an interface was removed.
-> DBusInterface	`interface`: The `DBusInterface` that was removed.
-> IO ()

Emitted when interface has been removed from object.

This signal exists purely as a convenience to avoid having to connect signals to all objects managed by manager.

Since: 2.30

afterDBusObjectManagerInterfaceRemoved :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerInterfaceRemovedCallback -> 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 dBusObjectManager #interfaceRemoved callback

genClosure_DBusObjectManagerInterfaceRemoved :: DBusObjectManagerInterfaceRemovedCallback -> IO Closure Source #

Wrap the callback into a Closure.

mk_DBusObjectManagerInterfaceRemovedCallback :: C_DBusObjectManagerInterfaceRemovedCallback -> IO (FunPtr C_DBusObjectManagerInterfaceRemovedCallback) Source #

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

noDBusObjectManagerInterfaceRemovedCallback :: Maybe DBusObjectManagerInterfaceRemovedCallback Source #

A convenience synonym for Nothing :: Maybe DBusObjectManagerInterfaceRemovedCallback.

onDBusObjectManagerInterfaceRemoved :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerInterfaceRemovedCallback -> 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 dBusObjectManager #interfaceRemoved callback

wrap_DBusObjectManagerInterfaceRemovedCallback :: DBusObjectManagerInterfaceRemovedCallback -> C_DBusObjectManagerInterfaceRemovedCallback Source #

Wrap a DBusObjectManagerInterfaceRemovedCallback into a C_DBusObjectManagerInterfaceRemovedCallback.

objectAdded

type C_DBusObjectManagerObjectAddedCallback = Ptr () -> Ptr DBusObject -> Ptr () -> IO () Source #

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

type DBusObjectManagerObjectAddedCallback Source #

Arguments

= DBusObject	`object`: The `DBusObject` that was added.
-> IO ()

Emitted when object is added to manager.

Since: 2.30

afterDBusObjectManagerObjectAdded :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerObjectAddedCallback -> m SignalHandlerId Source #

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

after dBusObjectManager #objectAdded callback

genClosure_DBusObjectManagerObjectAdded :: DBusObjectManagerObjectAddedCallback -> IO Closure Source #

Wrap the callback into a Closure.

mk_DBusObjectManagerObjectAddedCallback :: C_DBusObjectManagerObjectAddedCallback -> IO (FunPtr C_DBusObjectManagerObjectAddedCallback) Source #

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

noDBusObjectManagerObjectAddedCallback :: Maybe DBusObjectManagerObjectAddedCallback Source #

A convenience synonym for Nothing :: Maybe DBusObjectManagerObjectAddedCallback.

onDBusObjectManagerObjectAdded :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerObjectAddedCallback -> m SignalHandlerId Source #

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

on dBusObjectManager #objectAdded callback

wrap_DBusObjectManagerObjectAddedCallback :: DBusObjectManagerObjectAddedCallback -> C_DBusObjectManagerObjectAddedCallback Source #

Wrap a DBusObjectManagerObjectAddedCallback into a C_DBusObjectManagerObjectAddedCallback.

objectRemoved

type C_DBusObjectManagerObjectRemovedCallback = Ptr () -> Ptr DBusObject -> Ptr () -> IO () Source #

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

type DBusObjectManagerObjectRemovedCallback Source #

Arguments

= DBusObject	`object`: The `DBusObject` that was removed.
-> IO ()

Emitted when object is removed from manager.

Since: 2.30

afterDBusObjectManagerObjectRemoved :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerObjectRemovedCallback -> m SignalHandlerId Source #

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

after dBusObjectManager #objectRemoved callback

genClosure_DBusObjectManagerObjectRemoved :: DBusObjectManagerObjectRemovedCallback -> IO Closure Source #

Wrap the callback into a Closure.

mk_DBusObjectManagerObjectRemovedCallback :: C_DBusObjectManagerObjectRemovedCallback -> IO (FunPtr C_DBusObjectManagerObjectRemovedCallback) Source #

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

noDBusObjectManagerObjectRemovedCallback :: Maybe DBusObjectManagerObjectRemovedCallback Source #

A convenience synonym for Nothing :: Maybe DBusObjectManagerObjectRemovedCallback.

onDBusObjectManagerObjectRemoved :: (IsDBusObjectManager a, MonadIO m) => a -> DBusObjectManagerObjectRemovedCallback -> m SignalHandlerId Source #

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

on dBusObjectManager #objectRemoved callback

wrap_DBusObjectManagerObjectRemovedCallback :: DBusObjectManagerObjectRemovedCallback -> C_DBusObjectManagerObjectRemovedCallback Source #

Wrap a DBusObjectManagerObjectRemovedCallback into a C_DBusObjectManagerObjectRemovedCallback.