GI.Gio.Structs.DBusNodeInfo

Information about nodes in a remote object hierarchy.

Since: 2.26

Exported types

newtype DBusNodeInfo

Memory-managed wrapper type.

Constructors

DBusNodeInfo (ManagedPtr DBusNodeInfo)

Instances

Eq DBusNodeInfo

Defined in GI.Gio.Structs.DBusNodeInfo

Methods

(==) :: DBusNodeInfo -> DBusNodeInfo -> Bool

(/=) :: DBusNodeInfo -> DBusNodeInfo -> Bool

BoxedObject DBusNodeInfo

Defined in GI.Gio.Structs.DBusNodeInfo

Methods

boxedType :: DBusNodeInfo -> IO GType

IsGValue DBusNodeInfo

Convert DBusNodeInfo to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Structs.DBusNodeInfo

Methods

toGValue :: DBusNodeInfo -> IO GValue

fromGValue :: GValue -> IO DBusNodeInfo

tag ~ 'AttrSet => Constructible DBusNodeInfo tag

Defined in GI.Gio.Structs.DBusNodeInfo

Methods

new :: MonadIO m => (ManagedPtr DBusNodeInfo -> DBusNodeInfo) -> [AttrOp DBusNodeInfo tag] -> m DBusNodeInfo

newZeroDBusNodeInfo :: MonadIO m => m DBusNodeInfo

Construct a DBusNodeInfo struct initialized to zero.

noDBusNodeInfo :: Maybe DBusNodeInfo

A convenience alias for Nothing :: Maybe DBusNodeInfo.

Methods

Overloaded methods

generateXml

dBusNodeInfoGenerateXml

Arguments

:: (HasCallStack, MonadIO m)

=> DBusNodeInfo

info: A DBusNodeInfo.

-> Word32

indent: Indentation level.

-> String

stringBuilder: A String to to append XML data to.

-> m ()

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

dBusNodeInfoLookupInterface

Arguments

:: (HasCallStack, MonadIO m)

=> DBusNodeInfo

info: A DBusNodeInfo.

-> Text

name: A D-Bus interface name.

-> m DBusInterfaceInfo

Returns: A DBusInterfaceInfo or Nothing if not found. Do not free, it is owned by info.

Looks up information about an interface.

The cost of this function is O(n) in number of interfaces.

Since: 2.26

newForXml

dBusNodeInfoNewForXml

Arguments

:: (HasCallStack, MonadIO m)

=> Text

xmlData: Valid D-Bus introspection XML.

-> m DBusNodeInfo

Returns: A DBusNodeInfo structure or Nothing if error is set. Free with dBusNodeInfoUnref. (Can throw GError)

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

dBusNodeInfoRef

Arguments

:: (HasCallStack, MonadIO m)

=> DBusNodeInfo

info: A DBusNodeInfo

-> m DBusNodeInfo

Returns: The same info.

If info is statically allocated does nothing. Otherwise increases the reference count.

Since: 2.26

unref

dBusNodeInfoUnref

Arguments

:: (HasCallStack, MonadIO m)

=> DBusNodeInfo

info: A 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

A pointer to a Nothing-terminated array of pointers to DBusAnnotationInfo structures or Nothing if there are no annotations.

clearDBusNodeInfoAnnotations :: MonadIO m => DBusNodeInfo -> m ()

Set the value of the “annotations” field to Nothing. When overloading is enabled, this is equivalent to

clear #annotations

getDBusNodeInfoAnnotations :: MonadIO m => DBusNodeInfo -> m (Maybe [DBusAnnotationInfo])

Get the value of the “annotations” field. When overloading is enabled, this is equivalent to

get dBusNodeInfo #annotations

setDBusNodeInfoAnnotations :: MonadIO m => DBusNodeInfo -> Ptr (Ptr DBusAnnotationInfo) -> m ()

Set the value of the “annotations” field. When overloading is enabled, this is equivalent to

set dBusNodeInfo [ #annotations := value ]

interfaces

A pointer to a Nothing-terminated array of pointers to DBusInterfaceInfo structures or Nothing if there are no interfaces.

clearDBusNodeInfoInterfaces :: MonadIO m => DBusNodeInfo -> m ()

Set the value of the “interfaces” field to Nothing. When overloading is enabled, this is equivalent to

clear #interfaces

getDBusNodeInfoInterfaces :: MonadIO m => DBusNodeInfo -> m (Maybe [DBusInterfaceInfo])

Get the value of the “interfaces” field. When overloading is enabled, this is equivalent to

get dBusNodeInfo #interfaces

setDBusNodeInfoInterfaces :: MonadIO m => DBusNodeInfo -> Ptr (Ptr DBusInterfaceInfo) -> m ()

Set the value of the “interfaces” field. When overloading is enabled, this is equivalent to

set dBusNodeInfo [ #interfaces := value ]

nodes

A pointer to a Nothing-terminated array of pointers to DBusNodeInfo structures or Nothing if there are no nodes.

clearDBusNodeInfoNodes :: MonadIO m => DBusNodeInfo -> m ()

Set the value of the “nodes” field to Nothing. When overloading is enabled, this is equivalent to

clear #nodes

getDBusNodeInfoNodes :: MonadIO m => DBusNodeInfo -> m (Maybe [DBusNodeInfo])

Get the value of the “nodes” field. When overloading is enabled, this is equivalent to

get dBusNodeInfo #nodes

setDBusNodeInfoNodes :: MonadIO m => DBusNodeInfo -> Ptr (Ptr DBusNodeInfo) -> m ()

Set the value of the “nodes” field. When overloading is enabled, this is equivalent to

set dBusNodeInfo [ #nodes := value ]

path

The path of the node or Nothing if omitted. Note that this may be a relative path. See the D-Bus specification for more details.

clearDBusNodeInfoPath :: MonadIO m => DBusNodeInfo -> m ()

Set the value of the “path” field to Nothing. When overloading is enabled, this is equivalent to

clear #path

getDBusNodeInfoPath :: MonadIO m => DBusNodeInfo -> m (Maybe Text)

Get the value of the “path” field. When overloading is enabled, this is equivalent to

get dBusNodeInfo #path

setDBusNodeInfoPath :: MonadIO m => DBusNodeInfo -> CString -> m ()

Set the value of the “path” field. When overloading is enabled, this is equivalent to

set dBusNodeInfo [ #path := value ]

refCount

The reference count or -1 if statically allocated.

getDBusNodeInfoRefCount :: MonadIO m => DBusNodeInfo -> m Int32

Get the value of the “ref_count” field. When overloading is enabled, this is equivalent to

get dBusNodeInfo #refCount

setDBusNodeInfoRefCount :: MonadIO m => DBusNodeInfo -> Int32 -> m ()

Set the value of the “ref_count” field. When overloading is enabled, this is equivalent to

set dBusNodeInfo [ #refCount := value ]