OutputDocInterface Class Reference

Interface used for generating documentation. More...

#include <outputgen.h>

Inheritance diagram for OutputDocInterface:

BaseOutputDocInterface CodeOutputInterface OutputList List of all members.

Public Member Functions

virtual ~OutputDocInterface ()
virtual void disableAllBut (OutputGenerator::OutputType o)=0
virtual void enableAll ()=0
virtual void disableAll ()=0
virtual void disable (OutputGenerator::OutputType o)=0
virtual void enable (OutputGenerator::OutputType o)=0
virtual bool isEnabled (OutputGenerator::OutputType o)=0
virtual void pushGeneratorState ()=0
virtual void popGeneratorState ()=0

Detailed Description

Interface used for generating documentation.

This abstract class is used by several functions to generate the output for a specific format. This interface contains some state saving and changing functions for dealing with format specific output.

Definition at line 419 of file outputgen.h.


Constructor & Destructor Documentation

virtual OutputDocInterface::~OutputDocInterface (  )  [inline, virtual]

Definition at line 422 of file outputgen.h.


Member Function Documentation

virtual void OutputDocInterface::disableAllBut ( OutputGenerator::OutputType  o  )  [pure virtual]

Disables all output formats except format o (useful for OutputList only)

Implemented in OutputList.

Referenced by TextGeneratorOLImpl::writeBreak().

virtual void OutputDocInterface::enableAll (  )  [pure virtual]

Enables all output formats as far as they have been enabled in the config file. (useful for OutputList only)

Implemented in OutputList.

virtual void OutputDocInterface::disableAll (  )  [pure virtual]

Disables all output formats (useful for OutputList only)

Implemented in OutputList.

virtual void OutputDocInterface::disable ( OutputGenerator::OutputType  o  )  [pure virtual]

Disables a specific output format (useful for OutputList only)

Implemented in OutputList.

Referenced by writePageRef().

virtual void OutputDocInterface::enable ( OutputGenerator::OutputType  o  )  [pure virtual]

Enables a specific output format (useful for OutputList only)

Implemented in OutputList.

virtual bool OutputDocInterface::isEnabled ( OutputGenerator::OutputType  o  )  [pure virtual]

Check whether a specific output format is currenly enabled (useful for OutputList only)

Implemented in OutputList.

virtual void OutputDocInterface::pushGeneratorState (  )  [pure virtual]

Pushes the state of the current generator (or list of generators) on a stack.

Implemented in OutputList.

Referenced by TextGeneratorOLImpl::writeBreak(), and writePageRef().

virtual void OutputDocInterface::popGeneratorState (  )  [pure virtual]

Pops the state of the current generator (or list of generators) on a stack. Should be preceded by a call the pushGeneratorState().

Implemented in OutputList.

Referenced by TextGeneratorOLImpl::writeBreak(), and writePageRef().


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



Generated on Mon Mar 31 10:59:02 2008 by  doxygen 1.5.1