LibreOffice LibreOffice 25.2 SDK API Reference

XXMLDocumentWrapper.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20module com { module sun { module star { module xml { module wrapper {
21
22 interface XXMLElementWrapper;
23
37 interface XXMLDocumentWrapper : com::sun::star::uno::XInterface
38{
44 XXMLElementWrapper getCurrentElement();
45
54 void setCurrentElement([in] XXMLElementWrapper element);
55
62 void removeCurrentElement();
63
71 boolean isCurrent([in] XXMLElementWrapper node);
72
79 boolean isCurrentElementEmpty();
80
87 string getNodeName([in] XXMLElementWrapper node);
88
101 void clearUselessData(
102 [in] XXMLElementWrapper node,
103 [in] sequence< XXMLElementWrapper > reservedDescendants,
104 [in] XXMLElementWrapper stopAtNode);
105
115 void collapse([in] XXMLElementWrapper node);
116
127 void generateSAXEvents(
128 [in] com::sun::star::xml::sax::XDocumentHandler handler,
129 [in] com::sun::star::xml::sax::XDocumentHandler saxEventKeeperHandler,
130 [in] XXMLElementWrapper startNode,
131 [in] XXMLElementWrapper endNode)
132 raises( com::sun::star::xml::sax::SAXException );
133
140 void getTree([in] com::sun::star::xml::sax::XDocumentHandler handler)
141 raises( com::sun::star::xml::sax::SAXException );
142
150 void rebuildIDLink([in] XXMLElementWrapper node);
151};
152
153} ; } ; } ; } ; } ;
154
155/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::xml::sax::SAXException
encapsulates the details of an XML parse error or warning.
Definition: SAXException.idl:38
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com::sun::star::xml::sax::XDocumentHandler
receives notification of general document events.
Definition: XDocumentHandler.idl:32
com::sun::star::xml::wrapper::XXMLDocumentWrapper
Interface of XML Document Wrapper.
Definition: XXMLDocumentWrapper.idl:38
com::sun::star::xml::wrapper::XXMLDocumentWrapper::setCurrentElement
void setCurrentElement([in] XXMLElementWrapper element)
Sets the current element.
com::sun::star::xml::wrapper::XXMLDocumentWrapper::isCurrent
boolean isCurrent([in] XXMLElementWrapper node)
Checks whether an element is the current element.
com::sun::star::xml::wrapper::XXMLDocumentWrapper::removeCurrentElement
void removeCurrentElement()
Removes the current element.
com::sun::star::xml::wrapper::XXMLDocumentWrapper::getTree
void getTree([in] com::sun::star::xml::sax::XDocumentHandler handler)
Converts the whole DOM tree into a SAX event stream.
com::sun::star::xml::wrapper::XXMLDocumentWrapper::clearUselessData
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.
com::sun::star::xml::wrapper::XXMLDocumentWrapper::getCurrentElement
XXMLElementWrapper getCurrentElement()
Gets the current element.
com::sun::star::xml::wrapper::XXMLDocumentWrapper::getNodeName
string getNodeName([in] XXMLElementWrapper node)
Gets the name of the element.
com::sun::star::xml::wrapper::XXMLDocumentWrapper::generateSAXEvents
void generateSAXEvents([in] com::sun::star::xml::sax::XDocumentHandler handler, [in] com::sun::star::xml::sax::XDocumentHandler saxEventKeeperHandler, [in] XXMLElementWrapper startNode, [in] XXMLElementWrapper endNode)
Converts a part of the DOM tree into SAX events.
com::sun::star::xml::wrapper::XXMLDocumentWrapper::isCurrentElementEmpty
boolean isCurrentElementEmpty()
Checks whether the current element is empty.
com::sun::star::xml::wrapper::XXMLDocumentWrapper::collapse
void collapse([in] XXMLElementWrapper node)
Collapses a tree path.
com::sun::star::xml::wrapper::XXMLDocumentWrapper::rebuildIDLink
void rebuildIDLink([in] XXMLElementWrapper node)
Rebuild the ID attribute in the branch starting from the particular element.
com::sun::star::xml::wrapper::XXMLElementWrapper
Interface of XML Element Wrapper.
Definition: XXMLElementWrapper.idl:30
com
Definition: Ambiguous.idl:20