Source-highlight Library
srchilite::PreFormatter Class Reference

Preformats text to be generated. More...

#include <preformatter.h>

Inheritance diagram for srchilite::PreFormatter:

List of all members.

Public Member Functions

 PreFormatter (PreFormatterPtr f=PreFormatterPtr())
void setPreFormatter (PreFormatterPtr f)
 Sets the nested preformatter.
const std::string preformat (const std::string &text)
 Preformats the passed string (public version)

Protected Member Functions

virtual const std::string doPreformat (const std::string &text)
 Preformats the passed string (protected version).

Private Attributes

PreFormatterPtr decorator
 the possible nested preformatter (Decorator pattern)

Detailed Description

Preformats text to be generated.

This implements the Decorator pattern, thus yielding a chain of preformatters

Author:
Lorenzo Bettini

Constructor & Destructor Documentation

Parameters:
fthe nested decorated preformatter

Member Function Documentation

const string srchilite::PreFormatter::doPreformat ( const std::string &  text) [protected, virtual]

Preformats the passed string (protected version).

The subclasses must redefine this method to perform the preformatting. The default implementation does not perform any preformatting.

Parameters:
textthe string to be preformatted
Returns:
the preformatted string

Reimplemented in srchilite::CharTranslator, and srchilite::Untabifier.

const string srchilite::PreFormatter::preformat ( const std::string &  text)

Preformats the passed string (public version)

Parameters:
textthe string to be preformatted
Returns:
the preformatted string

Sets the nested preformatter.

Parameters:
fthe nested (decorated) preformatter

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