GXml-0.20 Reference Manual

# GXml-0.20

## Description:

## Content:

### Namespaces:

- GXml

### Interfaces:

- Collection - A DOM4 interface to keep references to DomElement children of a element.
- CollectionParent - Collection to manage child GXml.DomElement objects mapped to different classes, derived or child type of Collection.items_type
- DomAttr
- DomCharacterData - DOM4 character handling interface
- DomChildNode
- DomComment - DOM4 comment node
- DomCustomEvent
- DomDocument
- DomDocumentFragment - Not implemented yet. This can lead to API changes in future versions.
- DomDocumentType - Not implemented yet. This can lead to API changes in future versions.
- DomElement
- DomEvent
- DomEventListener
- DomEventTarget
- DomHTMLCollection
- DomHtmlDocument - Interface for HTML handling implementation
- DomImplementation - Not implemented yet. This can lead to API changes in future versions.
- DomMutationObserver - Implementers should use constructor with one argument GXml.DomMutationCallback to use internally.
- DomMutationRecord
- DomNamedNodeMap
- DomNode - Base interface for all DOM4 implementations
- DomNodeIterator - Document's node iterator.
- DomNodeList
- DomNonDocumentTypeChildNode
- DomNonElementParentNode
- DomParentNode
- DomProcessingInstruction - DOM4 Processing Instruction node
- DomRange
- DomSettableTokenList - No implemented jet. This can lead to API changes in future versions.
- DomText - DOM4 text node
- DomTokenList
- DomTreeWalker - Document tree walker.
- DomXMLDocument
- IXsdAnnotation
- IXsdAttribute
- IXsdAttributeGroup
- IXsdBaseAttribute
- IXsdBaseContent
- IXsdBaseType
- IXsdComplexContent
- IXsdComplexType
- IXsdElement
- IXsdExtension
- IXsdList
- IXsdListAttributes
- IXsdListAttributesGroup
- IXsdListComplexTypes
- IXsdListElements
- IXsdListSimpleTypes
- IXsdListTypeRestrictionEnumerations
- IXsdListTypeRestrictionWhiteSpaces
- IXsdOpenContent
- IXsdSchema - Reference interfaces for XSD support.
- IXsdSimpleContent
- IXsdSimpleType
- IXsdTypeDef
- IXsdTypeList
- IXsdTypeRestriction
- IXsdTypeRestrictionAssertion
- IXsdTypeRestrictionDef
- IXsdTypeRestrictionEnumeration
- IXsdTypeRestrictionExplicitTimezone
- IXsdTypeRestrictionFractionDigits
- IXsdTypeRestrictionLength
- IXsdTypeRestrictionMaxExclusive
- IXsdTypeRestrictionMaxInclusive
- IXsdTypeRestrictionMaxLength
- IXsdTypeRestrictionMinExclusive
- IXsdTypeRestrictionMinInclusive
- IXsdTypeRestrictionMinLength
- IXsdTypeRestrictionPattern
- IXsdTypeRestrictionTotalDigits
- IXsdTypeRestrictionWhiteSpace
- IXsdTypeUnion
- List - Gee.Iterable and Gee.Traversable implementation of GXml.Collection
- Map - Gee.Iterable and Gee.Traversable implementation of GXml.Collection
- MappeableElement - Interface to be implemented by GXml.Collection derived classes in order to provide a string to be used in GXml.HashMap as key.
- MappeableElementPairKey - Interface to be implemented by GXml.Collection derived classes in order to provide a strings to be used in GXml.HashPairedMap as keys.
- MappeableElementThreeKey - Interface to be implemented by GXml.Collection derived classes in order to provide a string to be used in GXml.HashThreeMap as key.
- Object - A GXml Object Model represents a DomElement. It has attributes and children. All object's properties are handled as attributes if they are basic types like integers, strings, enums and others; Property objects are handled as attributes too. If object's attribute is a GLib.Object it is handled as node's child, but only if it is a GXml.Element object, other wise it is ignored when this object is used as DomNode in XML documents.
- PairedMap - Gee.Iterable and Gee.Traversable implementation of GXml.Collection
- Parser - XML parser engine for DomDocument implementations.
- Property - An interface for GXml.Object's properties translated to DomElement attributes. If object is instantiated it is written, if not is just ignored.
- ThreeMap - Gee.Iterable and Gee.Traversable implementation of GXml.Collection
- XPathContext
- XPathObject

