| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Gio.Objects.DBusObjectSkeleton
Description
A DBusObjectSkeleton instance is essentially a group of D-Bus
interfaces. The set of exported interfaces on the object may be
dynamic and change at runtime.
This type is intended to be used with DBusObjectManager.
Since: 2.30
Synopsis
- newtype DBusObjectSkeleton = DBusObjectSkeleton (ManagedPtr DBusObjectSkeleton)
- class (GObject o, IsDescendantOf DBusObjectSkeleton o) => IsDBusObjectSkeleton o
- toDBusObjectSkeleton :: (MonadIO m, IsDBusObjectSkeleton o) => o -> m DBusObjectSkeleton
- dBusObjectSkeletonAddInterface :: (HasCallStack, MonadIO m, IsDBusObjectSkeleton a, IsDBusInterfaceSkeleton b) => a -> b -> m ()
- dBusObjectSkeletonFlush :: (HasCallStack, MonadIO m, IsDBusObjectSkeleton a) => a -> m ()
- dBusObjectSkeletonNew :: (HasCallStack, MonadIO m) => Text -> m DBusObjectSkeleton
- dBusObjectSkeletonRemoveInterface :: (HasCallStack, MonadIO m, IsDBusObjectSkeleton a, IsDBusInterfaceSkeleton b) => a -> b -> m ()
- dBusObjectSkeletonRemoveInterfaceByName :: (HasCallStack, MonadIO m, IsDBusObjectSkeleton a) => a -> Text -> m ()
- dBusObjectSkeletonSetObjectPath :: (HasCallStack, MonadIO m, IsDBusObjectSkeleton a) => a -> Text -> m ()
- clearDBusObjectSkeletonGObjectPath :: (MonadIO m, IsDBusObjectSkeleton o) => o -> m ()
- constructDBusObjectSkeletonGObjectPath :: (IsDBusObjectSkeleton o, MonadIO m) => Text -> m (GValueConstruct o)
- getDBusObjectSkeletonGObjectPath :: (MonadIO m, IsDBusObjectSkeleton o) => o -> m (Maybe Text)
- setDBusObjectSkeletonGObjectPath :: (MonadIO m, IsDBusObjectSkeleton o) => o -> Text -> m ()
- type DBusObjectSkeletonAuthorizeMethodCallback = DBusInterfaceSkeleton -> DBusMethodInvocation -> IO Bool
- afterDBusObjectSkeletonAuthorizeMethod :: (IsDBusObjectSkeleton a, MonadIO m) => a -> ((?self :: a) => DBusObjectSkeletonAuthorizeMethodCallback) -> m SignalHandlerId
- onDBusObjectSkeletonAuthorizeMethod :: (IsDBusObjectSkeleton a, MonadIO m) => a -> ((?self :: a) => DBusObjectSkeletonAuthorizeMethodCallback) -> m SignalHandlerId
Exported types
newtype DBusObjectSkeleton Source #
Memory-managed wrapper type.
Constructors
| DBusObjectSkeleton (ManagedPtr DBusObjectSkeleton) |
Instances
class (GObject o, IsDescendantOf DBusObjectSkeleton o) => IsDBusObjectSkeleton o Source #
Type class for types which can be safely cast to DBusObjectSkeleton, for instance with toDBusObjectSkeleton.
Instances
| (GObject o, IsDescendantOf DBusObjectSkeleton o) => IsDBusObjectSkeleton o Source # | |
Defined in GI.Gio.Objects.DBusObjectSkeleton | |
toDBusObjectSkeleton :: (MonadIO m, IsDBusObjectSkeleton o) => o -> m DBusObjectSkeleton Source #
Cast to DBusObjectSkeleton, 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
addInterface, bindProperty, bindPropertyFull, flush, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, removeInterface, removeInterfaceByName, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getInterface, getInterfaces, getObjectPath, getProperty, getQdata.
Setters
addInterface
dBusObjectSkeletonAddInterface Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDBusObjectSkeleton a, IsDBusInterfaceSkeleton b) | |
| => a |
|
| -> b |
|
| -> m () |
Adds interface_ to object.
If object already contains a DBusInterfaceSkeleton with the same
interface name, it is removed before interface_ is added.
Note that object takes its own reference on interface_ and holds
it until removed.
Since: 2.30
flush
dBusObjectSkeletonFlush Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDBusObjectSkeleton a) | |
| => a |
|
| -> m () |
This method simply calls dBusInterfaceSkeletonFlush on all
interfaces belonging to object. See that method for when flushing
is useful.
Since: 2.30
new
dBusObjectSkeletonNew Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Text |
|
| -> m DBusObjectSkeleton | Returns: A |
Creates a new DBusObjectSkeleton.
Since: 2.30
removeInterface
dBusObjectSkeletonRemoveInterface Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDBusObjectSkeleton a, IsDBusInterfaceSkeleton b) | |
| => a |
|
| -> b |
|
| -> m () |
Removes interface_ from object.
Since: 2.30
removeInterfaceByName
dBusObjectSkeletonRemoveInterfaceByName Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDBusObjectSkeleton a) | |
| => a |
|
| -> Text |
|
| -> m () |
Removes the DBusInterface with interfaceName from object.
If no D-Bus interface of the given interface exists, this function does nothing.
Since: 2.30
setObjectPath
dBusObjectSkeletonSetObjectPath Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDBusObjectSkeleton a) | |
| => a |
|
| -> Text |
|
| -> m () |
Sets the object path for object.
Since: 2.30
Properties
gObjectPath
The object path where the object is exported.
Since: 2.30
clearDBusObjectSkeletonGObjectPath :: (MonadIO m, IsDBusObjectSkeleton o) => o -> m () Source #
Set the value of the “g-object-path” property to Nothing.
When overloading is enabled, this is equivalent to
clear #gObjectPath
constructDBusObjectSkeletonGObjectPath :: (IsDBusObjectSkeleton o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “g-object-path” property. This is rarely needed directly, but it is used by new.
getDBusObjectSkeletonGObjectPath :: (MonadIO m, IsDBusObjectSkeleton o) => o -> m (Maybe Text) Source #
Get the value of the “g-object-path” property.
When overloading is enabled, this is equivalent to
get dBusObjectSkeleton #gObjectPath
setDBusObjectSkeletonGObjectPath :: (MonadIO m, IsDBusObjectSkeleton o) => o -> Text -> m () Source #
Set the value of the “g-object-path” property.
When overloading is enabled, this is equivalent to
setdBusObjectSkeleton [ #gObjectPath:=value ]
Signals
authorizeMethod
type DBusObjectSkeletonAuthorizeMethodCallback Source #
Arguments
| = DBusInterfaceSkeleton |
|
| -> DBusMethodInvocation |
|
| -> IO Bool |
Emitted when a method is invoked by a remote caller and used to determine if the method call is authorized.
This signal is like DBusInterfaceSkeleton's
DBusInterfaceSkeleton::gAuthorizeMethod signal,
except that it is for the enclosing object.
The default class handler just returns True.
Since: 2.30
afterDBusObjectSkeletonAuthorizeMethod :: (IsDBusObjectSkeleton a, MonadIO m) => a -> ((?self :: a) => DBusObjectSkeletonAuthorizeMethodCallback) -> m SignalHandlerId Source #
Connect a signal handler for the authorizeMethod signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after dBusObjectSkeleton #authorizeMethod 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.
onDBusObjectSkeletonAuthorizeMethod :: (IsDBusObjectSkeleton a, MonadIO m) => a -> ((?self :: a) => DBusObjectSkeletonAuthorizeMethodCallback) -> m SignalHandlerId Source #
Connect a signal handler for the authorizeMethod signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on dBusObjectSkeleton #authorizeMethod callback