runtime/khelpcenter/formatter.h

   1 /*
   2     This file is part of KHelpcenter.
   3
   4     Copyright (c) 2003 Cornelius Schumacher <schumacher@kde.org>
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19 */
  20 #ifndef KHC_FORMATTER_H
  21 #define KHC_FORMATTER_H
  22
  23
  24 #include <QMap>
  25
  26 namespace KHC {
  27
  28 class Formatter
  29 {
  30   public:
  31     Formatter();
  32     virtual ~Formatter();
  33
  34     bool readTemplates();
  35
  36     virtual QString header( const QString &title );
  37     virtual QString footer();
  38     virtual QString separator();
  39     virtual QString docTitle( const QString & );
  40     virtual QString sectionHeader( const QString & );
  41     virtual QString paragraph( const QString & );
  42     virtual QString title( const QString & );
  43
  44     virtual QString processResult( const QString & );
  45
  46   private:
  47     bool mHasTemplate;
  48     QMap<QString,QString> mSymbols;
  49 };
  50
  51 }
  52
  53 #endif
  54
  55 // vim:ts=2:sw=2:et