GI.IBus.Structs.XML

IBusXML lists data structure and handling function for XML in IBus.

Exported types

newtype XML

Memory-managed wrapper type.

Constructors

XML (ManagedPtr XML)

Instances

Eq XML

Defined in GI.IBus.Structs.XML

Methods

(==) :: XML -> XML -> Bool

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

IsGValue XML

Convert XML to and from GValue with toGValue and fromGValue.

Defined in GI.IBus.Structs.XML

Methods

toGValue :: XML -> IO GValue

fromGValue :: GValue -> IO XML

BoxedObject XML

Defined in GI.IBus.Structs.XML

Methods

boxedType :: XML -> IO GType

tag ~ 'AttrSet => Constructible XML tag

Defined in GI.IBus.Structs.XML

Methods

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

newZeroXML :: MonadIO m => m XML

Construct a XML struct initialized to zero.

Methods

Overloaded methods

copy

xMLCopy

Arguments

:: (HasCallStack, MonadIO m)

=> XML

node: Root node of an XML tree.

-> m XML

Returns: the newly allocated XML, which should be freed with xMLFree, or Nothing if node was Nothing.

Creates a copy of node, which should be freed with xMLFree. Primarily used by language bindings, not that useful otherwise (since node can just be copied by assignment in C).

free

xMLFree

Arguments

:: (HasCallStack, MonadIO m)

=> XML

node: Root node of an XML tree.

-> m ()

Free an XML tree.

output

xMLOutput

Arguments

:: (HasCallStack, MonadIO m)

=> XML

node: Root node of an XML tree.

-> String

output: GString which stores the output.

-> m ()

Output an XML tree to a GString.

parseBuffer

xMLParseBuffer

Arguments

:: (HasCallStack, MonadIO m)

=> Text

buffer: Buffer to be parsed.

-> m XML

Returns: Root node of parsed XML tree.

Parse a string buffer which contains an XML-formatted string, and return a corresponding XML tree.

parseFile

xMLParseFile

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: File name to be parsed.

-> m XML

Returns: Root node of parsed XML tree.

Parse an XML file and return a corresponding XML tree.

Properties

attributes

Attributes of the XML node.

clearXMLAttributes :: MonadIO m => XML -> m ()

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

clear #attributes

getXMLAttributes :: MonadIO m => XML -> m (Maybe Text)

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

get xML #attributes

setXMLAttributes :: MonadIO m => XML -> CString -> m ()

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

set xML [ #attributes := value ]

name

Name of XML tag.

clearXMLName :: MonadIO m => XML -> m ()

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

clear #name

getXMLName :: MonadIO m => XML -> m (Maybe Text)

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

get xML #name

setXMLName :: MonadIO m => XML -> CString -> m ()

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

set xML [ #name := value ]

subNodes

Children node of this XML node.

clearXMLSubNodes :: MonadIO m => XML -> m ()

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

clear #subNodes

getXMLSubNodes :: MonadIO m => XML -> m [Ptr ()]

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

get xML #subNodes

setXMLSubNodes :: MonadIO m => XML -> Ptr (GList (Ptr ())) -> m ()

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

set xML [ #subNodes := value ]

text

Text enclosed by XML start tag and end tag. i.e. <tag>text</tag>.

clearXMLText :: MonadIO m => XML -> m ()

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

clear #text

getXMLText :: MonadIO m => XML -> m (Maybe Text)

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

get xML #text

setXMLText :: MonadIO m => XML -> CString -> m ()

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

set xML [ #text := value ]