X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9704b2509ac4fd7b9fccd5299e0b377accb2b59e..e63f19ba93dad9ffe386e442e86d38e07345df7b:/docs/latex/wx/hthlpdat.tex?ds=sidebyside diff --git a/docs/latex/wx/hthlpdat.tex b/docs/latex/wx/hthlpdat.tex index 4a5d7cc432..4d1d51bf5b 100644 --- a/docs/latex/wx/hthlpdat.tex +++ b/docs/latex/wx/hthlpdat.tex @@ -5,12 +5,11 @@ \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} @@ -21,67 +20,50 @@ you're writing your own HTML help controller. \latexignore{\rtfignore{\wxheading{Members}}} - \membersection{wxHtmlHelpData::wxHtmlHelpData}\label{wxhtmlhelpdatawxhtmlhelpdata} \func{}{wxHtmlHelpData}{\void} 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} +\membersection{wxHtmlHelpData::GetContentsArray}\label{wxhtmlhelpdatagetcontentsarray} -\func{wxHtmlContentsItem*}{GetIndex}{\void} +\func{const wxHtmlHelpDataItems\&}{GetContentsArray}{\void} -Returns pointer to index items list. +Returns reference to array with contents entries. -\membersection{wxHtmlHelpData::GetIndexCnt}\label{wxhtmlhelpdatagetindexcnt} +\membersection{wxHtmlHelpData::GetIndexArray}\label{wxhtmlhelpdatagetindexarray} -\func{int}{GetIndexCnt}{\void} +\func{const wxHtmlHelpDataItems\&}{GetIndexArray}{\void} -Returns size of index list. +Returns reference to array with index entries. \membersection{wxHtmlHelpData::SetTempDir}\label{wxhtmlhelpdatasettempdir}