gi-gio-2.0.24: Gio bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.Gio.Interfaces.DBusObjectManager

Contents

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

Exported types

class (GObject o, IsDescendantOf DBusObjectManager o) => IsDBusObjectManager o Source #

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

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

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

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

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

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

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

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

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