DocHandler Class Reference

Node representing a documentation block. More...

#include <dochandler.h>

Inheritance diagram for DocHandler:

Public Member Functions
virtual void	startDoc (const QXmlAttributes &attrib)
virtual void	endDoc ()
virtual void	startParagraph (const QXmlAttributes &attrib)
virtual void	startSect1 (const QXmlAttributes &attrib)
virtual void	startTitle (const QXmlAttributes &attrib)
virtual void	startInternal (const QXmlAttributes &attrib)
	DocHandler (IBaseHandler *parent)
virtual	~DocHandler ()
virtual Kind	kind () const
virtual IDocIterator *	contents () const
virtual IDocInternal *	internal () const
Public Member Functions inherited from BaseHandler< DocHandler >
	BaseHandler ()
virtual	~BaseHandler ()
virtual bool	startDocument ()
virtual bool	startElement (const QString &namespaceURI, const QString &localName, const QString &name, const QXmlAttributes &attrib)
virtual bool	endElement (const QString &namespaceURI, const QString &localName, const QString &name)
bool	skippedEntity (const QString &s)
virtual bool	characters (const QString &ch)
void	setDelegate (QXmlDefaultHandler *delegate)
QXmlDefaultHandler *	delegate () const
void	setFallBackHandler (IFallBackHandler *h)
IFallBackHandler *	fallBackHandler () const
void	setDocumentLocator (QXmlLocator *locator)
Public Member Functions inherited from QXmlDefaultHandler
	QXmlDefaultHandler ()
virtual	~QXmlDefaultHandler ()
bool	endDocument ()
bool	startPrefixMapping (const QString &prefix, const QString &uri)
bool	endPrefixMapping (const QString &prefix)
bool	ignorableWhitespace (const QString &ch)
bool	processingInstruction (const QString &target, const QString &data)
bool	warning (const QXmlParseException &exception)
bool	error (const QXmlParseException &exception)
bool	fatalError (const QXmlParseException &exception)
bool	notationDecl (const QString &name, const QString &publicId, const QString &systemId)
bool	unparsedEntityDecl (const QString &name, const QString &publicId, const QString &systemId, const QString &notationName)
bool	resolveEntity (const QString &publicId, const QString &systemId, QXmlInputSource *&ret)
bool	startDTD (const QString &name, const QString &publicId, const QString &systemId)
bool	endDTD ()
bool	startCDATA ()
bool	endCDATA ()
bool	comment (const QString &ch)
bool	attributeDecl (const QString &eName, const QString &aName, const QString &type, const QString &valueDefault, const QString &value)
bool	internalEntityDecl (const QString &name, const QString &value)
bool	externalEntityDecl (const QString &name, const QString &publicId, const QString &systemId)
QString	errorString ()
Public Member Functions inherited from QXmlContentHandler
virtual	~QXmlContentHandler ()
Public Member Functions inherited from QXmlErrorHandler
virtual	~QXmlErrorHandler ()
Public Member Functions inherited from QXmlDTDHandler
virtual	~QXmlDTDHandler ()
Public Member Functions inherited from QXmlEntityResolver
virtual	~QXmlEntityResolver ()
Public Member Functions inherited from QXmlLexicalHandler
virtual	~QXmlLexicalHandler ()
Public Member Functions inherited from QXmlDeclHandler
virtual	~QXmlDeclHandler ()
Public Member Functions inherited from ElementMapper< DocHandler >
	ElementMapper ()
virtual	~ElementMapper ()
void	addStartHandler (const char *key)
void	addStartHandler (const char *key, DocHandler *obj, void(DocHandler::*handler)(const QXmlAttributes &))
void	addEndHandler (const char *key)
void	addEndHandler (const char *key, DocHandler *obj, void(DocHandler::*handler)())
Public Member Functions inherited from IBaseHandler
virtual	~IBaseHandler ()

Private Attributes
IBaseHandler *	m_parent
QList< DocImpl >	m_children
DocInternalHandler *	m_internal

Friends
class	DocIterator

