Source/cmDocumentationFormatterText.h

   1 /*============================================================================
   2   CMake - Cross Platform Makefile Generator
   3   Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
   4
   5   Distributed under the OSI-approved BSD License (the "License");
   6   see accompanying file Copyright.txt for details.
   7
   8   This software is distributed WITHOUT ANY WARRANTY; without even the
   9   implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10   See the License for more information.
  11 ============================================================================*/
  12 #ifndef _cmDocumentationFormatterText_h
  13 #define _cmDocumentationFormatterText_h
  14
  15 #include "cmStandardIncludes.h"
  16
  17 #include "cmDocumentationFormatter.h"
  18
  19 /** Class to print the documentation as plain text.  */
  20 class cmDocumentationFormatterText : public cmDocumentationFormatter
  21 {
  22 public:
  23   cmDocumentationFormatterText();
  24
  25   virtual cmDocumentationEnums::Form GetForm() const
  26                                       { return cmDocumentationEnums::TextForm;}
  27
  28   virtual void PrintSection(std::ostream& os,
  29                     const cmDocumentationSection& section,
  30                     const char* name);
  31   virtual void PrintPreformatted(std::ostream& os, const char* text);
  32   virtual void PrintParagraph(std::ostream& os, const char* text);
  33   void PrintColumn(std::ostream& os, const char* text);
  34   void SetIndent(const char* indent);
  35 protected:
  36   int TextWidth;
  37   const char* TextIndent;
  38 };
  39
  40 #endif