Isis 3 Programmer Reference
Isis::GuiCameraDisplayProperties::XmlHandler Class Reference

Process a GuiCameraDisplayProperties in a stack-oriented way. More...

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

Public Member Functions

 XmlHandler (GuiCameraDisplayProperties *displayProperties)
 Sets the GuiCameraDisplayProperties variable pointer. More...
 
virtual bool startElement (const QString &namespaceURI, const QString &localName, const QString &qName, const QXmlAttributes &atts)
 The XML reader invokes this method at the start of every element in the XML document. More...
 
virtual bool characters (const QString &ch)
 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. More...
 
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. More...
 
virtual void setReader (XmlStackedHandlerReader *)
 
void switchToNewHandler (XmlStackedHandler *nextHandler)
 Switch to a new content handler and continue processing using the new handler. More...
 

Protected Member Functions

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

Private Member Functions

 Q_DISABLE_COPY (XmlHandler)
 

Private Attributes

GuiCameraDisplayPropertiesm_displayProperties
 An internal pointer to GuiCameraDisplayProperties object. More...
 
QString m_hexData
 An internal QString variable used to store character data found in the content of XML elements. More...
 

Detailed Description

Process a GuiCameraDisplayProperties in a stack-oriented way.

Child class for XmlStackedHandler which is used to process XML in a stack-oriented way. It's been modified to process a GuiCameraDisplayProperties object.

Author
2015-09-08 Ken Edmundson
History:

2015-09-08 Ken Edmundson - Creation.

2016-06-08 Tyler Wilson - Added documentation to many of the member functions, and cleaned up the formatting. Fixes #3997.

Definition at line 140 of file GuiCameraDisplayProperties.h.

Constructor & Destructor Documentation

◆ XmlHandler()

Isis::GuiCameraDisplayProperties::XmlHandler::XmlHandler ( GuiCameraDisplayProperties displayProperties)

Sets the GuiCameraDisplayProperties variable pointer.

Parameters
displayPropertiesThe new pointer.

Definition at line 224 of file GuiCameraDisplayProperties.cpp.

References m_displayProperties.

Member Function Documentation

◆ characters()

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

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 269 of file GuiCameraDisplayProperties.cpp.

◆ endElement()

bool Isis::GuiCameraDisplayProperties::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 287 of file GuiCameraDisplayProperties.cpp.

◆ startElement()

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

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

A quick example using this function: startElement("xsl","stylesheet","xsl:stylesheet",attributes)

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 243 of file GuiCameraDisplayProperties.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 32 of file XmlStackedHandler.cpp.

Referenced by Isis::XmlStackedHandlerReader::pushContentHandler().

Member Data Documentation

◆ m_displayProperties

GuiCameraDisplayProperties* Isis::GuiCameraDisplayProperties::XmlHandler::m_displayProperties
private

An internal pointer to GuiCameraDisplayProperties object.

Definition at line 158 of file GuiCameraDisplayProperties.h.

Referenced by XmlHandler().

◆ m_hexData

QString Isis::GuiCameraDisplayProperties::XmlHandler::m_hexData
private

An internal QString variable used to store character data found in the content of XML elements.

Definition at line 164 of file GuiCameraDisplayProperties.h.


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