qhp.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2008 by Sebastian Pipping.
3  * Copyright (C) 2008 Dimitri van Heesch.
4  *
5  * Permission to use, copy, modify, and distribute this software and its
6  * documentation under the terms of the GNU General Public License is hereby
7  * granted. No representations are made about the suitability of this software
8  * for any purpose. It is provided "as is" without express or implied warranty.
9  * See the GNU General Public License for more details.
10  *
11  * Documents produced by Doxygen are derivative works derived from the
12  * input used in their production; they are not affected by this license.
13  *
14  * Sebastian Pipping <sebastian@pipping.org>
15  */
16 
17 #ifndef DOXYGEN_QHP_H
18 #define DOXYGEN_QHP_H
19 
20 #include "index.h"
21 #include "qhpxmlwriter.h"
22 
23 class Qhp : public IndexIntf
24 {
25  public:
26  Qhp();
27  ~Qhp();
28 
29  // BEGIN IndexIntf
30  void initialize();
31  void finalize();
32  void incContentsDepth();
33  void decContentsDepth();
34  void addContentsItem(bool isDir, const char * name, const char * ref,
35  const char * file, const char * anchor,
36  bool separateIndex,bool addToNavIndex,
37  Definition *def);
38  void addIndexItem(Definition *context, MemberDef *md,
39  const char *sectionAnchor, const char *title);
40  void addIndexFile(const char * name);
41  void addImageFile(const char * name);
42  void addStyleSheetFile(const char * name);
43  // END IndexIntf
44 
45  static QCString getQhpFileName();
46 
47  private:
48  void handlePrevSection();
49  void clearPrevSection();
50  void setPrevSection(const char * title, const char * basename, const char * anchor, int level);
51  void addFile(const char * fileName);
52 
54 
59 
63 
66 
68 };
69 
70 #endif // DOXYGEN_QHP_H
71 
static QCString name
Definition: declinfo.cpp:673
int m_sectionLevel
Definition: qhp.h:65
void finalize()
Definition: qhp.cpp:145
QCString m_prevSectionTitle
Definition: qhp.h:60
void setPrevSection(const char *title, const char *basename, const char *anchor, int level)
Definition: qhp.cpp:342
QhpXmlWriter m_files
Definition: qhp.h:58
void addStyleSheetFile(const char *name)
Definition: qhp.cpp:367
void addFile(const char *fileName)
Definition: qhp.cpp:357
void addContentsItem(bool isDir, const char *name, const char *ref, const char *file, const char *anchor, bool separateIndex, bool addToNavIndex, Definition *def)
Definition: qhp.cpp:192
Definition: qhp.h:23
void handlePrevSection()
Definition: qhp.cpp:295
void initialize()
Definition: qhp.cpp:69
QhpXmlWriter m_toc
Definition: qhp.h:56
void addImageFile(const char *name)
Definition: qhp.cpp:362
static QCString getQhpFileName()
Definition: qhp.cpp:280
fileName
Definition: dumpTree.py:9
void addIndexFile(const char *name)
Definition: qhp.cpp:275
int m_prevSectionLevel
Definition: qhp.h:64
void addIndexItem(Definition *context, MemberDef *md, const char *sectionAnchor, const char *title)
Definition: qhp.cpp:217
~Qhp()
Definition: qhp.cpp:64
QCString m_prevSectionAnchor
Definition: qhp.h:62
void decContentsDepth()
Definition: qhp.cpp:182
void incContentsDepth()
Definition: qhp.cpp:177
bool m_skipMainPageSection
Definition: qhp.h:67
Abstract interface for index generators.
Definition: index.h:30
static QCString getFullProjectName()
Definition: qhp.cpp:285
QhpXmlWriter m_index
Definition: qhp.h:57
void clearPrevSection()
Definition: qhp.cpp:350
QhpXmlWriter m_doc
Definition: qhp.h:55
QCString m_prevSectionBaseName
Definition: qhp.h:61
Qhp()
Definition: qhp.cpp:56