Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

(default)
Class CefXmlReader

CefBaseRefCounted
   |
   +--CefXmlReader

   in cef_xml_reader.h

class CefXmlReader
extends CefBaseRefCounted

Class that supports the reading of XML data via the libxml streaming API. The methods of this class should only be called on the thread that creates the object.


Inner Classes, Typedefs, and Enums
typedef CefXmlReader::EncodingType
          
typedef CefXmlReader::NodeType
          
 
Method Summary
 virtual bool Close()= 0
          Close the document.
 static CefRefPtr< CefXmlReader > Create( CefRefPtr< CefStreamReader > stream, CefXmlReader::EncodingType encodingType, const CefString& URI )
          Create a new CefXmlReader object.
 virtual CefString GetAttribute( int index )= 0
          Returns the value of the attribute at the specified 0-based index.
 virtual CefString GetAttribute( const CefString& localName, const CefString& namespaceURI )= 0
          Returns the value of the attribute with the specified local name and namespace URI.
 virtual CefString GetAttribute( const CefString& qualifiedName )= 0
          Returns the value of the attribute with the specified qualified name.
 virtual size_t GetAttributeCount()= 0
          Returns the number of attributes.
 virtual CefString GetBaseURI()= 0
          Returns the base URI of the node.
 virtual int GetDepth()= 0
          Returns the node depth.
 virtual CefString GetError()= 0
          Returns the error string.
 virtual CefString GetInnerXml()= 0
          Returns an XML representation of the current node's children.
 virtual int GetLineNumber()= 0
          Returns the line number for the current node.
 virtual CefString GetLocalName()= 0
          Returns the local name.
 virtual CefString GetNamespaceURI()= 0
          Returns the URI defining the namespace associated with the node.
 virtual CefString GetOuterXml()= 0
          Returns an XML representation of the current node including its children.
 virtual CefString GetPrefix()= 0
          Returns the namespace prefix.
 virtual CefString GetQualifiedName()= 0
          Returns the qualified name, equal to (Prefix:)LocalName.
 virtual CefXmlReader::NodeType GetType()= 0
          Returns the node type.
 virtual CefString GetValue()= 0
          Returns the text value.
 virtual CefString GetXmlLang()= 0
          Returns the xml:lang scope within which the node resides.
 virtual bool HasAttributes()= 0
          Returns true if the node has attributes.
 virtual bool HasError()= 0
          Returns true if an error has been reported by the XML parser.
 virtual bool HasValue()= 0
          Returns true if the node has a text value.
 virtual bool IsEmptyElement()= 0
          Returns true if the node represents an empty element.
 virtual bool MoveToAttribute( int index )= 0
          Moves the cursor to the attribute at the specified 0-based index.
 virtual bool MoveToAttribute( const CefString& qualifiedName )= 0
          Moves the cursor to the attribute with the specified qualified name.
 virtual bool MoveToAttribute( const CefString& localName, const CefString& namespaceURI )= 0
          Moves the cursor to the attribute with the specified local name and namespace URI.
 virtual bool MoveToCarryingElement()= 0
          Moves the cursor back to the carrying element.
 virtual bool MoveToFirstAttribute()= 0
          Moves the cursor to the first attribute in the current element.
 virtual bool MoveToNextAttribute()= 0
          Moves the cursor to the next attribute in the current element.
 virtual bool MoveToNextNode()= 0
          Moves the cursor to the next node in the document.
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef, HasAtLeastOneRef
 

Method Detail

Close

public virtual bool Close()= 0;
Close the document. This should be called directly to ensure that cleanup occurs on the correct thread.

Create

public static CefRefPtr< CefXmlReader > Create( CefRefPtr< CefStreamReader > stream, CefXmlReader::EncodingType encodingType, const CefString& URI );
Create a new CefXmlReader object. The returned object's methods can only be called from the thread that created the object.

GetAttribute