### Classes:

- ArrayList - A class implementing Collection to store references to child DomElement of Collection.element, using an index.
- ArrayString - Convenient class to handle a Element's attribute using a list of pre-defined and unmutable values.
- Attr - DOM4 implementation of DomAttr.
- BaseCollection - Base class for collections implementing Collection, providing basic infrastructure.
- BaseProperty - Base class for properties implementing Property interface.
- Boolean - Convenient class to handle Element's attributes using a boolean ('true' and 'false') as sources of values.
- CharacterData - A DOM4 implementation of DomCharacterData, for one step parsing.
- Comment - A DOM4 implementation of DomComment, for one step parsing.
- CssAttributeSelector - CssSelector for attributes
- CssElementSelector - CssSelector for elements
- CssNotSelector - CssSelector for 'not' pseudo class
- CssSelector - generic CSS selector, used by GXml.CssSelectorParser
- CssSelectorParser - CSS Selectors Level 3 parser.
- CustomEvent - Custom event handler, powered by libxml2 library.
- Date - Convenient class to handle Element's attributes using a GLib.Date as sources of values.
- DateTime - Convenient class to handle Element's attributes using a GLib.DateTime as sources of values.
- Document - A DOM4 implementation of DomDocument, for one step parsing.
- DocumentFragment
- DocumentType
- DomCustomEventInit
- DomElementList
- DomErrorName
- DomEventInit
- DomMutationObserverInit
- DomNodeFilter - No implemented jet. This can lead to API changes in future versions.
- DomTimeStamp
- Double - Convenient class to handle Element's attributes using double precision floats as sources of values.
- Element - A DOM4 implementation of DomElement, for one-step-parsing.
- Enum - Convenient class to handle Element's attributes using a GLib.Type.ENUM as a source of values.
- Enumeration - Convenient static methods for enumeration serialization to string.
- Event - DOM4 An event handler, powered by libxml2 library.
- Float - Convenient class to handle Element's attributes using floats as sources of values.
- HTMLCollection - DOM4 HTML Collection
- HashMap - A class implementing Collection to store references to child DomElement of Collection.element, using an attribute in items as key or MappeableElement.get_map_key method if implemented by items to be added. If key is not defined in node, it is not added; but keeps it as a child node of actual Collection.element.
- HashPairedMap - A class implementing Collection to store references to child DomElement of Collection.element, using two attributes in items as primary and secondary keys or MappeableElementPairKey.get_map_primary_key and MappeableElementPairKey.get_map_secondary_key methods if MappeableElementPairKey are implemented by items to be added. If one or both keys are not defined in node, it is not added; but keeps it as a child node of actual Collection.element.
- HashThreeMap - A class implementing Collection to store references to child DomElement of Collection.element, using three attributes in items as primary, secondary tertiary keys or MappeableElementThreeKey.get_map_pkey, MappeableElementThreeKey.get_map_skey and MappeableElementThreeKey.get_map_tkey methods if MappeableElementThreeKey are implemented by items to be added. All keys should be defined in node, otherwise it is not added; but keeps it as a child node of actual Collection.element.
- HtmlDocument - DOM4 HTML Document
- HtmlElement
- Implementation
- Int - Convenient class to handle Element's attributes using a integers as sources of values.
- LXPathObject - An GXml.XPathObject implementation using libxml2 engine.
- Node - A DOM4 implementation of DomNode, for one step parsing.
- NodeIterator - Implementation of DomNodeIterator
- NodeList - List of DomNode implementing DomNodeList
- ProcessingInstruction - A DOM4 implementation of DomProcessingInstruction, for one step parsing.
- Range - DOM4 Range implementation, powered by libxml2 library.
- SettableTokenList - DOM4 Setteable token list, powered by libxml2 library.
- String - Convenient class to handle Element's attributes using validated string using Regular Expressions.
- StringRef
- Text - A DOM4 implementation of DomText, for one step parsing.
- TokenList - DOM4 List of string tokens, powered by libxml2 library.
- TreeWalker - Implementation of DomTreeWalker
- XAttribute - Class implementing GXml.DomAttr interface, not tied to libxml-2.0 library.
- XCharacterData - DOM4 Base class for character data, powered by libxml2 library.
- XChildNode - DOM4 class for child nodes, powered by libxml2 library.
- XComment - DOM4 Class implementing GXml.Comment and GXml.DomComment interface, powered by libxml2 library.
- XDocument - DOM4 class implementing GXml.DomDocument and {GXml.DomDocument} interface, powered by libxml-2.0 library.
- XElement - DOM4 Class implementing GXml.DomElement interface, powered by libxml-2.0 library.
- XHashMapAttr - Implementation of Gee.AbstractMap to handle Xml.Node attributes, powered by libxml2 library.
- XHtmlDocument - HML parsing support. Document handling
- XListChildren - A Gee.AbstractBidirList implementation to access Xml.Node collection
- XNode - DOM4 Base interface providing basic functionalities to all libxml2 DOM4 implementations.
- XNonDocumentChildNode
- XParser - Parser implementation using libxml2 engine
- XProcessingInstruction - DOM4 Class implementing GXml.ProcessingInstruction and DomProcessingInstruction interface, powered by libxml2 library.
- XText - DOM4 Class implementing GXml.Text and DomText interface, powered by libxml2 library.
- XsdAnnotation
- XsdArrayString - Convenient class to handle a Element's attribute using a list of pre-defined and unmutable values, taken from an IXsdSimpleType definition
- XsdAttribute
- XsdAttributeGroup
- XsdBaseAttribute
- XsdBaseContent
- XsdBaseType
- XsdComplexContent
- XsdComplexType
- XsdElement
- XsdExtension
- XsdList
- XsdListComplexTypes
- XsdListElements
- XsdListSimpleTypes
- XsdListTypeRestrictionEnumerations
- XsdListTypeRestrictionWhiteSpaces
- XsdOpenContent
- XsdSchema - Reference interfaces for XSD support.
- XsdSimpleContent
- XsdSimpleType
- XsdTypeDefinition
- XsdTypeList
- XsdTypeRestriction
- XsdTypeRestrictionAssertion
- XsdTypeRestrictionDef
- XsdTypeRestrictionEnumeration
- XsdTypeRestrictionExplicitTimezone
- XsdTypeRestrictionFractionDigits
- XsdTypeRestrictionLength
- XsdTypeRestrictionMaxExclusive
- XsdTypeRestrictionMaxInclusive
- XsdTypeRestrictionMaxLength
- XsdTypeRestrictionMinExclusive
- XsdTypeRestrictionMinInclusive
- XsdTypeRestrictionMinLength
- XsdTypeRestrictionPattern
- XsdTypeRestrictionTotalDigits
- XsdTypeRestrictionWhiteSpace
- XsdTypeUnion

### Enums:

- CssCombiner - Enumeration of identifiers, to combine selectors
- CssSelectorType - Enumeration of types for GXml.CssSelector
- NodeType - DOM1 Enumerates possible NodeTypes.
- XPathObjectType - Object type codes for XPathObject objects

### Error domains:

- CssSelectorError - Error throwed during parsing
- DomDocumentError
- DomError - DOM4 error codes.
- EnumerationError - Errors when de/serializing enumerations.
- Error - Auxiliary error codes for parsing/writing libxml2 powered classes
- IXsdSchemaError - XSD schema Error codes for IXsdSchema objects
- ParserError - Parser Error codes for DomNode parsing objects
- XPathError - Parser Error codes for XPathObject objects
- XPathObjectError

### Delegates:

- public delegate void DomMutationCallback (List<DomMutationRecord> mutations, DomMutationObserver observer)