| LibreOffice
    LibreOffice 24.8 SDK API Reference | 
Interface of XML Document Wrapper. More...
import "XXMLDocumentWrapper.idl";
 
  
| Public Member Functions | |
| XXMLElementWrapper | getCurrentElement () | 
| Gets the current element. | |
| void | setCurrentElement ([in] XXMLElementWrapper element) | 
| Sets the current element. | |
| void | removeCurrentElement () | 
| Removes the current element. | |
| boolean | isCurrent ([in] XXMLElementWrapper node) | 
| Checks whether an element is the current element. | |
| boolean | isCurrentElementEmpty () | 
| Checks whether the current element is empty. | |
| string | getNodeName ([in] XXMLElementWrapper node) | 
| Gets the name of the element. | |
| void | clearUselessData ([in] XXMLElementWrapper node, [in] sequence< XXMLElementWrapper > reservedDescendants, [in] XXMLElementWrapper stopAtNode) | 
| Clears all useless element in a branch of the DOM tree along the tree order. | |
| void | collapse ([in] XXMLElementWrapper node) | 
| Collapses a tree path. | |
| void | generateSAXEvents ([in] com::sun::star::xml::sax::XDocumentHandler handler, [in] com::sun::star::xml::sax::XDocumentHandler saxEventKeeperHandler, [in] XXMLElementWrapper startNode, [in] XXMLElementWrapper endNode) raises ( com::sun::star::xml::sax::SAXException ) | 
| Converts a part of the DOM tree into SAX events. | |
| void | getTree ([in] com::sun::star::xml::sax::XDocumentHandler handler) raises ( com::sun::star::xml::sax::SAXException ) | 
| Converts the whole DOM tree into a SAX event stream. | |
| void | rebuildIDLink ([in] XXMLElementWrapper node) | 
| Rebuild the ID attribute in the branch starting from the particular element. | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) | 
| queries for a new interface to an existing UNO object. | |
| void | acquire () | 
| increases the reference counter by one. | |
| void | release () | 
| decreases the reference counter by one. | |
Interface of XML Document Wrapper.
When converting SAX events into a DOM tree, this interface is used to manipulate the DOM data in UNO perspective.
Every language has its own methods to manipulate its native DOM data structure, this interface provides a common method set which each language have to implement.
In another word, this interface wraps language dependent methods, then other component can manipulate DOM data through UNO methods.
| void clearUselessData | ( | [in] XXMLElementWrapper | node, | 
| [in] sequence< XXMLElementWrapper > | reservedDescendants, | ||
| [in] XXMLElementWrapper | stopAtNode ) | 
Clears all useless element in a branch of the DOM tree along the tree order.
| node | the start point of the branch to clear | 
| reservedDescendants | an array including all elements that need to be reserved (along their ancestor path) | 
| stopAtNode | the stop element. The operation have to interrupt when this element is met during clearing | 
| void collapse | ( | [in] XXMLElementWrapper | node | ) | 
Collapses a tree path.
Each element in the ancestor path of the node will be checked, if this element is empty, then deletes it.
| node | the start point of the path from where the tree path will be collapsed | 
| void generateSAXEvents | ( | [in] com::sun::star::xml::sax::XDocumentHandler | handler, | |||
| [in] com::sun::star::xml::sax::XDocumentHandler | saxEventKeeperHandler, | |||||
| [in] XXMLElementWrapper | startNode, | |||||
| [in] XXMLElementWrapper | endNode ) | |||||
| raises | ( | com::sun::star::xml::sax::SAXException ) | ||||
Converts a part of the DOM tree into SAX events.
| handler | the document handler which will receive generated SAX events | 
| saxEventKeeperHandler | the SAXEventKeeper connecting with this XMLDocumentHandler | 
| startNode | the start point to generate SAX events | 
| endNode | the end point where to stop generating | 
| XXMLElementWrapper getCurrentElement | ( | ) | 
Gets the current element.
| string getNodeName | ( | [in] XXMLElementWrapper | node | ) | 
Gets the name of the element.
| node | the element whose name will be gotten | 
| void getTree | ( | [in] com::sun::star::xml::sax::XDocumentHandler | handler | ) | ||
| raises | ( | com::sun::star::xml::sax::SAXException ) | ||||
Converts the whole DOM tree into a SAX event stream.
| handler | the document handler which will receive the SAX event stream | 
| boolean isCurrent | ( | [in] XXMLElementWrapper | node | ) | 
Checks whether an element is the current element.
| node | the element to be checked | 
true if the node is the current element, false otherwise | boolean isCurrentElementEmpty | ( | ) | 
Checks whether the current element is empty.
true if the current element is empty, false otherwise | void rebuildIDLink | ( | [in] XXMLElementWrapper | node | ) | 
Rebuild the ID attribute in the branch starting from the particular element.
| node | the root element of the branch whose ID link will be built | 
| void removeCurrentElement | ( | ) | 
Removes the current element.
When the current element is removed, then its parent element becomes the new current element.
| void setCurrentElement | ( | [in] XXMLElementWrapper | element | ) | 
Sets the current element.
When the current element is replaced outside of this interface, then uses this method can update the current element pointer.
| element | the new current element |