Additional Inherited Members
Public Types inherited from BaseHandler< DocHandler >
typedef ElementMapper< DocHandler >::StartElementHandlerT	StartElementHandlerT
typedef ElementMapper< DocHandler >::EndElementHandlerT	EndElementHandlerT
Public Types inherited from ElementMapper< DocHandler >
typedef StartElementHandler	StartElementHandlerT
typedef EndElementHandler	EndElementHandlerT
Static Public Attributes inherited from LocatorContainer
static QXmlLocator *	s_theLocator =0
Protected Attributes inherited from BaseHandler< DocHandler >
QString	m_curString
QString	m_skipUntil
int	m_skipCount
QXmlDefaultHandler *	m_delegateHandler
IFallBackHandler *	m_fallBackHandler
Protected Attributes inherited from ElementMapper< DocHandler >
QDict< StartElementHandlerT >	m_startHandlers
QDict< EndElementHandlerT >	m_endHandlers

Detailed Description

Node representing a documentation block.

Definition at line 1315 of file dochandler.h.

Constructor & Destructor Documentation

DocHandler::DocHandler

(

IBaseHandler *

parent

)

Definition at line 2172 of file dochandler.cpp.

                                           : m_parent(parent)
{
  m_children.setAutoDelete(TRUE);

  addEndHandler("briefdescription",this,&DocHandler::endDoc);
  addEndHandler("detaileddescription",this,&DocHandler::endDoc);
  addEndHandler("inbodydescription",this,&DocHandler::endDoc);
  //addEndHandler("internal"); // TODO: implement this as a section
  addStartHandler("internal",this,&DocHandler::startInternal);

  addStartHandler("para",this,&DocHandler::startParagraph);
  addStartHandler("sect1",this,&DocHandler::startSect1);
  addStartHandler("title",this,&DocHandler::startTitle);
  //addStartHandler("internal");
}

DocHandler::~DocHandler ( )

virtual

Definition at line 2188 of file dochandler.cpp.

{
}

Member Function Documentation

IDocIterator * DocHandler::contents ( ) const

virtual

Definition at line 2231 of file dochandler.cpp.

{
  return new DocIterator(*this);
}

void DocHandler::endDoc ( )

virtual

Definition at line 2198 of file dochandler.cpp.

{
  debug(2,"end dochandler\n");
  m_parent->setDelegate(0);
}

IDocInternal * DocHandler::internal ( ) const

virtual

Definition at line 2236 of file dochandler.cpp.

{ 
  return m_internal; 
}

virtual Kind DocHandler::kind ( ) const

inlinevirtual

Definition at line 1330 of file dochandler.h.

{ return DocImpl::Root; }

void DocHandler::startDoc ( const QXmlAttributes &  attrib )

virtual

Definition at line 2192 of file dochandler.cpp.

{
  m_parent->setDelegate(this);
  debug(2,"start dochandler\n");
}

void DocHandler::startInternal ( const QXmlAttributes &  attrib )

virtual

Definition at line 2225 of file dochandler.cpp.

{
  m_internal = new DocInternalHandler(this,1);
  m_internal->startInternal(attrib);
}

void DocHandler::startParagraph ( const QXmlAttributes &  attrib )

virtual

Definition at line 2204 of file dochandler.cpp.

{
  ParagraphHandler *parHandler = new ParagraphHandler(this);
  parHandler->startParagraph(attrib);
  m_children.append(parHandler);
}

void DocHandler::startSect1 ( const QXmlAttributes &  attrib )

virtual

Definition at line 2211 of file dochandler.cpp.

{
  DocSectionHandler *secHandler = new DocSectionHandler(this,1);
  secHandler->startDocSection(attrib);
  m_children.append(secHandler);
}

void DocHandler::startTitle ( const QXmlAttributes &  attrib )

virtual

Definition at line 2218 of file dochandler.cpp.

{
  TitleHandler *titleHandler = new TitleHandler(this);
  titleHandler->startTitle(attrib);
  m_children.append(titleHandler);
}

Friends And Related Function Documentation

friend class DocIterator

friend

Definition at line 1317 of file dochandler.h.

Member Data Documentation

QList<DocImpl> DocHandler::m_children

private

Definition at line 1336 of file dochandler.h.

DocInternalHandler* DocHandler::m_internal

private

Definition at line 1337 of file dochandler.h.

IBaseHandler* DocHandler::m_parent

private

Definition at line 1335 of file dochandler.h.

---

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

• doxygen-1.8.11/addon/doxmlparser/src/dochandler.h
• doxygen-1.8.11/addon/doxmlparser/src/dochandler.cpp