A class that generated the HTML Help specific files. 更多...

#include <htmlhelp.h>

类 HtmlHelp 继承关系图:

HtmlHelp 的协作图:

类
class	Private

Public 成员函数
	HtmlHelp ()

	~HtmlHelp ()

void	initialize ()

void	finalize ()

void	incContentsDepth ()

void	decContentsDepth ()

void	addContentsItem (bool isDir, const QCString &name, const QCString &ref, const QCString &file, const QCString &anchor, bool separateIndex, bool addToNavIndex, const Definition *def)

void	addIndexItem (const Definition context, const MemberDef md, const QCString &sectionAnchor, const QCString &title)

void	addIndexFile (const QCString &name)

void	addImageFile (const QCString &)

void	addStyleSheetFile (const QCString &)

Public 成员函数继承自 IndexIntf
virtual	~IndexIntf ()

静态 Public 成员函数
static QCString	getLanguageString ()

Private 类型
enum	ImageNumber { BOOK_CLOSED =1, BOOK_OPEN, BOOK_CLOSED_NEW, BOOK_OPEN_NEW, FOLDER_CLOSED, FOLDER_OPEN, FOLDER_CLOSED_NEW, FOLDER_OPEN_NEW, QUERY, QUERY_NEW, TEXT, TEXT_NEW, WEB_DOC, WEB_DOC_NEW, WEB_LINK, WEB_LINK_NEW, INFO, INFO_NEW, LINK, LINK_NEW, BOOKLET, BOOKLET_NEW, EMAIL, EMAIL_NEW, EMAIL2, EMAIL2_NEW, IMAGE, IMAGE_NEW, AUDIO, AUDIO_NEW, MUSIC, MUSIC_NEW, VIDEO, VIDEO_NEW, INDEX, INDEX_NEW, IDEA, IDEA_NEW, NOTE, NOTE_NEW, TOOL, TOOL_NEW }

Private 成员函数
QCString	recode (const QCString &s)

Private 属性
std::unique_ptr< Private >	p

详细描述

A class that generated the HTML Help specific files.

These files can be used with the Microsoft HTML Help workshop to generate compressed HTML files (.chm).

在文件 htmlhelp.h 第 32 行定义.

成员枚举类型说明

◆ ImageNumber

enum HtmlHelp::ImageNumber

private

used in imageNumber param of HTMLHelp::addContentsItem() function to specify document icon in tree view. Writes <param name="ImageNumber" value="xx"> in .HHC file.

枚举值
BOOK_CLOSED
BOOK_OPEN
BOOK_CLOSED_NEW
BOOK_OPEN_NEW
FOLDER_CLOSED
FOLDER_OPEN
FOLDER_CLOSED_NEW
FOLDER_OPEN_NEW
QUERY
QUERY_NEW
TEXT
TEXT_NEW
WEB_DOC
WEB_DOC_NEW
WEB_LINK
WEB_LINK_NEW
INFO
INFO_NEW
LINK
LINK_NEW
BOOKLET
BOOKLET_NEW
EMAIL
EMAIL_NEW
EMAIL2
EMAIL2_NEW
IMAGE
IMAGE_NEW
AUDIO
AUDIO_NEW
MUSIC
MUSIC_NEW
VIDEO
VIDEO_NEW
INDEX
INDEX_NEW
IDEA
IDEA_NEW
NOTE
NOTE_NEW
TOOL
TOOL_NEW

在文件 htmlhelp.h 第 37 行定义.

                      {
       BOOK_CLOSED=1,    BOOK_OPEN,
       BOOK_CLOSED_NEW,  BOOK_OPEN_NEW,
       FOLDER_CLOSED,    FOLDER_OPEN,
       FOLDER_CLOSED_NEW,FOLDER_OPEN_NEW,
       QUERY,            QUERY_NEW,
       TEXT,             TEXT_NEW,
       WEB_DOC,          WEB_DOC_NEW,
       WEB_LINK,         WEB_LINK_NEW,
       INFO,             INFO_NEW,
       LINK,             LINK_NEW,
       BOOKLET,          BOOKLET_NEW,
       EMAIL,            EMAIL_NEW,
       EMAIL2,           EMAIL2_NEW,
       IMAGE,            IMAGE_NEW,
       AUDIO,            AUDIO_NEW,
       MUSIC,            MUSIC_NEW,
       VIDEO,            VIDEO_NEW,
       INDEX,            INDEX_NEW,
       IDEA,             IDEA_NEW,
       NOTE,             NOTE_NEW,
       TOOL,             TOOL_NEW
     };

构造及析构函数说明

◆ HtmlHelp()

HtmlHelp::HtmlHelp ( )

Constructs an html object. The object has to be initialized before it can be used.

在文件 htmlhelp.cpp 第 332 行定义.

                    : p(std::make_unique<Private>())
 {
 }

◆ ~HtmlHelp()

HtmlHelp::~HtmlHelp ( )

在文件 htmlhelp.cpp 第 336 行定义.

337 {

338 }

成员函数说明

◆ addContentsItem()

