added vendor display name (for consistency with app display name &c) (patch 1831303)

[wxWidgets.git] / docs / latex / wx / hthlpdat.tex

diff --git a/docs/latex/wx/hthlpdat.tex b/docs/latex/wx/hthlpdat.tex
index 672591c25b00ee254e5ea8513be7e1a114dbe371..0960c30245dd3bf9bb58a85c2d56f13318ece924 100644 (file)
--- a/docs/latex/wx/hthlpdat.tex
+++ b/docs/latex/wx/hthlpdat.tex
@@ -5,19 +5,24 @@
 
 \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.
 
-
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
 
-\latexignore{\rtfignore{\wxheading{Members}}}
+<wx/html/helpdata.h>
 
+\wxheading{Library}
+
+\helpref{wxHtml}{librarieslist}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxHtmlHelpData::wxHtmlHelpData}\label{wxhtmlhelpdatawxhtmlhelpdata}
 
@@ -25,80 +30,44 @@ you're writing your own HTML help controller.
 
 Constructor.
 
-
 \membersection{wxHtmlHelpData::AddBook}\label{wxhtmlhelpdataaddbook}
 
-\func{bool}{AddBook}{\param{const wxString\& }{book}}
+\func{bool}{AddBook}{\param{const wxString\& }{book\_url}}
 
-Adds new book. 'book' is location of HTML help project (hhp) or ZIP file
-that contains arbitrary number of .hhp projects (this zip file can have
-either .zip or .htb extension, htb stands for "html book").
+Adds new book. {\it book} is URL (not filename!) of HTML help project (hhp)
+or ZIP file that contains arbitrary number of .hhp projects (this zip
+file can have 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::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}
 
 Returns array with help books info.
 
-\membersection{wxHtmlHelpData::GetContents}\label{wxhtmlhelpdatagetcontents}
-
-\func{wxHtmlContentsItem*}{GetContents}{\void}
-
-Returns contents lists pointer.
-
-\membersection{wxHtmlHelpData::GetContentsCnt}\label{wxhtmlhelpdatagetcontentscnt}
-
-\func{int}{GetContentsCnt}{\void}
-
-Returns size of contents list.
-
-\membersection{wxHtmlHelpData::GetIndex}\label{wxhtmlhelpdatagetindex}
-
-\func{wxHtmlContentsItem*}{GetIndex}{\void}
-
-Returns pointer to index items list.
-
-\membersection{wxHtmlHelpData::GetIndexCnt}\label{wxhtmlhelpdatagetindexcnt}
-
-\func{int}{GetIndexCnt}{\void}
-
-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}
+\membersection{wxHtmlHelpData::GetContentsArray}\label{wxhtmlhelpdatagetcontentsarray}
 
-\func{bool}{LoadMSProject}{\param{wxHtmlBookRecord* }{book}, \param{wxFileSystem\& }{fsys}, \param{const wxString\& }{indexfile}, \param{const wxString\& }{contentsfile}}
+\func{const wxHtmlHelpDataItems\&}{GetContentsArray}{\void}
 
-Imports .hhp files (MS HTML Help Workshop).
+Returns reference to array with contents entries.
 
-\membersection{wxHtmlHelpData::SaveCachedBook}\label{wxhtmlhelpdatasavecachedbook}
+\membersection{wxHtmlHelpData::GetIndexArray}\label{wxhtmlhelpdatagetindexarray}
 
-\func{bool}{SaveCachedBook}{\param{wxHtmlBookRecord* }{book}, \param{wxOutputStream* }{f}}
+\func{const wxHtmlHelpDataItems\&}{GetIndexArray}{\void}
 
-Saves binary cached book. (Internal - this methods is used automatically
-if you call SetTempDir!)
+Returns reference to array with index entries.
 
 \membersection{wxHtmlHelpData::SetTempDir}\label{wxhtmlhelpdatasettempdir}