X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2e2fd42aa79818809cc1483235d32e3b9cb4abf9..52ee226853ec422d1517de38a0fa76d866c37153:/docs/latex/wx/hthlpdat.tex diff --git a/docs/latex/wx/hthlpdat.tex b/docs/latex/wx/hthlpdat.tex index d02eac0de9..b92bb0e826 100644 --- a/docs/latex/wx/hthlpdat.tex +++ b/docs/latex/wx/hthlpdat.tex @@ -5,19 +5,20 @@ \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}}} + +\latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxHtmlHelpData::wxHtmlHelpData}\label{wxhtmlhelpdatawxhtmlhelpdata} @@ -25,31 +26,27 @@ 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}