void HtmlHelp::addContentsItem	(	bool	isDir,
		const QCString &	name,
		const QCString &	ref,
		const QCString &	file,
		const QCString &	anchor,
		bool	separateIndex,
		bool	addToNavIndex,
		const Definition *	def
	)

virtual

Add an list item to the contents file.

参数

isDir	boolean indicating if this is a dir or file entry
name	the name of the item.
ref	the URL of to the item.
file	the file in which the item is defined.
anchor	the anchor of the item.
separateIndex	not used.
addToNavIndex	not used.
def	not used.

实现了 IndexIntf.

在文件 htmlhelp.cpp 第 630 行定义.

 {
   static bool binaryTOC = Config_getBool(BINARY_TOC);
   // If we're using a binary toc then folders cannot have links.
   // Tried this and I didn't see any problems, when not using
   // the resetting of file and anchor the TOC works better
   // (prev / next button)
   //if(Config_getBool(BINARY_TOC) && isDir)
   //{
     //file = 0;
     //anchor = 0;
   //}
   p->ctsItemPresent = true;
   int i; for (i=0;i<p->dc;i++) p->cts << "  ";
   p->cts << "<LI><OBJECT type=\"text/sitemap\">";
   p->cts << "<param name=\"Name\" value=\"" << convertToHtml(p->recoder.recode(name),TRUE) << "\">";
   if (!file.isEmpty())      // made file optional param - KPW
   {
     if (file[0]=='!' || file[0]=='^') // special markers for user defined URLs
     {
       p->cts << "<param name=\"";
       if (file[0]=='^') p->cts << "URL"; else p->cts << "Local";
       p->cts << "\" value=\"";
       p->cts << &file[1];
       p->cts << "\">";
     }
     else
     {
       if (!(binaryTOC && isDir))
       {
         p->cts << "<param name=\"Local\" value=\"";
         p->cts << addHtmlExtensionIfMissing(file);
         if (!anchor.isEmpty()) p->cts << "#" << anchor;
         p->cts << "\">";
       }
     }
   }
   p->cts << "<param name=\"ImageNumber\" value=\"";
   if (isDir)  // added - KPW
   {
     p->cts << (int)BOOK_CLOSED ;
   }
   else
   {
     p->cts << (int)TEXT;
   }
   p->cts << "\">";
   p->cts << "</OBJECT>\n";
 }

引用了 addHtmlExtensionIfMissing(), BOOK_CLOSED, Config_getBool, convertToHtml(), QCString::isEmpty(), p, TEXT , 以及 TRUE.

◆ addImageFile()

void HtmlHelp::addImageFile ( const QCString & fileName )

virtual

实现了 IndexIntf.

在文件 htmlhelp.cpp 第 720 行定义.

 {
   p->imageFiles.insert(fileName.str());
 }

引用了 p , 以及 QCString::str().

◆ addIndexFile()

void HtmlHelp::addIndexFile ( const QCString & name )

virtual

实现了 IndexIntf.

在文件 htmlhelp.cpp 第 568 行定义.

 {
   p->indexFiles.insert(s.str());
 }

引用了 p , 以及 QCString::str().

◆ addIndexItem()

void HtmlHelp::addIndexItem	(	const Definition *	context,
		const MemberDef *	md,
		const QCString &	sectionAnchor,
		const QCString &	title
	)

virtual

实现了 IndexIntf.

在文件 htmlhelp.cpp 第 688 行定义.

 {
   if (md)
   {
     static bool separateMemberPages = Config_getBool(SEPARATE_MEMBER_PAGES);
     if (context==0) // global member
     {
       if (md->getGroupDef())
         context = md->getGroupDef();
       else if (md->getFileDef())
         context = md->getFileDef();
     }
     if (context==0) return; // should not happen
  
     QCString cfname  = md->getOutputFileBase();
     QCString cfiname = context->getOutputFileBase();
     QCString level1  = context->name();
     QCString level2  = md->name();
     QCString contRef = separateMemberPages ? cfname : cfiname;
     QCString memRef  = cfname;
     QCString anchor  = !sectionAnchor.isEmpty() ? sectionAnchor : md->anchor();
     p->index.addItem(level1,level2,contRef,anchor,TRUE,FALSE);
     p->index.addItem(level2,level1,memRef,anchor,TRUE,TRUE);
   }
   else if (context)
   {
     QCString level1  = !word.isEmpty() ? word : context->name();
     p->index.addItem(level1,QCString(),context->getOutputFileBase(),sectionAnchor,TRUE,FALSE);
   }
 }

引用了 MemberDef::anchor(), Config_getBool, FALSE, MemberDef::getFileDef(), MemberDef::getGroupDef(), MemberDef::getOutputFileBase(), Definition::getOutputFileBase(), QCString::isEmpty(), Definition::name(), p , 以及 TRUE.

◆ addStyleSheetFile()

void HtmlHelp::addStyleSheetFile ( const QCString & )

inlinevirtual

实现了 IndexIntf.

在文件 htmlhelp.h 第 80 行定义.

80 {}

◆ decContentsDepth()

void HtmlHelp::decContentsDepth ( )

virtual

Decrease the level of the contents hierarchy. This will end the unnumber HTML list.

参见: incContentsDepth()

实现了 IndexIntf.

在文件 htmlhelp.cpp 第 613 行定义.

 {
   int i; for (i=0;i<p->dc;i++) p->cts << "  ";
   p->cts << "</UL>\n";
   --p->dc;
 }

引用了 p.

◆ finalize()

void HtmlHelp::finalize ( )

virtual

Finalizes the HTML help. This will finish and close the contents file (index.hhc) and the index file (index.hhk).

参见: initialize()

实现了 IndexIntf.

在文件 htmlhelp.cpp 第 577 行定义.

 {
   // end the contents file
   p->cts << "</UL>\n";
   p->cts << "</BODY>\n";
   p->cts << "</HTML>\n";
   p->cts.close();
  
   p->index.writeFields(p->kts);
  
   // end the index file
   p->kts << "</UL>\n";
   p->kts << "</BODY>\n";
   p->kts << "</HTML>\n";
   p->kts.close();
  
   p->createProjectFile();
  
   p->recoder.finalize();
 }

引用了 p.

◆ getLanguageString()

QCString HtmlHelp::getLanguageString ( )

static

在文件 htmlhelp.cpp 第 480 行定义.

 {
   if (!theTranslator->idLanguage().isEmpty())
   {
     auto it = s_languageDict.find(theTranslator->idLanguage().str());
     if (it!=s_languageDict.end())
     {
       return QCString(it->second);
     }
   }
   // default language
   return "0x409 English (United States)";
 }

引用了 Translator::idLanguage(), QCString::isEmpty(), s_languageDict, QCString::str() , 以及 theTranslator.

被这些函数引用 HtmlHelp::Private::createProjectFile() , 以及 TranslateContext::Private::langString().

◆ incContentsDepth()

void HtmlHelp::incContentsDepth ( )

virtual

Increase the level of the contents hierarchy. This will start a new unnumbered HTML list in contents file.

参见: decContentsDepth()

实现了 IndexIntf.

在文件 htmlhelp.cpp 第 602 行定义.

 {
   int i; for (i=0;i<p->dc+1;i++) p->cts << "  ";
   p->cts << "<UL>\n";
   ++p->dc;
 }

引用了 p.

◆ initialize()

void HtmlHelp::initialize ( )

virtual

This will create a contents file (index.hhc) and a index file (index.hhk) and write the header of those files. It also creates a project file (index.hhp)

参见: finalize()

实现了 IndexIntf.

在文件 htmlhelp.cpp 第 443 行定义.

 {
   p->recoder.initialize();
  
   /* open the contents file */
   QCString fName = Config_getString(HTML_OUTPUT) + "/index.hhc";
   p->cts.open(fName.str(),std::ofstream::out | std::ofstream::binary);
   if (!p->cts.is_open())
   {
     term("Could not open file %s for writing\n",qPrint(fName));
   }
   /* Write the header of the contents file */
   p->cts << "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">\n"
          "<HTML><HEAD></HEAD><BODY>\n"
          "<OBJECT type=\"text/site properties\">\n"
          "<param name=\"FrameName\" value=\"right\">\n"
          "</OBJECT>\n"
          "<UL>\n";
  
   /* open the contents file */
   fName = Config_getString(HTML_OUTPUT) + "/index.hhk";
   p->kts.open(fName.str(),std::ofstream::out | std::ofstream::binary);
   if (!p->kts.is_open())
   {
     term("Could not open file %s for writing\n",qPrint(fName));
   }
   /* Write the header of the contents file */
   p->kts << "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">\n"
          "<HTML><HEAD></HEAD><BODY>\n"
          "<OBJECT type=\"text/site properties\">\n"
          "<param name=\"FrameName\" value=\"right\">\n"
          "</OBJECT>\n"
          "<UL>\n";
  
 }

引用了 Config_getString, p, qPrint(), QCString::str() , 以及 term().

◆ recode()

QCString HtmlHelp::recode ( const QCString & s )

private

类成员变量说明

◆ p

std::unique_ptr<Private> HtmlHelp::p

private

在文件 htmlhelp.h 第 84 行定义.

被这些函数引用 addContentsItem(), addImageFile(), addIndexFile(), addIndexItem(), decContentsDepth(), finalize(), incContentsDepth() , 以及 initialize().

该类的文档由以下文件生成:

src/htmlhelp.h
src/htmlhelp.cpp

类

Public 成员函数

静态 Public 成员函数

Private 类型

Private 成员函数

Private 属性

详细描述

成员枚举类型说明

◆ ImageNumber

构造及析构函数说明

◆ HtmlHelp()

◆ ~HtmlHelp()

成员函数说明

◆ addContentsItem()

◆ addImageFile()

◆ addIndexFile()

◆ addIndexItem()

◆ addStyleSheetFile()

◆ decContentsDepth()

◆ finalize()

◆ getLanguageString()

◆ incContentsDepth()

◆ initialize()

◆ recode()

类成员变量说明

◆ p