HtmlHelp::Private类 参考

HtmlHelp::Private 的协作图:

Public 成员函数
	Private ()
void	createProjectFile ()

Public 属性
std::ofstream	cts
std::ofstream	kts
bool	ctsItemPresent = false
int	dc = 0
StringSet	indexFiles
StringSet	imageFiles
HtmlHelpRecoder	recoder
HtmlHelpIndex	index

详细描述

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

构造及析构函数说明

Private()

HtmlHelp::Private::Private ( )

inline

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

: index(recoder) {}

成员函数说明

createProjectFile()

void HtmlHelp::Private::createProjectFile

(

)

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

{
  /* Write the project file */
  QCString fName = Config_getString(HTML_OUTPUT) + "/index.hhp";
  std::ofstream t(fName.str(),std::ofstream::out | std::ofstream::binary);
  if (t.is_open())
  {
    const char *hhcFile = "\"index.hhc\"";
    const char *hhkFile = "\"index.hhk\"";
    bool hhkPresent = index.size()>0;
    if (!ctsItemPresent) hhcFile = "";
    if (!hhkPresent) hhkFile = "";
 
    QCString indexName="index"+Doxygen::htmlFileExtension;
    t << "[OPTIONS]\n";
    if (!Config_getString(CHM_FILE).isEmpty())
    {
      t << "Compiled file=" << Config_getString(CHM_FILE) << "\n";
    }
    t << "Compatibility=1.1\n"
         "Full-text search=Yes\n";
    if (ctsItemPresent) t << "Contents file=index.hhc\n";
    t << "Default Window=main\n"
         "Default topic=" << indexName << "\n";
    if (hhkPresent) t << "Index file=index.hhk\n";
    t << "Language=" << getLanguageString() << "\n";
    if (Config_getBool(BINARY_TOC)) t << "Binary TOC=YES\n";
    if (Config_getBool(GENERATE_CHI)) t << "Create CHI file=YES\n";
    t << "Title=" << recoder.recode(Config_getString(PROJECT_NAME)) << "\n\n";
 
    t << "[WINDOWS]\n";
 
    // NOTE: the 0x10387e number is a set of bits specifying the buttons
    //       which should appear in the CHM viewer; that specific value
    //       means "show all buttons including the font-size one";
    //       the font-size one is not normally settable by the HTML Help Workshop
    //       utility but the way to set it is described here:
    //          http://support.microsoft.com/?scid=kb%3Ben-us%3B240062&x=17&y=18
    // NOTE: the 0x70387e number in addition to the above the Next and Prev button
    //       are shown. They can only be shown in case of a binary toc.
    //          dee http://www.mif2go.com/xhtml/htmlhelp_0016_943addingtabsandtoolbarbuttonstohtmlhelp.htm#Rz108x95873
    //       Value has been taken from htmlhelp.h file of the HTML Help Workshop
    if (Config_getBool(BINARY_TOC))
    {
      t << "main=\"" << recoder.recode(Config_getString(PROJECT_NAME)) << "\"," << hhcFile << ","
         << hhkFile << ",\"" << indexName << "\",\"" <<
         indexName << "\",,,,,0x23520,,0x70387e,,,,,,,,0\n\n";
    }
    else
    {
      t << "main=\"" << recoder.recode(Config_getString(PROJECT_NAME)) << "\"," << hhcFile << ","
         << hhkFile << ",\"" << indexName << "\",\"" <<
         indexName << "\",,,,,0x23520,,0x10387e,,,,,,,,0\n\n";
    }
 
    t << "[FILES]\n";
    for (auto &s : indexFiles)
    {
      t << s.c_str() << "\n";
    }
    for (auto &s : imageFiles)
    {
      t << s.c_str() << "\n";
    }
    t.close();
  }
  else
  {
    err("Could not open file %s for writing\n",qPrint(fName));
  }
}

引用了 Config_getBool, Config_getString, ctsItemPresent, err(), HtmlHelp::getLanguageString(), Doxygen::htmlFileExtension, imageFiles, index, indexFiles, qPrint(), HtmlHelpRecoder::recode(), recoder, HtmlHelpIndex::size() , 以及 QCString::str().

类成员变量说明

cts

std::ofstream HtmlHelp::Private::cts

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

ctsItemPresent

bool HtmlHelp::Private::ctsItemPresent = false

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

被这些函数引用 createProjectFile().

dc

int HtmlHelp::Private::dc = 0

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

imageFiles

StringSet HtmlHelp::Private::imageFiles

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

被这些函数引用 createProjectFile().

index

HtmlHelpIndex HtmlHelp::Private::index

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

被这些函数引用 createProjectFile().

indexFiles

StringSet HtmlHelp::Private::indexFiles

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

被这些函数引用 createProjectFile().

kts

std::ofstream HtmlHelp::Private::kts

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

recoder

HtmlHelpRecoder HtmlHelp::Private::recoder

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

被这些函数引用 createProjectFile().

---

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

• src/htmlhelp.cpp