]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/hthlpdat.tex
escape more underscores (we need a pre-commit check for those...)
[wxWidgets.git] / docs / latex / wx / hthlpdat.tex
index c920f9fb07f9aa62314d266cdd562f065b7cbd9c..4d1d51bf5bd8775c1d54ac498f10bb668036990b 100644 (file)
@@ -28,11 +28,11 @@ 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}
@@ -53,29 +53,17 @@ Returns page's URL based on its (file)name.
 
 Returns array with help books info.
 
-\membersection{wxHtmlHelpData::GetContents}\label{wxhtmlhelpdatagetcontents}
+\membersection{wxHtmlHelpData::GetContentsArray}\label{wxhtmlhelpdatagetcontentsarray}
 
-\func{wxHtmlContentsItem*}{GetContents}{\void}
+\func{const wxHtmlHelpDataItems\&}{GetContentsArray}{\void}
 
-Returns contents lists pointer.
+Returns reference to array with contents entries.
 
-\membersection{wxHtmlHelpData::GetContentsCnt}\label{wxhtmlhelpdatagetcontentscnt}
+\membersection{wxHtmlHelpData::GetIndexArray}\label{wxhtmlhelpdatagetindexarray}
 
-\func{int}{GetContentsCnt}{\void}
+\func{const wxHtmlHelpDataItems\&}{GetIndexArray}{\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.
+Returns reference to array with index entries.
 
 \membersection{wxHtmlHelpData::SetTempDir}\label{wxhtmlhelpdatasettempdir}