Isis 3 Programmer Reference
Isis::ShapeDisplayProperties::XmlHandler Class Reference

This class is used for processing an XML file containing information about a WorkOrder. More...

Inheritance diagram for Isis::ShapeDisplayProperties::XmlHandler:
Inheritance graph
Collaboration diagram for Isis::ShapeDisplayProperties::XmlHandler:
Collaboration graph

Public Member Functions

 XmlHandler (ShapeDisplayProperties *displayProperties)
 Constructor for the XmlHandler class.
 
virtual bool startElement (const QString &namespaceURI, const QString &localName, const QString &qName, const QXmlAttributes &atts)
 This overrides the parent startElement function in XmlStackedHandler so the parser can handle an XML file containing ShapeDisplayProperties information.
 
virtual bool characters (const QString &ch)
 This is called when the XML processor has parsed a chunk of character data.
 
virtual bool endElement (const QString &namespaceURI, const QString &localName, const QString &qName)
 The XML reader invokes this method at the end of every element in the XML document.
 
virtual void setReader (XmlStackedHandlerReader *)
 
void switchToNewHandler (XmlStackedHandler *nextHandler)
 Switch to a new content handler and continue processing using the new handler.
 

Protected Member Functions

XmlStackedHandlerReaderreader ()
 
const XmlStackedHandlerReaderreader () const
 
bool fatalError (const QXmlParseException &exception)
 

Private Member Functions

 Q_DISABLE_COPY (XmlHandler)
 

Private Attributes

ShapeDisplayPropertiesm_displayProperties
 
QString m_hexData
 
XmlStackedHandlerReaderm_reader
 
int m_depth
 
QString m_lastStartNamespaceURI
 
QString m_lastStartLocalName
 
QString m_lastStartQName
 
QXmlAttributes m_lastStartAtts
 

Detailed Description

This class is used for processing an XML file containing information about a WorkOrder.

Author
2012-??-?? Steven Lambright

Definition at line 115 of file ShapeDisplayProperties.h.

Constructor & Destructor Documentation

◆ XmlHandler()

Isis::ShapeDisplayProperties::XmlHandler::XmlHandler ( ShapeDisplayProperties * displayProperties)

Constructor for the XmlHandler class.


This is a child class of XmlStackedHandler, which is used by XmlStackedHandlerReader to parse an XML file.

Parameters
displayPropertiesPointer to a ShapeDisplayProperties object.

Definition at line 197 of file ShapeDisplayProperties.cpp.

Member Function Documentation

◆ characters()

bool Isis::ShapeDisplayProperties::XmlHandler::characters ( const QString & ch)
virtual

This is called when the XML processor has parsed a chunk of character data.

This implementation of a virtual function calls QXmlDefaultHandler::characters(QString &ch) which in turn calls QXmlContentHandler::characters(QString &ch) which is called when the XML processor has parsed a chunk of character data.

See also
XmlStackedHandler, QXmlDefaultHandler,QXmlContentHandler
Parameters
chThe character data.
Returns
bool Returns True if there were no problems with the character processing. It returns False if there was a problem, and the XML reader stops.

Definition at line 240 of file ShapeDisplayProperties.cpp.

◆ endElement()

bool Isis::ShapeDisplayProperties::XmlHandler::endElement ( const QString & namespaceURI,
const QString & localName,
const QString & qName )
virtual

The XML reader invokes this method at the end of every element in the XML document.

Parameters
namespaceURIThe Uniform Resource Identifier of the namespace (eg. "xmlns")
localNameThe local name string (eg. "xhtml")
qNameThe XML qualified string (eg. "xmlns:xhtml"). This can be empty if QNames are not available.
Returns
bool If this function returns True, then a signal is sent to the reader indicating the end of the element. If this function returns False, something bad happened and processing stops.

Reimplemented from Isis::XmlStackedHandler.

Definition at line 259 of file ShapeDisplayProperties.cpp.

◆ fatalError()

bool Isis::XmlStackedHandler::fatalError ( const QXmlParseException & exception)
protectedinherited

Definition at line 78 of file XmlStackedHandler.cpp.

◆ reader() [1/2]

XmlStackedHandlerReader * Isis::XmlStackedHandler::reader ( )
protectedinherited

Definition at line 68 of file XmlStackedHandler.cpp.

◆ reader() [2/2]

const XmlStackedHandlerReader * Isis::XmlStackedHandler::reader ( ) const
protectedinherited

Definition at line 73 of file XmlStackedHandler.cpp.

◆ setReader()

void Isis::XmlStackedHandler::setReader ( XmlStackedHandlerReader * reader)
virtualinherited

Definition at line 28 of file XmlStackedHandler.cpp.

◆ startElement()

bool Isis::ShapeDisplayProperties::XmlHandler::startElement ( const QString & namespaceURI,
const QString & localName,
const QString & qName,
const QXmlAttributes & atts )
virtual

This overrides the parent startElement function in XmlStackedHandler so the parser can handle an XML file containing ShapeDisplayProperties information.

Parameters
namespaceURIThe Uniform Resource Identifier of the element's namespace
localNameThe local name string
qNameThe XML qualified string (or empty, if QNames are not available).
attsThe XML attributes attached to each element
Returns
bool Returns True signalling to the reader the start of a valid XML element. If False is returned, something bad happened.

Reimplemented from Isis::XmlStackedHandler.

Definition at line 212 of file ShapeDisplayProperties.cpp.

References Isis::DisplayProperties::displayName().

◆ switchToNewHandler()

void Isis::XmlStackedHandler::switchToNewHandler ( XmlStackedHandler * nextHandler)
inherited

Switch to a new content handler and continue processing using the new handler.

Definition at line 37 of file XmlStackedHandler.cpp.

Member Data Documentation

◆ m_depth

int Isis::XmlStackedHandler::m_depth
privateinherited

Definition at line 141 of file XmlStackedHandler.h.

◆ m_displayProperties

ShapeDisplayProperties* Isis::ShapeDisplayProperties::XmlHandler::m_displayProperties
private

Definition at line 130 of file ShapeDisplayProperties.h.

◆ m_hexData

QString Isis::ShapeDisplayProperties::XmlHandler::m_hexData
private

Definition at line 131 of file ShapeDisplayProperties.h.

◆ m_lastStartAtts

QXmlAttributes Isis::XmlStackedHandler::m_lastStartAtts
privateinherited

Definition at line 146 of file XmlStackedHandler.h.

◆ m_lastStartLocalName

QString Isis::XmlStackedHandler::m_lastStartLocalName
privateinherited

Definition at line 144 of file XmlStackedHandler.h.

◆ m_lastStartNamespaceURI

QString Isis::XmlStackedHandler::m_lastStartNamespaceURI
privateinherited

Definition at line 143 of file XmlStackedHandler.h.

◆ m_lastStartQName

QString Isis::XmlStackedHandler::m_lastStartQName
privateinherited

Definition at line 145 of file XmlStackedHandler.h.

◆ m_reader

XmlStackedHandlerReader* Isis::XmlStackedHandler::m_reader
privateinherited

Definition at line 140 of file XmlStackedHandler.h.


The documentation for this class was generated from the following files: