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\_DEFAULT\_STYLE}, \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\_FLAT\_TOOLBAR}}{Help frame has toolbar with flat buttons (aka coolbar).}
  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\_OPEN\_FILES}}{Allow user to open arbitrary HTML document.}
  41 \twocolitem{\windowstyle{wxHF\_PRINT}}{Toolbar contains "print" button.}
  42 \twocolitem{\windowstyle{wxHF\_MERGE\_BOOKS}}{Contents pane does not show
  43 book nodes. All books are merged together and appear as single book to the
  44 user.}
  45 \twocolitem{\windowstyle{wxHF\_ICONS\_BOOK}}{All nodes in contents pane
  46 have a book icon. This is how Microsoft's HTML help viewer behaves.}
  47 \twocolitem{\windowstyle{wxHF\_ICONS\_FOLDER}}{Book nodes in contents pane have
  48 a book icon, book's sections have a folder icon. This is the default.}
  49 \twocolitem{\windowstyle{wxHF\_ICONS\_BOOK\_CHAPTER}}{Both book nodes and
  50 nodes of top-level sections of a book (i.e. chapters) have a book icon,
  51 all other sections (sections, subsections, ...) have a folder icon.}
  52 \twocolitem{\windowstyle{wxHF\_DEFAULT\_STYLE}}{{\tt wxHF\_TOOLBAR | wxHF\_CONTENTS
  53 | wxHF\_INDEX | wxHF\_SEARCH | wxHF\_BOOKMARKS | wxHF\_PRINT}}
  54 \end{twocollist}
  55
  56 \membersection{wxHtmlHelpFrame::Create}\label{wxhtmlhelpframecreate}
  57
  58 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULT\_STYLE}}
  59
  60 Creates the frame. See \helpref{the constructor}{wxhtmlhelpframewxhtmlhelpframe}
  61 for parameters description.
  62
  63 \membersection{wxHtmlHelpFrame::CreateContents}\label{wxhtmlhelpframecreatecontents}
  64
  65 \func{void}{CreateContents}{\param{bool }{show\_progress = false}}
  66
  67 Creates contents panel. (May take some time.)
  68
  69 \membersection{wxHtmlHelpFrame::CreateIndex}\label{wxhtmlhelpframecreateindex}
  70
  71 \func{void}{CreateIndex}{\param{bool }{show\_progress = false}}
  72
  73 Creates index panel. (May take some time.)
  74
  75 \membersection{wxHtmlHelpFrame::CreateSearch}\label{wxhtmlhelpframecreatesearch}
  76
  77 \func{void}{CreateSearch}{\void}
  78
  79 Creates search panel.
  80
  81 \membersection{wxHtmlHelpFrame::Display}\label{wxhtmlhelpframedisplay}
  82
  83 \func{bool}{Display}{\param{const wxString\& }{x}}
  84
  85 \func{bool}{Display}{\param{const int }{id}}
  86
  87 Displays page x. If not found it will give the user the choice of
  88 searching books.
  89 Looking for the page runs in these steps:
  90
  91 \begin{enumerate}\itemsep=0pt
  92 \item try to locate file named x (if x is for example "doc/howto.htm")
  93 \item try to open starting page of book x
  94 \item try to find x in contents (if x is for example "How To ...")
  95 \item try to find x in index (if x is for example "How To ...")
  96 \end{enumerate}
  97
  98 The second form takes numeric ID as the parameter.
  99 (uses extension to MS format, <param name="ID" value=id>)
 100
 101 \pythonnote{The second form of this method is named DisplayId in
 102 wxPython.}
 103
 104 \membersection{wxHtmlHelpFrame::DisplayContents}\label{wxhtmlhelpframedisplaycontents}
 105
 106 \func{bool}{DisplayContents}{\void}
 107
 108 Displays contents panel.
 109
 110 \membersection{wxHtmlHelpFrame::DisplayIndex}\label{wxhtmlhelpframedisplayindex}
 111
 112 \func{bool}{DisplayIndex}{\void}
 113
 114 Displays index panel.
 115
 116 \membersection{wxHtmlHelpFrame::GetData}\label{wxhtmlhelpframegetdata}
 117
 118 \func{wxHtmlHelpData*}{GetData}{\void}
 119
 120 Return wxHtmlHelpData object.
 121
 122 \membersection{wxHtmlHelpFrame::KeywordSearch}\label{wxhtmlhelpframekeywordsearch}
 123
 124 \func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}, \param{wxHelpSearchMode }{mode = wxHELP\_SEARCH\_ALL}}
 125
 126 Search for given keyword. Optionally it searches through the index (mode =
 127 wxHELP\_SEARCH\_INDEX), default the content (mode = wxHELP\_SEARCH\_ALL).
 128
 129 \membersection{wxHtmlHelpFrame::ReadCustomization}\label{wxhtmlhelpframereadcustomization}
 130
 131 \func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
 132
 133 Reads user's settings for this frame (see \helpref{wxHtmlHelpController::ReadCustomization}{wxhtmlhelpcontrollerreadcustomization})
 134
 135 \membersection{wxHtmlHelpFrame::RefreshLists}\label{wxhtmlhelpframerefreshlists}
 136
 137 \func{void}{RefreshLists}{\param{bool }{show\_progress = false}}
 138
 139 Refresh all panels. This is necessary if a new book was added.
 140
 141 \membersection{wxHtmlHelpFrame::SetTitleFormat}\label{wxhtmlhelpframesettitleformat}
 142
 143 \func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
 144
 145 Sets the frame's title format. {\it format} must contain exactly one "\%s"
 146 (it will be replaced by the page title).
 147
 148 \membersection{wxHtmlHelpFrame::UseConfig}\label{wxhtmlhelpframeuseconfig}
 149
 150 \func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}}
 151
 152 Add books to search choice panel.
 153
 154 \membersection{wxHtmlHelpFrame::WriteCustomization}\label{wxhtmlhelpframewritecustomization}
 155
 156 \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
 157
 158 Saves user's settings for this frame (see \helpref{wxHtmlHelpController::WriteCustomization}{wxhtmlhelpcontrollerwritecustomization}).
 159
 160 \membersection{wxHtmlHelpFrame::AddToolbarButtons}\label{wxhtmlhelpframeaddtoolbarbuttons}
 161
 162 \func{virtual void}{AddToolbarButtons}{\param{wxToolBar *}{toolBar}, \param{int }{style}}
 163
 164 You may override this virtual method to add more buttons into help frame's
 165 toolbar. {\it toolBar} is a pointer to the toolbar and {\it style} is the style
 166 flag as passed to Create method.
 167
 168 wxToolBar::Realize is called immediately after returning from this function.
 169
 170 See {\it samples/html/helpview} for an example.
 171