Interface ICefXmlReader

Description
Hierarchy
Methods

Unit

uCEFInterfaces

Declaration

type ICefXmlReader = interface(ICefBaseRefCounted)

Description

Interface that supports the reading of XML data via the libxml streaming API. The functions of this interface should only be called on the thread that creates the object.

UNKNOWN

<see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_xml_reader_capi.h">CEF source file: /include/capi/cef_xml_reader_capi.h (cef_xml_reader_t))

Hierarchy

Overview

Methods

Public function MoveToNextNode: Boolean;
Public function Close: Boolean;
Public function HasError: Boolean;
Public function GetError: ustring;
Public function GetType: TCefXmlNodeType;
Public function GetDepth: Integer;
Public function GetLocalName: ustring;
Public function GetPrefix: ustring;
Public function GetQualifiedName: ustring;
Public function GetNamespaceUri: ustring;
Public function GetBaseUri: ustring;
Public function GetXmlLang: ustring;
Public function IsEmptyElement: Boolean;
Public function HasValue: Boolean;
Public function GetValue: ustring;
Public function HasAttributes: Boolean;
Public function GetAttributeCount: NativeUInt;
Public function GetAttributeByIndex(index: Integer): ustring;
Public function GetAttributeByQName(const qualifiedName: ustring): ustring;
Public function GetAttributeByLName(const localName, namespaceURI: ustring): ustring;
Public function GetInnerXml: ustring;
Public function GetOuterXml: ustring;
Public function GetLineNumber: Integer;
Public function MoveToAttributeByIndex(index: Integer): Boolean;
Public function MoveToAttributeByQName(const qualifiedName: ustring): Boolean;
Public function MoveToAttributeByLName(const localName, namespaceURI: ustring): Boolean;
Public function MoveToFirstAttribute: Boolean;
Public function MoveToNextAttribute: Boolean;
Public function MoveToCarryingElement: Boolean;

Description

Methods

Public function MoveToNextNode: Boolean;

Moves the cursor to the next node in the document. This function must be called at least once to set the current cursor position. Returns true (1) if the cursor position was set successfully.

Attributes
GUID['{0DE686C3-A8D7-45D2-82FD-92F7F4E62A90}']
Public function Close: Boolean;

Close the document. This should be called directly to ensure that cleanup occurs on the correct thread.

Public function HasError: Boolean;

Returns true (1) if an error has been reported by the XML parser.

Public function GetError: ustring;

Returns the error string.

Public function GetType: TCefXmlNodeType;

Returns the node type.

Public function GetDepth: Integer;

Returns the node depth. Depth starts at 0 for the root node.

Public function GetLocalName: ustring;

Returns the local name. See http://www.w3.org/TR/REC-xml-names/#NT- LocalPart for additional details.

Public function GetPrefix: ustring;

Returns the namespace prefix. See http://www.w3.org/TR/REC-xml-names/ for additional details.

Public function GetQualifiedName: ustring;

Returns the qualified name, equal to (Prefix:)LocalName. See http://www.w3.org/TR/REC-xml-names/#ns-qualnames for additional details.

Public function GetNamespaceUri: ustring;

Returns the URI defining the namespace associated with the node. See http://www.w3.org/TR/REC-xml-names/ for additional details.

Public function GetBaseUri: ustring;

Returns the base URI of the node. See http://www.w3.org/TR/xmlbase/ for additional details.

Public function GetXmlLang: ustring;

Returns the xml:lang scope within which the node resides. See http://www.w3.org/TR/REC-xml/#sec-lang-tag for additional details.

Public function IsEmptyElement: Boolean;

Returns true (1) if the node represents an NULL element. "<a/>" is considered NULL but "<a></a>" is not.

Public function HasValue: Boolean;

Returns true (1) if the node has a text value.

Public function GetValue: ustring;

Returns the text value.

Public function HasAttributes: Boolean;

Returns true (1) if the node has attributes.

Public function GetAttributeCount: NativeUInt;

Returns the number of attributes.

Public function GetAttributeByIndex(index: Integer): ustring;

Returns the value of the attribute at the specified 0-based index.

Public function GetAttributeByQName(const qualifiedName: ustring): ustring;

Returns the value of the attribute with the specified qualified name.

Public function GetAttributeByLName(const localName, namespaceURI: ustring): ustring;

Returns the value of the attribute with the specified local name and namespace URI.

Public function GetInnerXml: ustring;

Returns an XML representation of the current node's children.

Public function GetOuterXml: ustring;

Returns an XML representation of the current node including its children.

Public function GetLineNumber: Integer;

Returns the line number for the current node.

Public function MoveToAttributeByIndex(index: Integer): Boolean;

Moves the cursor to the attribute at the specified 0-based index. Returns true (1) if the cursor position was set successfully.

Public function MoveToAttributeByQName(const qualifiedName: ustring): Boolean;

Moves the cursor to the attribute with the specified qualified name. Returns true (1) if the cursor position was set successfully.

Public function MoveToAttributeByLName(const localName, namespaceURI: ustring): Boolean;

Moves the cursor to the attribute with the specified local name and namespace URI. Returns true (1) if the cursor position was set successfully.

Public function MoveToFirstAttribute: Boolean;

Moves the cursor to the first attribute in the current element. Returns true (1) if the cursor position was set successfully.

Public function MoveToNextAttribute: Boolean;

Moves the cursor to the next attribute in the current element. Returns true (1) if the cursor position was set successfully.

Public function MoveToCarryingElement: Boolean;

Moves the cursor back to the carrying element. Returns true (1) if the cursor position was set successfully.

Generated by PasDoc 1.0.4.