X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/576507e276a32bccda610ce0e45451e6a46e4d31..90e7e2775fbb7979a48e568ffb177dde91276ce3:/docs/latex/wx/hthlpfrm.tex diff --git a/docs/latex/wx/hthlpfrm.tex b/docs/latex/wx/hthlpfrm.tex index abdcb74baf..45cb90b3fb 100644 --- a/docs/latex/wx/hthlpfrm.tex +++ b/docs/latex/wx/hthlpfrm.tex @@ -46,7 +46,7 @@ user.} have a book icon. This is how Microsoft's HTML help viewer behaves.} \twocolitem{\windowstyle{wxHF\_ICONS\_FOLDER}}{Book nodes in contents pane have a book icon, book's sections have a folder icon. This is the default.} -\twocolitem{\windowstyle{wxHF\_ICONS\_BOOK_CHAPTER}}{Both book nodes and +\twocolitem{\windowstyle{wxHF\_ICONS\_BOOK\_CHAPTER}}{Both book nodes and nodes of top-level sections of a book (i.e. chapters) have a book icon, all other sections (sections, subsections, ...) have a folder icon.} \twocolitem{\windowstyle{wxHF\_DEFAULT\_STYLE}}{{\tt wxHF\_TOOLBAR | wxHF\_CONTENTS @@ -62,16 +62,20 @@ for parameters description. \membersection{wxHtmlHelpFrame::CreateContents}\label{wxhtmlhelpframecreatecontents} -\func{void}{CreateContents}{\param{bool }{show\_progress = FALSE}} +\func{void}{CreateContents}{\void} Creates contents panel. (May take some time.) +Protected. + \membersection{wxHtmlHelpFrame::CreateIndex}\label{wxhtmlhelpframecreateindex} -\func{void}{CreateIndex}{\param{bool }{show\_progress = FALSE}} +\func{void}{CreateIndex}{\void} Creates index panel. (May take some time.) +Protected. + \membersection{wxHtmlHelpFrame::CreateSearch}\label{wxhtmlhelpframecreatesearch} \func{void}{CreateSearch}{\void} @@ -121,9 +125,10 @@ Return wxHtmlHelpData object. \membersection{wxHtmlHelpFrame::KeywordSearch}\label{wxhtmlhelpframekeywordsearch} -\func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}} +\func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}, \param{wxHelpSearchMode }{mode = wxHELP\_SEARCH\_ALL}} -Search for given keyword. +Search for given keyword. Optionally it searches through the index (mode = +wxHELP\_SEARCH\_INDEX), default the content (mode = wxHELP\_SEARCH\_ALL). \membersection{wxHtmlHelpFrame::ReadCustomization}\label{wxhtmlhelpframereadcustomization} @@ -133,10 +138,12 @@ Reads user's settings for this frame (see \helpref{wxHtmlHelpController::ReadCus \membersection{wxHtmlHelpFrame::RefreshLists}\label{wxhtmlhelpframerefreshlists} -\func{void}{RefreshLists}{\param{bool }{show\_progress = FALSE}} +\func{void}{RefreshLists}{\void} Refresh all panels. This is necessary if a new book was added. +Protected. + \membersection{wxHtmlHelpFrame::SetTitleFormat}\label{wxhtmlhelpframesettitleformat} \func{void}{SetTitleFormat}{\param{const wxString\& }{format}}