Isis 3 Programmer Reference
Isis::Control::XmlHandler Class Reference

Nested class used to write the Control object information to an XML file for the purpose of saving and restoring the state of the project. More...

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

Public Member Functions

 XmlHandler (Control *control, FileName cnetFolder)
 Constructor for the Control object's XmlHandler.
 
virtual bool startElement (const QString &namespaceURI, const QString &localName, const QString &qName, const QXmlAttributes &atts)
 Method to read the given XML formatted attribute for a Control object into the XmlHandler.
 
virtual void setReader (XmlStackedHandlerReader *)
 
void switchToNewHandler (XmlStackedHandler *nextHandler)
 Switch to a new content handler and continue processing using the new handler.
 
virtual bool endElement (const QString &namespaceURI, const QString &localName, const QString &qName)
 

Protected Member Functions

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

Private Member Functions

 Q_DISABLE_COPY (XmlHandler)
 

Private Attributes

Controlm_xmlHandlerControl
 A pointer to the Control object to be read or written.
 
FileName m_xmlHandlerCnetFolderName
 The name of the folder for the control xml.
 
XmlStackedHandlerReaderm_reader
 
int m_depth
 
QString m_lastStartNamespaceURI
 
QString m_lastStartLocalName
 
QString m_lastStartQName
 
QXmlAttributes m_lastStartAtts
 

Detailed Description

Nested class used to write the Control object information to an XML file for the purpose of saving and restoring the state of the project.

Author
2012-??-?? Steven Lambright

Definition at line 106 of file Control.h.

Constructor & Destructor Documentation

◆ XmlHandler()

Isis::Control::XmlHandler::XmlHandler ( Control * control,
FileName cnetFolder )

Constructor for the Control object's XmlHandler.

Parameters
controlA pointer to the Control object.
cnetFolderThe name of the folder for the Control xml

Definition at line 393 of file Control.cpp.

References m_xmlHandlerCnetFolderName, and m_xmlHandlerControl.

Member Function Documentation

◆ endElement()

◆ 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::Control::XmlHandler::startElement ( const QString & namespaceURI,
const QString & localName,
const QString & qName,
const QXmlAttributes & atts )
virtual

Method to read the given XML formatted attribute for a Control object into the XmlHandler.

Parameters
namespaceURI???
localNameThe keyword name given to the member variable in the XML.
qName???
attsThe attribute containing the keyword value for the given localName.
Returns
bool Indicates whether the localName is recognized.

Reimplemented from Isis::XmlStackedHandler.

Definition at line 411 of file Control.cpp.

References Isis::Control::fileName().

◆ 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_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.

◆ m_xmlHandlerCnetFolderName

FileName Isis::Control::XmlHandler::m_xmlHandlerCnetFolderName
private

The name of the folder for the control xml.

Definition at line 118 of file Control.h.

Referenced by XmlHandler().

◆ m_xmlHandlerControl

Control* Isis::Control::XmlHandler::m_xmlHandlerControl
private

A pointer to the Control object to be read or written.

Definition at line 116 of file Control.h.

Referenced by XmlHandler().


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