public virtual CefString GetAttribute( int index )= 0;
Returns the value of the attribute at the specified 0-based index.

GetAttribute

public virtual CefString GetAttribute( const CefString& localName, const CefString& namespaceURI )= 0;
Returns the value of the attribute with the specified local name and namespace URI.

GetAttribute

public virtual CefString GetAttribute( const CefString& qualifiedName )= 0;
Returns the value of the attribute with the specified qualified name.

GetAttributeCount

public virtual size_t GetAttributeCount()= 0;
Returns the number of attributes.

GetBaseURI

public virtual CefString GetBaseURI()= 0;
Returns the base URI of the node. See http://www.w3.org/TR/xmlbase/ for additional details.

GetDepth

public virtual int GetDepth()= 0;
Returns the node depth. Depth starts at 0 for the root node.

GetError

public virtual CefString GetError()= 0;
Returns the error string.

GetInnerXml

public virtual CefString GetInnerXml()= 0;
Returns an XML representation of the current node's children.

GetLineNumber

public virtual int GetLineNumber()= 0;
Returns the line number for the current node.

GetLocalName

public virtual CefString GetLocalName()= 0;
Returns the local name. See http://www.w3.org/TR/REC-xml-names/#NT-LocalPart for additional details.

GetNamespaceURI

public virtual CefString GetNamespaceURI()= 0;
Returns the URI defining the namespace associated with the node. See http://www.w3.org/TR/REC-xml-names/ for additional details.

GetOuterXml

public virtual CefString GetOuterXml()= 0;
Returns an XML representation of the current node including its children.

GetPrefix

public virtual CefString GetPrefix()= 0;
Returns the namespace prefix. See http://www.w3.org/TR/REC-xml-names/ for additional details.

GetQualifiedName

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

GetType

public virtual CefXmlReader::NodeType GetType()= 0;
Returns the node type.

GetValue

public virtual CefString GetValue()= 0;
Returns the text value.

GetXmlLang

public virtual CefString GetXmlLang()= 0;
Returns the xml:lang scope within which the node resides. See http://www.w3.org/TR/REC-xml/#sec-lang-tag for additional details.

HasAttributes

public virtual bool HasAttributes()= 0;
Returns true if the node has attributes.

HasError

public virtual bool HasError()= 0;
Returns true if an error has been reported by the XML parser.

HasValue

public virtual bool HasValue()= 0;
Returns true if the node has a text value.

IsEmptyElement

public virtual bool IsEmptyElement()= 0;
Returns true if the node represents an empty element. is considered empty but is not.

MoveToAttribute

public virtual bool MoveToAttribute( int index )= 0;
Moves the cursor to the attribute at the specified 0-based index. Returns true if the cursor position was set successfully.

MoveToAttribute

public virtual bool MoveToAttribute( const CefString& qualifiedName )= 0;
Moves the cursor to the attribute with the specified qualified name. Returns true if the cursor position was set successfully.

MoveToAttribute

public virtual bool MoveToAttribute( const CefString& localName, const CefString& namespaceURI )= 0;
Moves the cursor to the attribute with the specified local name and namespace URI. Returns true if the cursor position was set successfully.

MoveToCarryingElement

public virtual bool MoveToCarryingElement()= 0;
Moves the cursor back to the carrying element. Returns true if the cursor position was set successfully.

MoveToFirstAttribute

public virtual bool MoveToFirstAttribute()= 0;
Moves the cursor to the first attribute in the current element. Returns true if the cursor position was set successfully.

MoveToNextAttribute

public virtual bool MoveToNextAttribute()= 0;
Moves the cursor to the next attribute in the current element. Returns true if the cursor position was set successfully.

MoveToNextNode

public virtual bool MoveToNextNode()= 0;
Moves the cursor to the next node in the document. This method must be called at least once to set the current cursor position. Returns true if the cursor position was set successfully.

 Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

Chromium Embedded Framework (CEF) Copyright © 2016 Marshall A. Greenblatt