ROSE  0.9.10.69
Public Member Functions | List of all members
Sawyer::Document::TextMarkup Class Reference

Description

Renders markup as plain text.

This isn't fancy–it's got just enough smarts so a user can read the documentation when a more capable formatter like perldoc is not available.

Definition at line 21 of file DocumentTextMarkup.h.

#include <DocumentTextMarkup.h>

Inheritance diagram for Sawyer::Document::TextMarkup:
Inheritance graph
[legend]
Collaboration diagram for Sawyer::Document::TextMarkup:
Collaboration graph
[legend]

Public Member Functions

virtual bool emit (const std::string &doc)
 Emit documentation to output.
 
bool doingPageHeader () const
 Property: Whether to create a page header.
 
TextMarkupdoingPageHeader (bool b)
 Property: Whether to create a page header.
 
bool doingPageFooter () const
 Property: Whether to create a page footer.
 
TextMarkupdoingPageFooter (bool b)
 Property: Whether to create a page footer.
 
- Public Member Functions inherited from Sawyer::Document::BaseMarkup
BaseMarkuptitle (const std::string &pageName, const std::string &chapterNumber, const std::string &chapterTitle)
 Set title properties. More...
 
BaseMarkupversion (const std::string &versionString, const std::string &versionDate)
 Set version properties. More...
 
virtual std::string operator() (const std::string &)
 Parse input to generate POD. More...
 
const std::string & pageName () const
 Property: Page name. More...
 
BaseMarkuppageName (const std::string &s)
 Property: Page name. More...
 
const std::string & chapterNumber () const
 Property: Chapter number. More...
 
BaseMarkupchapterNumber (const std::string &s)
 Property: Chapter number. More...
 
const std::string & chapterNumberOrDefault () const
 Property: Chapter number. More...
 
const std::string & chapterTitle () const
 Property: Chapter title. More...
 
BaseMarkupchapterTitle (const std::string &s)
 Property: Chapter title. More...
 
const std::string & chapterTitleOrDefault () const
 Property: Chapter title. More...
 
const std::string & versionString () const
 Property: Version string. More...
 
BaseMarkupversionString (const std::string &s)
 Property: Version string. More...
 
const std::string & versionStringOrDefault () const
 Property: Version string. More...
 
const std::string & versionDate () const
 Property: Version date. More...
 
BaseMarkupversionDate (const std::string &s)
 Property: Version date. More...
 
const std::string & versionDateOrDefault () const
 Property: Version date. More...
 
- Public Member Functions inherited from Sawyer::Document::Markup::Grammar
Grammarwith (const Function::Ptr &)
 Insert function. More...
 
virtual std::string operator() (const std::string &s) const
 Evaluate an entire string. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Sawyer::Document::BaseMarkup
static bool hasNonSpace (const std::string &)
 True if this string contains any non-blank characters. More...
 
static std::string makeOneLine (const std::string &)
 Remove linefeeds. More...
 
static std::string leftJustify (const std::string &, size_t width)
 Left justify a string in a field of width N (or more). More...
 
static std::string escapeSingleQuoted (const std::string &)
 Escape single quoted string content. More...
 
- Static Public Member Functions inherited from Sawyer::Document::Markup::Grammar
static std::string unescape (const std::string &s)
 Expand escape sequences "@@", "@{" and "@}". More...
 
static std::string escape (const std::string &s)
 Escape all special "@", "{", and "}". More...
 

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