docs/latex/wx/hthlpfrm.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % helpfrm.h at 24/Oct/99 18:03:10
   4 %
   5
   6 \section{\class{wxHtmlHelpFrame}}\label{wxhtmlhelpframe}
   7
   8 This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
   9 to display help.
  10 It is an internal class and should not be used directly - except for the case
  11 when you're writing your own HTML help controller.
  12
  13 \wxheading{Derived from}
  14
  15 \helpref{wxFrame}{wxframe}
  16
  17 \wxheading{Include files}
  18
  19 <wx/html/helpfrm.h>
  20
  21 \latexignore{\rtfignore{\wxheading{Members}}}
  22
  23 \membersection{wxHtmlHelpFrame::wxHtmlHelpFrame}\label{wxhtmlhelpframewxhtmlhelpframe}
  24
  25 \func{}{wxHtmlHelpFrame}{\param{wxHtmlHelpData* }{data = NULL}}
  26
  27 \func{}{wxHtmlHelpFrame}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULTSTYLE}, \param{wxHtmlHelpData* }{data = NULL}}
  28
  29 Constructor.
  30
  31 {\it style} is combination of these flags:
  32
  33 \begin{twocollist}\itemsep=0pt
  34 \twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.}
  35 \twocolitem{\windowstyle{wxHF\_CONTENTS}}{Help frame has contents panel.}
  36 \twocolitem{\windowstyle{wxHF\_INDEX}}{Help frame has index panel.}
  37 \twocolitem{\windowstyle{wxHF\_SEARCH}}{Help frame has search panel.}
  38 \twocolitem{\windowstyle{wxHF\_BOOKMARKS}}{Help frame has bookmarks controls.}
  39 \twocolitem{\windowstyle{wxHF\_OPENFILES}}{Allow user to open arbitrary HTML document.}
  40 \twocolitem{\windowstyle{wxHF\_PRINT}}{Toolbar contains "print" button.}
  41 \end{twocollist}
  42
  43 \membersection{wxHtmlHelpFrame::Create}\label{wxhtmlhelpframecreate}
  44
  45 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULTSTYLE}}
  46
  47 Creates the frame.
  48
  49 {\it style} is combination of these flags:
  50
  51 \begin{twocollist}\itemsep=0pt
  52 \twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.}
  53 \twocolitem{\windowstyle{wxHF\_CONTENTS}}{Help frame has contents panel.}
  54 \twocolitem{\windowstyle{wxHF\_INDEX}}{Help frame has index panel.}
  55 \twocolitem{\windowstyle{wxHF\_SEARCH}}{Help frame has search panel.}
  56 \end{twocollist}
  57
  58 \membersection{wxHtmlHelpFrame::CreateContents}\label{wxhtmlhelpframecreatecontents}
  59
  60 \func{void}{CreateContents}{\param{bool }{show\_progress = FALSE}}
  61
  62 Creates contents panel. (May take some time.)
  63
  64 \membersection{wxHtmlHelpFrame::CreateIndex}\label{wxhtmlhelpframecreateindex}
  65
  66 \func{void}{CreateIndex}{\param{bool }{show\_progress = FALSE}}
  67
  68 Creates index panel. (May take some time.)
  69
  70 \membersection{wxHtmlHelpFrame::CreateSearch}\label{wxhtmlhelpframecreatesearch}
  71
  72 \func{void}{CreateSearch}{\void}
  73
  74 Creates search panel.
  75
  76 \membersection{wxHtmlHelpFrame::Display}\label{wxhtmlhelpframedisplay}
  77
  78 \func{bool}{Display}{\param{const wxString\& }{x}}
  79
  80 \func{bool}{Display}{\param{const int }{id}}
  81
  82 Displays page x. If not found it will give the user the choice of
  83 searching books.
  84 Looking for the page runs in these steps:
  85
  86 \begin{enumerate}\itemsep=0pt
  87 \item try to locate file named x (if x is for example "doc/howto.htm")
  88 \item try to open starting page of book x
  89 \item try to find x in contents (if x is for example "How To ...")
  90 \item try to find x in index (if x is for example "How To ...")
  91 \end{enumerate}
  92
  93 The second form takes numeric ID as the parameter.
  94 (uses extension to MS format, <param name="ID" value=id>)
  95
  96 \pythonnote{The second form of this method is named DisplayId in
  97 wxPython.}
  98
  99 \membersection{wxHtmlHelpFrame::DisplayContents}\label{wxhtmlhelpframedisplaycontents}
 100
 101 \func{bool}{DisplayContents}{\void}
 102
 103 Displays contents panel.
 104
 105 \membersection{wxHtmlHelpFrame::DisplayIndex}\label{wxhtmlhelpframedisplayindex}
 106
 107 \func{bool}{DisplayIndex}{\void}
 108
 109 Displays index panel.
 110
 111 \membersection{wxHtmlHelpFrame::GetData}\label{wxhtmlhelpframegetdata}
 112
 113 \func{wxHtmlHelpData*}{GetData}{\void}
 114
 115 Return wxHtmlHelpData object.
 116
 117 \membersection{wxHtmlHelpFrame::KeywordSearch}\label{wxhtmlhelpframekeywordsearch}
 118
 119 \func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}}
 120
 121 Search for given keyword.
 122
 123 \membersection{wxHtmlHelpFrame::ReadCustomization}\label{wxhtmlhelpframereadcustomization}
 124
 125 \func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
 126
 127 Reads user's settings for this frame (see \helpref{wxHtmlHelpController::ReadCustomization}{wxhtmlhelpcontrollerreadcustomization})
 128
 129 \membersection{wxHtmlHelpFrame::RefreshLists}\label{wxhtmlhelpframerefreshlists}
 130
 131 \func{void}{RefreshLists}{\param{bool }{show\_progress = FALSE}}
 132
 133 Refresh all panels. This is necessary if a new book was added.
 134
 135 \membersection{wxHtmlHelpFrame::SetTitleFormat}\label{wxhtmlhelpframesettitleformat}
 136
 137 \func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
 138
 139 Sets the frame's title format. {\it format} must contain exactly one "\%s"
 140 (it will be replaced by the page title).
 141
 142 \membersection{wxHtmlHelpFrame::UseConfig}\label{wxhtmlhelpframeuseconfig}
 143
 144 \func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}}
 145
 146 Add books to search choice panel.
 147
 148 \membersection{wxHtmlHelpFrame::WriteCustomization}\label{wxhtmlhelpframewritecustomization}
 149
 150 \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
 151
 152 Saves user's settings for this frame (see \helpref{wxHtmlHelpController::WriteCustomization}{wxhtmlhelpcontrollerwritecustomization}).
 153
 154 \membersection{wxHtmlHelpFrame::AddToolbarButtons}\label{wxhtmlhelpframeaddtoolbarbuttons}
 155
 156 \func{virtual void}{AddToolbarButtons}{\param{wxToolBar *}{toolBar}, \param{int }{style}}
 157
 158 You may override this virtual method to add more buttons into help frame's
 159 toolbar. {\it toolBar} is a pointer to the toolbar and {\it style} is the style
 160 flag as passed to Create method.
 161
 162 wxToolBar::Realize is called immediately after returning from this function.
 163
 164 See {\it samples/html/helpview} for an example.
 165