X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7b28757f5e64bac68d9b159240616fc4d9ad66bc..4948ebf3ffe886443ec61bbecd1d0d3b794dfee2:/docs/latex/wx/hthlpdat.tex?ds=inline diff --git a/docs/latex/wx/hthlpdat.tex b/docs/latex/wx/hthlpdat.tex index c920f9fb07..4d1d51bf5b 100644 --- a/docs/latex/wx/hthlpdat.tex +++ b/docs/latex/wx/hthlpdat.tex @@ -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}