doxygen
ftvhelp.h
1 /******************************************************************************
2  *
3  * Copyright (C) 1997-2021 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 <memory>
28 #include <vector>
29 #include "qcstring.h"
30 
31 class Definition;
32 class MemberDef;
33 class TextStream;
34 
35 
38 class FTVHelp
39 {
40  public:
41  FTVHelp(bool LTI);
42  ~FTVHelp();
43  FTVHelp(FTVHelp &&);
44  void initialize();
45  void finalize();
46  void incContentsDepth();
47  void decContentsDepth();
48  void addContentsItem(bool isDir,
49  const QCString &name,
50  const QCString &ref,
51  const QCString &file,
52  const QCString &anchor,
53  bool separateIndex,
54  bool addToNavIndex,
55  const Definition *def);
56  void addIndexItem(const Definition *,const MemberDef *,const QCString &,const QCString &) {}
57  void addIndexFile(const QCString &) {}
58  void addImageFile(const QCString &) {}
59  void addStyleSheetFile(const QCString &) {}
60  void generateTreeView();
61  void generateTreeViewInline(TextStream &t);
62  static void generateTreeViewImages();
63  void generateTreeViewScripts();
64  private:
65  struct Private;
66  std::unique_ptr<Private> p;
67 };
68 
69 extern const char *JAVASCRIPT_LICENSE_TEXT;
70 
71 #endif /* FTVHELP_H */
72 
The common base class of all entity definitions found in the sources.
Definition: definition.h:76
A model of a class/file/namespace member symbol.
Definition: memberdef.h:45
void finalize()
Definition: ftvhelp.cpp:157
void initialize()
Definition: ftvhelp.cpp:149
Text streaming class that buffers data.
Definition: textstream.h:34
void addContentsItem(bool isDir, const QCString &name, const QCString &ref, const QCString &file, const QCString &anchor, bool separateIndex, bool addToNavIndex, const Definition *def)
Definition: ftvhelp.cpp:208
Definition: ftvhelp.cpp:127
FTVHelp(bool LTI)
Definition: ftvhelp.cpp:142
A class that generates a dynamic tree view side panel.
Definition: ftvhelp.h:38
void decContentsDepth()
Definition: ftvhelp.cpp:177
void incContentsDepth()
Definition: ftvhelp.cpp:166
This is an alternative implementation of QCString.
Definition: qcstring.h:108