X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/704a4b7524e05d7bf4d208eb1b30be9989abef4c..135ebb43cba169906a1bc14f7840b26c75ed4240:/docs/latex/wx/hthelpct.tex?ds=sidebyside diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex index 9f01de6a8e..01d37adc5c 100644 --- a/docs/latex/wx/hthelpct.tex +++ b/docs/latex/wx/hthelpct.tex @@ -3,10 +3,9 @@ % htmlhelp.h at 02/May/99 19:58:53 % - \section{\class{wxHtmlHelpController}}\label{wxhtmlhelpcontroller} -{\bf WARNING! This help controller has API incompatible with wxWindows +{\bf WARNING! This help controller has an API incompatible with wxWindows wxHelpController!} This help controller provides easy way how to display HTML help in your @@ -29,41 +28,18 @@ have following line in your .rc file: #include "wx/html/msw/wxhtml.rc" \end{verbatim} - \wxheading{Derived from} wxEvtHandler - \latexignore{\rtfignore{\wxheading{Members}}} - \membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller} \func{}{wxHtmlHelpController}{\void} - Constructor. - -\membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat} - -\func{void}{SetTitleFormat}{\param{const wxString\& }{format}} - -Sets format of title of the frame. Must contain exactly one "\%s" -(for title of displayed HTML page). - - -\membersection{wxHtmlHelpController::SetTempDir}\label{wxhtmlhelpcontrollersettempdir} - -\func{void}{SetTempDir}{\param{const wxString\& }{path}} - -Sets path for storing temporary files (cached binary versions of index and contents files. These binary -forms are much faster to read.) Default value is empty string (empty string means -that no cached data are stored). Note that these files are NOT -deleted when program exits! - - \membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook} \func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show_wait_msg}} @@ -73,7 +49,6 @@ This must be called at least once before displaying any help. If {\it show_wait_msg} is TRUE then a decorationless window with progress message is displayed. - \membersection{wxHtmlHelpController::Display}\label{wxhtmlhelpcontrollerdisplay} \func{void}{Display}{\param{const wxString\& }{x}} @@ -104,9 +79,6 @@ Looking for the page runs in these steps: This alternative form is used to search help contents by numeric IDs. - - - \membersection{wxHtmlHelpController::DisplayContents}\label{wxhtmlhelpcontrollerdisplaycontents} \func{void}{DisplayContents}{\void} @@ -119,7 +91,6 @@ Displays help window and focuses contents panel. Displays help window and focuses index panel. - \membersection{wxHtmlHelpController::KeywordSearch}\label{wxhtmlhelpcontrollerkeywordsearch} \func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}} @@ -130,6 +101,27 @@ Returns TRUE if the keyword was found. IMPORTANT! KeywordSearch searches only pages listed in .htc file(s)! (you should have all pages in contents file...) +\membersection{wxHtmlHelpController::ReadCustomization}\label{wxhtmlhelpcontrollerreadcustomization} + +\func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}} + +Reads controllers setting (position of window etc.) + +\membersection{wxHtmlHelpController::SetTempDir}\label{wxhtmlhelpcontrollersettempdir} + +\func{void}{SetTempDir}{\param{const wxString\& }{path}} + +Sets path for storing temporary files (cached binary versions of index and contents files. These binary +forms are much faster to read.) Default value is empty string (empty string means +that no cached data are stored). Note that these files are NOT +deleted when program exits! + +\membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat} + +\func{void}{SetTitleFormat}{\param{const wxString\& }{format}} + +Sets format of title of the frame. Must contain exactly one "\%s" +(for title of displayed HTML page). \membersection{wxHtmlHelpController::UseConfig}\label{wxhtmlhelpcontrolleruseconfig} @@ -142,14 +134,6 @@ reads and writes settings (including wxHtmlWindow's settings) when needed. The only thing you must do is create wxConfig object and call UseConfig. - -\membersection{wxHtmlHelpController::ReadCustomization}\label{wxhtmlhelpcontrollerreadcustomization} - -\func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}} - -Reads controllers setting (position of window etc.) - - \membersection{wxHtmlHelpController::WriteCustomization}\label{wxhtmlhelpcontrollerwritecustomization} \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}