Chameleon

Chameleon Svn Source Tree

Root/branches/xZenu/src/util/doxygen/src/ftvhelp.h

Source at commit 1322 created 9 years 5 months ago.
By meklort, Add doxygen to utils folder
1/******************************************************************************
2 *
3 * Copyright (C) 1997-2011 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 "qtbc.h"
28#include <qtextstream.h>
29#include <qlist.h>
30#include "index.h"
31
32class QFile;
33struct FTVNode;
34class FTextStream;
35
36/*! A class that generates a dynamic tree view side panel.
37 */
38class FTVHelp : public IndexIntf
39{
40 public:
41 FTVHelp(bool LTI);
42 ~FTVHelp();
43 void initialize();
44 void finalize();
45 void incContentsDepth();
46 void decContentsDepth();
47 void addContentsItem(bool isDir,
48 const char *name,
49 const char *ref,
50 const char *file,
51 const char *anchor);
52 //void addIndexItem(const char *, const char *,
53 // const char *, const char *,
54 // const char *, const MemberDef *) {}
55 void addIndexItem(Definition *,MemberDef *,const char *) {}
56 void addIndexFile(const char *) {}
57 void addImageFile(const char *) {}
58 void addStyleSheetFile(const char *) {}
59 void generateTreeView();
60 void generateTreeViewInline(FTextStream &t);
61 static void generateTreeViewImages();
62 void generateTreeViewScripts();
63 private:
64 void generateScript(FTextStream &t);
65 void generateTree(FTextStream &t,const QList<FTVNode> &nl,int level);
66 bool generateJSTree(FTextStream &t,const QList<FTVNode> &nl,int level,bool &first);
67 void generateIndent(FTextStream &t,FTVNode *n,int level);
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
78

Archive Download this file

Revision: 1322