Doxygen
htmlhelp.h
浏览该文件的文档.
1 /******************************************************************************
2  *
3  * Copyright (C) 1997-2020 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  * The code is this file is largely based on a contribution from
15  * Harm van der Heijden <H.v.d.Heijden@phys.tue.nl>
16  * Please send thanks to him and bug reports to me :-)
17  */
18 
19 #ifndef HTMLHELP_H
20 #define HTMLHELP_H
21 
22 #include <memory>
23 #include "index.h"
24 
25 class Definition;
26 
27 /** A class that generated the HTML Help specific files.
28  *
29  * These files can be used with the Microsoft HTML Help workshop
30  * to generate compressed HTML files (.chm).
31  */
32 class HtmlHelp : public IndexIntf
33 {
34  /*! used in imageNumber param of HTMLHelp::addContentsItem() function
35  to specify document icon in tree view.
36  Writes <param name="ImageNumber" value="xx"> in .HHC file. */
37  enum ImageNumber {
59  };
60  public:
61  //static HtmlHelp *getInstance();
62  HtmlHelp();
63  ~HtmlHelp();
64  void initialize();
65  void finalize();
66  void incContentsDepth();
67  void decContentsDepth();
68  void addContentsItem(bool isDir,
69  const QCString &name,
70  const QCString &ref,
71  const QCString &file,
72  const QCString &anchor,
73  bool separateIndex,
74  bool addToNavIndex,
75  const Definition *def);
76  void addIndexItem(const Definition *context,const MemberDef *md,
77  const QCString &sectionAnchor, const QCString &title);
78  void addIndexFile(const QCString &name);
79  void addImageFile(const QCString &);
80  void addStyleSheetFile(const QCString &) {}
81  static QCString getLanguageString();
82 
83  private:
84  class Private;
85  std::unique_ptr<Private> p;
86  QCString recode(const QCString &s);
87 
88 };
89 
90 #endif /* HTMLHELP_H */
91 
HtmlHelp::EMAIL
@ EMAIL
Definition: htmlhelp.h:49
HtmlHelp::WEB_LINK_NEW
@ WEB_LINK_NEW
Definition: htmlhelp.h:45
HtmlHelp::BOOK_CLOSED
@ BOOK_CLOSED
Definition: htmlhelp.h:38
HtmlHelp::BOOKLET
@ BOOKLET
Definition: htmlhelp.h:48
Definition
The common base class of all entity definitions found in the sources.
Definition: definition.h:76
HtmlHelp::FOLDER_OPEN_NEW
@ FOLDER_OPEN_NEW
Definition: htmlhelp.h:41
HtmlHelp::initialize
void initialize()
Definition: htmlhelp.cpp:443
HtmlHelp::QUERY_NEW
@ QUERY_NEW
Definition: htmlhelp.h:42
index.h
HtmlHelp::INFO_NEW
@ INFO_NEW
Definition: htmlhelp.h:46
HtmlHelp::IDEA
@ IDEA
Definition: htmlhelp.h:56
HtmlHelp::p
std::unique_ptr< Private > p
Definition: htmlhelp.h:84
HtmlHelp::BOOK_CLOSED_NEW
@ BOOK_CLOSED_NEW
Definition: htmlhelp.h:39
HtmlHelp::INDEX
@ INDEX
Definition: htmlhelp.h:55
HtmlHelp::INDEX_NEW
@ INDEX_NEW
Definition: htmlhelp.h:55
HtmlHelp::WEB_DOC_NEW
@ WEB_DOC_NEW
Definition: htmlhelp.h:44
HtmlHelp::ImageNumber
ImageNumber
Definition: htmlhelp.h:37
HtmlHelp::EMAIL2
@ EMAIL2
Definition: htmlhelp.h:50
HtmlHelp::EMAIL2_NEW
@ EMAIL2_NEW
Definition: htmlhelp.h:50
HtmlHelp::AUDIO
@ AUDIO
Definition: htmlhelp.h:52
HtmlHelp::incContentsDepth
void incContentsDepth()
Definition: htmlhelp.cpp:602
HtmlHelp::addIndexItem
void addIndexItem(const Definition *context, const MemberDef *md, const QCString &sectionAnchor, const QCString &title)
Definition: htmlhelp.cpp:688
HtmlHelp::FOLDER_OPEN
@ FOLDER_OPEN
Definition: htmlhelp.h:40
HtmlHelp::TEXT
@ TEXT
Definition: htmlhelp.h:43
HtmlHelp::recode
QCString recode(const QCString &s)
HtmlHelp::LINK
@ LINK
Definition: htmlhelp.h:47
HtmlHelp::decContentsDepth
void decContentsDepth()
Definition: htmlhelp.cpp:613
HtmlHelp::VIDEO_NEW
@ VIDEO_NEW
Definition: htmlhelp.h:54
HtmlHelp::QUERY
@ QUERY
Definition: htmlhelp.h:42
MemberDef
A model of a class/file/namespace member symbol.
Definition: memberdef.h:45
HtmlHelp::BOOK_OPEN
@ BOOK_OPEN
Definition: htmlhelp.h:38
HtmlHelp::addIndexFile
void addIndexFile(const QCString &name)
Definition: htmlhelp.cpp:568
HtmlHelp::MUSIC_NEW
@ MUSIC_NEW
Definition: htmlhelp.h:53
HtmlHelp::VIDEO
@ VIDEO
Definition: htmlhelp.h:54
HtmlHelp::WEB_DOC
@ WEB_DOC
Definition: htmlhelp.h:44
HtmlHelp::HtmlHelp
HtmlHelp()
Definition: htmlhelp.cpp:332
HtmlHelp::IDEA_NEW
@ IDEA_NEW
Definition: htmlhelp.h:56
HtmlHelp::NOTE_NEW
@ NOTE_NEW
Definition: htmlhelp.h:57
HtmlHelp
A class that generated the HTML Help specific files.
Definition: htmlhelp.h:32
HtmlHelp::NOTE
@ NOTE
Definition: htmlhelp.h:57
HtmlHelp::EMAIL_NEW
@ EMAIL_NEW
Definition: htmlhelp.h:49
HtmlHelp::addStyleSheetFile
void addStyleSheetFile(const QCString &)
Definition: htmlhelp.h:80
HtmlHelp::finalize
void finalize()
Definition: htmlhelp.cpp:577
HtmlHelp::AUDIO_NEW
@ AUDIO_NEW
Definition: htmlhelp.h:52
HtmlHelp::LINK_NEW
@ LINK_NEW
Definition: htmlhelp.h:47
HtmlHelp::getLanguageString
static QCString getLanguageString()
Definition: htmlhelp.cpp:480
HtmlHelp::TOOL
@ TOOL
Definition: htmlhelp.h:58
HtmlHelp::Private
Definition: htmlhelp.cpp:313
HtmlHelp::TOOL_NEW
@ TOOL_NEW
Definition: htmlhelp.h:58
HtmlHelp::BOOK_OPEN_NEW
@ BOOK_OPEN_NEW
Definition: htmlhelp.h:39
HtmlHelp::TEXT_NEW
@ TEXT_NEW
Definition: htmlhelp.h:43
HtmlHelp::INFO
@ INFO
Definition: htmlhelp.h:46
HtmlHelp::MUSIC
@ MUSIC
Definition: htmlhelp.h:53
HtmlHelp::~HtmlHelp
~HtmlHelp()
Definition: htmlhelp.cpp:336
HtmlHelp::WEB_LINK
@ WEB_LINK
Definition: htmlhelp.h:45
HtmlHelp::addContentsItem
void addContentsItem(bool isDir, const QCString &name, const QCString &ref, const QCString &file, const QCString &anchor, bool separateIndex, bool addToNavIndex, const Definition *def)
Definition: htmlhelp.cpp:630
HtmlHelp::IMAGE_NEW
@ IMAGE_NEW
Definition: htmlhelp.h:51
HtmlHelp::IMAGE
@ IMAGE
Definition: htmlhelp.h:51
HtmlHelp::FOLDER_CLOSED
@ FOLDER_CLOSED
Definition: htmlhelp.h:40
HtmlHelp::FOLDER_CLOSED_NEW
@ FOLDER_CLOSED_NEW
Definition: htmlhelp.h:41
IndexIntf
Abstract interface for index generators.
Definition: index.h:32
HtmlHelp::BOOKLET_NEW
@ BOOKLET_NEW
Definition: htmlhelp.h:48
HtmlHelp::addImageFile
void addImageFile(const QCString &)
Definition: htmlhelp.cpp:720
QCString
This is an alternative implementation of QCString.
Definition: qcstring.h:108