Source/cmDocumentationFormatterText.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmDocumentationFormatterText.h,v $
   5   Language:  C++
   6   Date:      $Date: 2007-10-22 16:48:39 $
   7   Version:   $Revision: 1.2 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #ifndef _cmDocumentationFormatterText_h
  18 #define _cmDocumentationFormatterText_h
  19
  20 #include "cmStandardIncludes.h"
  21
  22 #include "cmDocumentationFormatter.h"
  23
  24 /** Class to print the documentation as plain text.  */
  25 class cmDocumentationFormatterText : public cmDocumentationFormatter
  26 {
  27 public:
  28   cmDocumentationFormatterText();
  29
  30   virtual cmDocumentationEnums::Form GetForm() const
  31                                       { return cmDocumentationEnums::TextForm;}
  32
  33   virtual void PrintSection(std::ostream& os,
  34                     const cmDocumentationSection& section,
  35                     const char* name);
  36   virtual void PrintPreformatted(std::ostream& os, const char* text);
  37   virtual void PrintParagraph(std::ostream& os, const char* text);
  38   void PrintColumn(std::ostream& os, const char* text);
  39   void SetIndent(const char* indent);
  40 protected:
  41   int TextWidth;
  42   const char* TextIndent;
  43 };
  44
  45 #endif