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