gi-gio-2.0.29: Gio bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Gio.Structs.DBusArgInfo

Description

Information about an argument for a method or a signal.

Since: 2.26

Synopsis

Exported types

newtype DBusArgInfo Source #

Memory-managed wrapper type.

newZeroDBusArgInfo :: MonadIO m => m DBusArgInfo Source #

Construct a DBusArgInfo struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

ref, unref.

Getters

None.

Setters

None.

ref

dBusArgInfoRef Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> DBusArgInfo

info: A DBusArgInfo

-> m DBusArgInfo

Returns: The same info.

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

Since: 2.26

unref

dBusArgInfoUnref Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> DBusArgInfo

info: A DBusArgInfo.

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

clearDBusArgInfoAnnotations :: MonadIO m => DBusArgInfo -> m () Source #

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

clear #annotations

getDBusArgInfoAnnotations :: MonadIO m => DBusArgInfo -> m (Maybe [DBusAnnotationInfo]) Source #

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

get dBusArgInfo #annotations

setDBusArgInfoAnnotations :: MonadIO m => DBusArgInfo -> Ptr (Ptr DBusAnnotationInfo) -> m () Source #

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

set dBusArgInfo [ #annotations := value ]

name

Name of the argument, e.g. unixUserId.

clearDBusArgInfoName :: MonadIO m => DBusArgInfo -> m () Source #

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

clear #name

getDBusArgInfoName :: MonadIO m => DBusArgInfo -> m (Maybe Text) Source #

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

get dBusArgInfo #name

setDBusArgInfoName :: MonadIO m => DBusArgInfo -> CString -> m () Source #

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

set dBusArgInfo [ #name := value ]

refCount

The reference count or -1 if statically allocated.

getDBusArgInfoRefCount :: MonadIO m => DBusArgInfo -> m Int32 Source #

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

get dBusArgInfo #refCount

setDBusArgInfoRefCount :: MonadIO m => DBusArgInfo -> Int32 -> m () Source #

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

set dBusArgInfo [ #refCount := value ]

signature

D-Bus signature of the argument (a single complete type).

clearDBusArgInfoSignature :: MonadIO m => DBusArgInfo -> m () Source #

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

clear #signature

getDBusArgInfoSignature :: MonadIO m => DBusArgInfo -> m (Maybe Text) Source #

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

get dBusArgInfo #signature

setDBusArgInfoSignature :: MonadIO m => DBusArgInfo -> CString -> m () Source #

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

set dBusArgInfo [ #signature := value ]