File: grantleeformatter.h

package info (click to toggle)
khelpcenter 4:18.04.0-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 7,720 kB
  • sloc: cpp: 5,955; xml: 249; perl: 86; makefile: 5; sh: 3
file content (53 lines) | stat: -rw-r--r-- 1,461 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/*
  This file is part of the KDE Help Center

  Copyright (c) 2016 Pino Toscano <pino@kde.org>

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  MA  02110-1301, USA
*/

#ifndef KHC_GRANTLEEFORMATTER_H
#define KHC_GRANTLEEFORMATTER_H

#include <QString>
#include <QList>
#include <QPair>

namespace KHC {

class DocEntry;
class GlossaryEntry;

  class GrantleeFormatter
  {
    public:
      GrantleeFormatter();
      ~GrantleeFormatter();

      QString formatOverview( const QString& title, const QString& name, const QString& content );
      QString formatGlossaryEntry( const GlossaryEntry& entry );
      QString formatSearchResults( const QString& words, const QList<QPair<DocEntry *, QString> >& results );

    private:
      struct Private;
      Private *d;
  };

}

#endif //KHC_FORMATTER_H

// vim:ts=2:sw=2:et