HtmlHelp::Private Class Reference

Collaboration diagram for HtmlHelp::Private:

Public Member Functions
	Private ()
void	createProjectFile ()

Public Attributes
std::ofstream	cts
std::ofstream	kts
QCString	prevFile
QCString	prevAnc
bool	ctsItemPresent = false
int	dc = 0
StringSet	indexFiles
StringSet	imageFiles
StringSet	styleFiles
HtmlHelpRecoder	recoder
HtmlHelpIndex	index

Detailed Description

Definition at line 335 of file htmlhelp.cpp.

Constructor & Destructor Documentation

Private()

HtmlHelp::Private::Private ( )

inline

Definition at line 338 of file htmlhelp.cpp.

: index(recoder) {}

References index, and recoder.

Member Function Documentation

createProjectFile()

void HtmlHelp::Private::createProjectFile

(

)

Definition at line 401 of file htmlhelp.cpp.

{
  /* Write the project file */
  QCString fName = Config_getString(HTML_OUTPUT) + "/" + hhpFileName;
  std::ofstream t = Portable::openOutputStream(fName);
  if (t.is_open())
  {
    QCString hhcFile = "\"" + hhcFileName  + "\"";
    QCString hhkFile = "\"" + hhkFileName  + "\"";
    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";
    }
    else
    {
      t << "Compiled file=index.chm\n";
    }
    t << "Compatibility=1.1\n"
         "Full-text search=Yes\n";
    if (ctsItemPresent) t << "Contents file=" + hhcFileName + "\n";
    t << "Default Window=main\n"
         "Default topic=" << indexName << "\n";
    if (hhkPresent) t << "Index file=" + hhkFileName + "\n";
    t << "Language=" << theTranslator->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 << "\n";
    }
    for (auto &s : imageFiles)
    {
      t << s << "\n";
    }
    for (auto &s : styleFiles)
    {
      t << s << "\n";
    }
    t.close();
  }
  else
  {
    err("Could not open file {} for writing\n",fName);
  }
}

References Config_getBool, Config_getString, ctsItemPresent, err, HtmlHelp::hhcFileName, HtmlHelp::hhkFileName, HtmlHelp::hhpFileName, Doxygen::htmlFileExtension, imageFiles, index, indexFiles, Portable::openOutputStream(), recoder, styleFiles, and theTranslator.

Member Data Documentation

cts

std::ofstream HtmlHelp::Private::cts

Definition at line 340 of file htmlhelp.cpp.

ctsItemPresent

bool HtmlHelp::Private::ctsItemPresent = false

Definition at line 343 of file htmlhelp.cpp.

Referenced by createProjectFile().

dc

int HtmlHelp::Private::dc = 0

Definition at line 344 of file htmlhelp.cpp.

imageFiles

StringSet HtmlHelp::Private::imageFiles

Definition at line 346 of file htmlhelp.cpp.

Referenced by createProjectFile().

index

HtmlHelpIndex HtmlHelp::Private::index

Definition at line 349 of file htmlhelp.cpp.

Referenced by createProjectFile(), and Private().

indexFiles

StringSet HtmlHelp::Private::indexFiles

Definition at line 345 of file htmlhelp.cpp.

Referenced by createProjectFile().

kts

std::ofstream HtmlHelp::Private::kts

Definition at line 340 of file htmlhelp.cpp.

prevAnc

QCString HtmlHelp::Private::prevAnc

Definition at line 342 of file htmlhelp.cpp.

prevFile

QCString HtmlHelp::Private::prevFile

Definition at line 341 of file htmlhelp.cpp.

recoder

HtmlHelpRecoder HtmlHelp::Private::recoder

Definition at line 348 of file htmlhelp.cpp.

Referenced by createProjectFile(), and Private().

styleFiles

StringSet HtmlHelp::Private::styleFiles

Definition at line 347 of file htmlhelp.cpp.

Referenced by createProjectFile().

---

The documentation for this class was generated from the following file:

• src/htmlhelp.cpp