DOMLocator.hpp
Go to the documentation of this file.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* $Id$
*/
#if !defined(XERCESC_INCLUDE_GUARD_DOMLOCATOR_HPP)
#define XERCESC_INCLUDE_GUARD_DOMLOCATOR_HPP
#include <xercesc/util/XercesDefs.hpp>
XERCES_CPP_NAMESPACE_BEGIN
class DOMNode;
class CDOM_EXPORT DOMLocator
{
protected:
// -----------------------------------------------------------------------
// Hidden constructors
// -----------------------------------------------------------------------
DOMLocator() {};
private:
// -----------------------------------------------------------------------
// Unimplemented constructors and operators
// -----------------------------------------------------------------------
DOMLocator(const DOMLocator &);
DOMLocator & operator = (const DOMLocator &);
public:
// -----------------------------------------------------------------------
// All constructors are hidden, just the destructor is available
// -----------------------------------------------------------------------
virtual ~DOMLocator() {};
// -----------------------------------------------------------------------
// Virtual DOMLocator interface
// -----------------------------------------------------------------------
// -----------------------------------------------------------------------
// Getter methods
// -----------------------------------------------------------------------
virtual XMLFileLoc getLineNumber() const = 0;
virtual XMLFileLoc getColumnNumber() const = 0;
virtual XMLFilePos getByteOffset() const = 0;
virtual XMLFilePos getUtf16Offset() const = 0;
virtual DOMNode* getRelatedNode() const = 0;
virtual const XMLCh* getURI() const = 0;
};
XERCES_CPP_NAMESPACE_END
#endif
XercesDefs.hpp
CDOM_EXPORT
#define CDOM_EXPORT
Definition XercesDefs.hpp:166
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition XercesDefs.hpp:112
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition XercesDefs.hpp:113
XMLCh
char16_t XMLCh
Definition Xerces_autoconf_config.hpp:120
XMLFilePos
XMLUInt64 XMLFilePos
Definition Xerces_autoconf_config.hpp:139
XMLFileLoc
XMLUInt64 XMLFileLoc
Definition Xerces_autoconf_config.hpp:144
DOMLocator
DOMLocator is an interface that describes a location.
Definition DOMLocator.hpp:42
DOMLocator::~DOMLocator
virtual ~DOMLocator()
Destructor.
Definition DOMLocator.hpp:72
DOMLocator::DOMLocator
DOMLocator()
Definition DOMLocator.hpp:49
DOMLocator::getUtf16Offset
virtual XMLFilePos getUtf16Offset() const =0
Get the UTF-16 offset into the input source, or ~(XMLFilePos(0)) if there is no UTF-16 offset availab...
DOMLocator::getLineNumber
virtual XMLFileLoc getLineNumber() const =0
Get the line number where the error occured, or 0 if there is no line number available.
DOMLocator::getURI
virtual const XMLCh * getURI() const =0
Get the URI where the error occured, or null if there is no URI available.
DOMLocator::getRelatedNode
virtual DOMNode * getRelatedNode() const =0
Get the DOMNode where the error occured, or null if there is no node available.
DOMLocator::getByteOffset
virtual XMLFilePos getByteOffset() const =0
Get the byte offset into the input source, or ~(XMLFilePos(0)) if there is no byte offset available.
DOMLocator::getColumnNumber
virtual XMLFileLoc getColumnNumber() const =0
Get the column number where the error occured, or 0 if there is no column number available.
DOMNode
The DOMNode interface is the primary datatype for the entire Document Object Model.
Definition DOMNode.hpp:139