My Project
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ftvhelp.h
Go to the documentation of this file.
1 /******************************************************************************
2  *
3  * Copyright (C) 1997-2015 by 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  */
15 
16 /******************************************************************************
17  * ftvhelp.h,v 1.0 2000/09/06 16:09:00
18  *
19  * Kenney Wong <kwong@ea.com>
20  *
21  * Folder Tree View for offline help on browsers that do not support HTML Help.
22  */
23 
24 #ifndef FTVHELP_H
25 #define FTVHELP_H
26 
27 #include <qlist.h>
28 #include "index.h"
29 
30 class QFile;
31 class Definition;
32 struct FTVNode;
33 class FTextStream;
34 
37 class FTVHelp : public IndexIntf
38 {
39  public:
40  FTVHelp(bool LTI);
41  ~FTVHelp();
42  void initialize();
43  void finalize();
44  void incContentsDepth();
45  void decContentsDepth();
46  void addContentsItem(bool isDir,
47  const char *name,
48  const char *ref,
49  const char *file,
50  const char *anchor,
51  bool separateIndex,
52  bool addToNavIndex,
53  Definition *def);
54  void addIndexItem(Definition *,MemberDef *,const char *,const char *) {}
55  void addIndexFile(const char *) {}
56  void addImageFile(const char *) {}
57  void addStyleSheetFile(const char *) {}
58  void generateTreeView();
59  void generateTreeViewInline(FTextStream &t);
60  static void generateTreeViewImages();
61  void generateTreeViewScripts();
62  private:
63  void generateTree(FTextStream &t,const QList<FTVNode> &nl,int level,int maxLevel,int &index);
64  //bool generateJSTree(FTextStream &tidx,FTextStream &t,const QList<FTVNode> &nl,int level,bool &first);
65  //bool generateJSTreeTopLevel(FTextStream &tidx,FTextStream &t,const QList<FTVNode> &nl,int level,bool &first);
66  QCString generateIndentLabel(FTVNode *n,int level);
67  void generateIndent(FTextStream &t,FTVNode *n,bool opened);
68  void generateLink(FTextStream &t,FTVNode *n);
69  //void generateJSLink(FTextStream &t,FTVNode *n);
70  QList<FTVNode> *m_indentNodes;
71  int m_indent;
72  bool m_topLevelIndex;
73 };
74 
75 
76 #endif /* FTVHELP_H */
77