ugh. Nesting the (per class) plugin sentries can require them to
[wxWidgets.git] / docs / latex / wx / hthlpdat.tex
index 672591c25b00ee254e5ea8513be7e1a114dbe371..c920f9fb07f9aa62314d266cdd562f065b7cbd9c 100644 (file)
@@ -5,19 +5,20 @@
 
 \section{\class{wxHtmlHelpData}}\label{wxhtmlhelpdata}
 
 
 \section{\class{wxHtmlHelpData}}\label{wxhtmlhelpdata}
 
-This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
+This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} 
 and \helpref{wxHtmlHelpFrame}{wxhtmlhelpframe} to access HTML help items.
 It is internal class and should not be used directly - except for the case 
 you're writing your own HTML help controller.
 
 and \helpref{wxHtmlHelpFrame}{wxhtmlhelpframe} to access HTML help items.
 It is internal class and should not be used directly - except for the case 
 you're writing your own HTML help controller.
 
-
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
 
 
-\latexignore{\rtfignore{\wxheading{Members}}}
+<wx/html/helpdata.h>
 
 
+\latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxHtmlHelpData::wxHtmlHelpData}\label{wxhtmlhelpdatawxhtmlhelpdata}
 
 
 \membersection{wxHtmlHelpData::wxHtmlHelpData}\label{wxhtmlhelpdatawxhtmlhelpdata}
 
@@ -25,7 +26,6 @@ you're writing your own HTML help controller.
 
 Constructor.
 
 
 Constructor.
 
-
 \membersection{wxHtmlHelpData::AddBook}\label{wxhtmlhelpdataaddbook}
 
 \func{bool}{AddBook}{\param{const wxString\& }{book}}
 \membersection{wxHtmlHelpData::AddBook}\label{wxhtmlhelpdataaddbook}
 
 \func{bool}{AddBook}{\param{const wxString\& }{book}}
@@ -35,21 +35,18 @@ that contains arbitrary number of .hhp projects (this zip file can have
 either .zip or .htb extension, htb stands for "html book").
 Returns success.
 
 either .zip or .htb extension, htb stands for "html book").
 Returns success.
 
-
 \membersection{wxHtmlHelpData::FindPageById}\label{wxhtmlhelpdatafindpagebyid}
 
 \func{wxString}{FindPageById}{\param{int }{id}}
 
 Returns page's URL based on integer ID stored in project.
 
 \membersection{wxHtmlHelpData::FindPageById}\label{wxhtmlhelpdatafindpagebyid}
 
 \func{wxString}{FindPageById}{\param{int }{id}}
 
 Returns page's URL based on integer ID stored in project.
 
-
 \membersection{wxHtmlHelpData::FindPageByName}\label{wxhtmlhelpdatafindpagebyname}
 
 \func{wxString}{FindPageByName}{\param{const wxString\& }{page}}
 
 Returns page's URL based on its (file)name.
 
 \membersection{wxHtmlHelpData::FindPageByName}\label{wxhtmlhelpdatafindpagebyname}
 
 \func{wxString}{FindPageByName}{\param{const wxString\& }{page}}
 
 Returns page's URL based on its (file)name.
 
-
 \membersection{wxHtmlHelpData::GetBookRecArray}\label{wxhtmlhelpdatagetbookrecarray}
 
 \func{const wxHtmlBookRecArray\&}{GetBookRecArray}{\void}
 \membersection{wxHtmlHelpData::GetBookRecArray}\label{wxhtmlhelpdatagetbookrecarray}
 
 \func{const wxHtmlBookRecArray\&}{GetBookRecArray}{\void}
@@ -80,26 +77,6 @@ Returns pointer to index items list.
 
 Returns size of index list.
 
 
 Returns size of index list.
 
-\membersection{wxHtmlHelpData::LoadCachedBook}\label{wxhtmlhelpdataloadcachedbook}
-
-\func{bool}{LoadCachedBook}{\param{wxHtmlBookRecord* }{book}, \param{wxInputStream* }{f}}
-
-Reads binary cached book.
-
-
-\membersection{wxHtmlHelpData::LoadMSProject}\label{wxhtmlhelpdataloadmsproject}
-
-\func{bool}{LoadMSProject}{\param{wxHtmlBookRecord* }{book}, \param{wxFileSystem\& }{fsys}, \param{const wxString\& }{indexfile}, \param{const wxString\& }{contentsfile}}
-
-Imports .hhp files (MS HTML Help Workshop).
-
-\membersection{wxHtmlHelpData::SaveCachedBook}\label{wxhtmlhelpdatasavecachedbook}
-
-\func{bool}{SaveCachedBook}{\param{wxHtmlBookRecord* }{book}, \param{wxOutputStream* }{f}}
-
-Saves binary cached book. (Internal - this methods is used automatically
-if you call SetTempDir!)
-
 \membersection{wxHtmlHelpData::SetTempDir}\label{wxhtmlhelpdatasettempdir}
 
 \func{void}{SetTempDir}{\param{const wxString\& }{path}}
 \membersection{wxHtmlHelpData::SetTempDir}\label{wxhtmlhelpdatasettempdir}
 
 \func{void}{SetTempDir}{\param{const wxString\& }{path}}