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 |
Information about nodes in a remote object hierarchy.
- newtype DBusNodeInfo = DBusNodeInfo (ManagedPtr DBusNodeInfo)
- newZeroDBusNodeInfo :: MonadIO m => m DBusNodeInfo
- noDBusNodeInfo :: Maybe DBusNodeInfo
- data DBusNodeInfoGenerateXmlMethodInfo
- dBusNodeInfoGenerateXml :: (HasCallStack, MonadIO m) => DBusNodeInfo -> Word32 -> m String
- data DBusNodeInfoLookupInterfaceMethodInfo
- dBusNodeInfoLookupInterface :: (HasCallStack, MonadIO m) => DBusNodeInfo -> Text -> m DBusInterfaceInfo
- dBusNodeInfoNewForXml :: (HasCallStack, MonadIO m) => Text -> m DBusNodeInfo
- data DBusNodeInfoRefMethodInfo
- dBusNodeInfoRef :: (HasCallStack, MonadIO m) => DBusNodeInfo -> m DBusNodeInfo
- data DBusNodeInfoUnrefMethodInfo
- dBusNodeInfoUnref :: (HasCallStack, MonadIO m) => DBusNodeInfo -> m ()
- clearDBusNodeInfoAnnotations :: MonadIO m => DBusNodeInfo -> m ()
- dBusNodeInfo_annotations :: AttrLabelProxy "annotations"
- getDBusNodeInfoAnnotations :: MonadIO m => DBusNodeInfo -> m (Maybe [DBusAnnotationInfo])
- setDBusNodeInfoAnnotations :: MonadIO m => DBusNodeInfo -> Ptr (Ptr DBusAnnotationInfo) -> m ()
- clearDBusNodeInfoInterfaces :: MonadIO m => DBusNodeInfo -> m ()
- dBusNodeInfo_interfaces :: AttrLabelProxy "interfaces"
- getDBusNodeInfoInterfaces :: MonadIO m => DBusNodeInfo -> m (Maybe [DBusInterfaceInfo])
- setDBusNodeInfoInterfaces :: MonadIO m => DBusNodeInfo -> Ptr (Ptr DBusInterfaceInfo) -> m ()
- clearDBusNodeInfoNodes :: MonadIO m => DBusNodeInfo -> m ()
- dBusNodeInfo_nodes :: AttrLabelProxy "nodes"
- getDBusNodeInfoNodes :: MonadIO m => DBusNodeInfo -> m (Maybe [DBusNodeInfo])
- setDBusNodeInfoNodes :: MonadIO m => DBusNodeInfo -> Ptr (Ptr DBusNodeInfo) -> m ()
- clearDBusNodeInfoPath :: MonadIO m => DBusNodeInfo -> m ()
- dBusNodeInfo_path :: AttrLabelProxy "path"
- getDBusNodeInfoPath :: MonadIO m => DBusNodeInfo -> m (Maybe Text)
- setDBusNodeInfoPath :: MonadIO m => DBusNodeInfo -> CString -> m ()
- dBusNodeInfo_refCount :: AttrLabelProxy "refCount"
- getDBusNodeInfoRefCount :: MonadIO m => DBusNodeInfo -> m Int32
- setDBusNodeInfoRefCount :: MonadIO m => DBusNodeInfo -> Int32 -> m ()
Exported types
newtype DBusNodeInfo Source #
BoxedObject DBusNodeInfo Source # | |
(~) AttrOpTag tag AttrSet => Constructible DBusNodeInfo tag Source # | |
((~) * info (ResolveDBusNodeInfoMethod t DBusNodeInfo), MethodInfo * info DBusNodeInfo p) => IsLabel t (DBusNodeInfo -> p) Source # | |
((~) * info (ResolveDBusNodeInfoMethod t DBusNodeInfo), MethodInfo * info DBusNodeInfo p) => IsLabelProxy t (DBusNodeInfo -> p) Source # | |
HasAttributeList * DBusNodeInfo Source # | |
((~) * signature (m ()), MonadIO m) => MethodInfo * DBusNodeInfoUnrefMethodInfo DBusNodeInfo signature Source # | |
((~) * signature (m DBusNodeInfo), MonadIO m) => MethodInfo * DBusNodeInfoRefMethodInfo DBusNodeInfo signature Source # | |
((~) * signature (Text -> m DBusInterfaceInfo), MonadIO m) => MethodInfo * DBusNodeInfoLookupInterfaceMethodInfo DBusNodeInfo signature Source # | |
((~) * signature (Word32 -> m String), MonadIO m) => MethodInfo * DBusNodeInfoGenerateXmlMethodInfo DBusNodeInfo signature Source # | |
type AttributeList DBusNodeInfo Source # | |
newZeroDBusNodeInfo :: MonadIO m => m DBusNodeInfo Source #
Construct a DBusNodeInfo
struct initialized to zero.
Methods
generateXml
data DBusNodeInfoGenerateXmlMethodInfo Source #
((~) * signature (Word32 -> m String), MonadIO m) => MethodInfo * DBusNodeInfoGenerateXmlMethodInfo DBusNodeInfo signature Source # | |
dBusNodeInfoGenerateXml Source #
:: (HasCallStack, MonadIO m) | |
=> DBusNodeInfo |
|
-> Word32 |
|
-> m String |
Appends an XML representation of info
(and its children) to stringBuilder
.
This function is typically used for generating introspection XML documents at run-time for
handling the org.freedesktop.DBus.Introspectable.Introspect
method.
Since: 2.26
lookupInterface
data DBusNodeInfoLookupInterfaceMethodInfo Source #
((~) * signature (Text -> m DBusInterfaceInfo), MonadIO m) => MethodInfo * DBusNodeInfoLookupInterfaceMethodInfo DBusNodeInfo signature Source # | |
dBusNodeInfoLookupInterface Source #
:: (HasCallStack, MonadIO m) | |
=> DBusNodeInfo |
|
-> Text |
|
-> m DBusInterfaceInfo | Returns: A |
Looks up information about an interface.
The cost of this function is O(n) in number of interfaces.
Since: 2.26
newForXml
dBusNodeInfoNewForXml Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m DBusNodeInfo | Returns: A |
Parses xmlData
and returns a DBusNodeInfo
representing the data.
The introspection XML must contain exactly one top-level <node> element.
Note that this routine is using a [GMarkup][glib-Simple-XML-Subset-Parser.description]-based parser that only accepts a subset of valid XML documents.
Since: 2.26
ref
data DBusNodeInfoRefMethodInfo Source #
((~) * signature (m DBusNodeInfo), MonadIO m) => MethodInfo * DBusNodeInfoRefMethodInfo DBusNodeInfo signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> DBusNodeInfo |
|
-> m DBusNodeInfo | Returns: The same |
If info
is statically allocated does nothing. Otherwise increases
the reference count.
Since: 2.26
unref
data DBusNodeInfoUnrefMethodInfo Source #
((~) * signature (m ()), MonadIO m) => MethodInfo * DBusNodeInfoUnrefMethodInfo DBusNodeInfo signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> DBusNodeInfo |
|
-> m () |
If info
is statically allocated, does nothing. Otherwise decreases
the reference count of info
. When its reference count drops to 0,
the memory used is freed.
Since: 2.26
Properties
annotations
clearDBusNodeInfoAnnotations :: MonadIO m => DBusNodeInfo -> m () Source #
dBusNodeInfo_annotations :: AttrLabelProxy "annotations" Source #
getDBusNodeInfoAnnotations :: MonadIO m => DBusNodeInfo -> m (Maybe [DBusAnnotationInfo]) Source #
setDBusNodeInfoAnnotations :: MonadIO m => DBusNodeInfo -> Ptr (Ptr DBusAnnotationInfo) -> m () Source #
interfaces
clearDBusNodeInfoInterfaces :: MonadIO m => DBusNodeInfo -> m () Source #
dBusNodeInfo_interfaces :: AttrLabelProxy "interfaces" Source #
getDBusNodeInfoInterfaces :: MonadIO m => DBusNodeInfo -> m (Maybe [DBusInterfaceInfo]) Source #
setDBusNodeInfoInterfaces :: MonadIO m => DBusNodeInfo -> Ptr (Ptr DBusInterfaceInfo) -> m () Source #
nodes
clearDBusNodeInfoNodes :: MonadIO m => DBusNodeInfo -> m () Source #
dBusNodeInfo_nodes :: AttrLabelProxy "nodes" Source #
getDBusNodeInfoNodes :: MonadIO m => DBusNodeInfo -> m (Maybe [DBusNodeInfo]) Source #
setDBusNodeInfoNodes :: MonadIO m => DBusNodeInfo -> Ptr (Ptr DBusNodeInfo) -> m () Source #
path
clearDBusNodeInfoPath :: MonadIO m => DBusNodeInfo -> m () Source #
dBusNodeInfo_path :: AttrLabelProxy "path" Source #
getDBusNodeInfoPath :: MonadIO m => DBusNodeInfo -> m (Maybe Text) Source #
setDBusNodeInfoPath :: MonadIO m => DBusNodeInfo -> CString -> m () Source #
refCount
dBusNodeInfo_refCount :: AttrLabelProxy "refCount" Source #
getDBusNodeInfoRefCount :: MonadIO m => DBusNodeInfo -> m Int32 Source #
setDBusNodeInfoRefCount :: MonadIO m => DBusNodeInfo -> Int32 -> m () Source #