Doxygen
|
A class that generated the HTML Help specific files. More...
#include <src/htmlhelp.h>
Classes | |
class | Private |
Public Member Functions | |
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 §ionAnchor, const QCString &title) |
void | addIndexFile (const QCString &name) |
void | addImageFile (const QCString &) |
void | addStyleSheetFile (const QCString &) |
Public Member Functions inherited from IndexIntf |
Static Public Attributes | |
static const QCString | hhcFileName = "index.hhc" |
static const QCString | hhkFileName = "index.hhk" |
static const QCString | hhpFileName = "index.hhp" |
Private Types | |
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 Member Functions | |
QCString | recode (const QCString &s) |
Private Attributes | |
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).
Definition at line 35 of file htmlhelp.h.
|
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.
Definition at line 40 of file htmlhelp.h.
HtmlHelp::HtmlHelp | ( | ) |
Constructs an html object. The object has to be initialized before it can be used.
Definition at line 361 of file htmlhelp.cpp.
References p.
Referenced by ~HtmlHelp().
|
default |
References HtmlHelp().
|
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. |
Implements IndexIntf.
Definition at line 547 of file htmlhelp.cpp.
References addHtmlExtensionIfMissing(), BOOK_CLOSED, convertToHtml(), externalRef(), QCString::isEmpty(), p, TEXT, and TRUE.
|
virtual |
Implements IndexIntf.
Definition at line 627 of file htmlhelp.cpp.
References p, and QCString::str().
|
virtual |
Implements IndexIntf.
Definition at line 485 of file htmlhelp.cpp.
References p, and QCString::str().
|
virtual |
Implements IndexIntf.
Definition at line 602 of file htmlhelp.cpp.
References Definition::anchor(), MemberDef::argsString(), FALSE, Definition::getOutputFileBase(), QCString::isEmpty(), Definition::name(), p, TRUE, and word.
|
virtual |
Implements IndexIntf.
Definition at line 622 of file htmlhelp.cpp.
References p, and QCString::str().
|
virtual |
Decrease the level of the contents hierarchy. This will end the unnumber HTML list.
Implements IndexIntf.
Definition at line 530 of file htmlhelp.cpp.
References p.
|
virtual |
Finalizes the HTML help. This will finish and close the htmlhelp contents file and the htmlhelp index file.
Implements IndexIntf.
Definition at line 494 of file htmlhelp.cpp.
References p.
|
virtual |
Increase the level of the contents hierarchy. This will start a new unnumbered HTML list in contents file.
Implements IndexIntf.
Definition at line 519 of file htmlhelp.cpp.
References p.
|
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)
Implements IndexIntf.
Definition at line 369 of file htmlhelp.cpp.
References Config_getString, hhcFileName, hhkFileName, Portable::openOutputStream(), p, qPrint(), and term.
|
inlinestatic |
Definition at line 86 of file htmlhelp.h.
Referenced by HtmlHelp::Private::createProjectFile(), and initialize().
|
inlinestatic |
Definition at line 87 of file htmlhelp.h.
Referenced by HtmlHelp::Private::createProjectFile(), and initialize().
|
inlinestatic |
Definition at line 88 of file htmlhelp.h.
Referenced by HtmlHelp::Private::createProjectFile(), and runHtmlHelpCompiler().
|
private |
Definition at line 91 of file htmlhelp.h.
Referenced by addContentsItem(), addImageFile(), addIndexFile(), addIndexItem(), addStyleSheetFile(), decContentsDepth(), finalize(), HtmlHelp(), incContentsDepth(), and initialize().