docs/latex/wx/htwindow.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % htmlwindow.tex at 14/Mar/99 20:13:37
   4 %
   5
   6 \section{\class{wxHtmlWindow}}\label{wxhtmlwindow}
   7
   8 wxHtmlWindow is probably the only class you will directly use
   9 unless you want to do something special (like adding new tag
  10 handlers or MIME filters).
  11
  12 The purpose of this class is to display HTML pages (either local
  13 file or downloaded via HTTP protocol) in a window. The width
  14 of the window is constant - given in the constructor - and virtual height
  15 is changed dynamically depending on page size.
  16 Once the window is created you can set its content by calling
  17 \helpref{SetPage(text)}{wxhtmlwindowsetpage} or
  18 \helpref{LoadPage(filename)}{wxhtmlwindowloadpage}.
  19
  20 \wxheading{Derived from}
  21
  22 \helpref{wxScrolledWindow}{wxscrolledwindow}
  23
  24 \wxheading{Include files}
  25
  26 <wx/html/htmlwin.h>
  27
  28 \membersection{wxHtmlWindow::wxHtmlWindow}\label{wxhtmlwindowwxhtmlwindow}
  29
  30 \func{}{wxHtmlWindow}{\void}
  31
  32 Default constructor.
  33
  34 \func{}{wxHtmlWindow}{\param{wxWindow }{*parent}, \param{wxWindowID }{id = -1}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxHW\_SCROLLBAR\_AUTO}, \param{const wxString\& }{name = "htmlWindow"}}
  35
  36 Constructor. The parameters are the same as for the \helpref{wxScrolledWindow}{wxscrolledwindow} constructor.
  37
  38 \wxheading{Parameters}
  39
  40 \docparam{style}{wxHW\_SCROLLBAR\_NEVER,  or wxHW\_SCROLLBAR\_AUTO.
  41 Affects the appearance of vertical scrollbar in the window.}
  42
  43 \membersection{wxHtmlWindow::AddFilter}\label{wxhtmlwindowaddfilter}
  44
  45 \func{static void}{AddFilter}{\param{wxHtmlFilter }{*filter}}
  46
  47 Adds \helpref{input filter}{filters} to the static list of available
  48 filters. These filters are present by default:
  49
  50 \begin{itemize}\itemsep=0pt
  51 \item {\tt text/html} MIME type
  52 \item {\tt image/*} MIME types
  53 \item Plain Text filter (this filter is used if no other filter matches)
  54 \end{itemize}
  55
  56 \membersection{wxHtmlWindow::GetInternalRepresentation}\label{wxhtmlwindowgetinternalrepresentation}
  57
  58 \constfunc{wxHtmlContainerCell*}{GetInternalRepresentation}{\void}
  59
  60 Returns pointer to the top-level container.
  61
  62 See also: \helpref{Cells Overview}{cells},
  63 \helpref{Printing Overview}{printing}
  64
  65 \membersection{wxHtmlWindow::GetOpenedAnchor}\label{wxhtmlwindowgetopenedanchor}
  66
  67 \func{wxString}{GetOpenedAnchor}{\void}
  68
  69 Returns anchor within currently opened page
  70 (see \helpref{GetOpenedPage}{wxhtmlwindowgetopenedpage}).
  71 If no page is opened or if the displayed page wasn't
  72 produced by call to LoadPage, empty string is returned.
  73
  74
  75 \membersection{wxHtmlWindow::GetOpenedPage}\label{wxhtmlwindowgetopenedpage}
  76
  77 \func{wxString}{GetOpenedPage}{\void}
  78
  79 Returns full location of the opened page. If no page is opened or if the displayed page wasn't
  80 produced by call to LoadPage, empty string is returned.
  81
  82 \membersection{wxHtmlWindow::GetOpenedPageTitle}\label{wxhtmlwindowgetopenedpagetitle}
  83
  84 \func{wxString}{GetOpenedPageTitle}{\void}
  85
  86 Returns title of the opened page or wxEmptyString if current page does not contain {\tt <TITLE>} tag.
  87
  88 \membersection{wxHtmlWindow::GetRelatedFrame}\label{wxhtmlwindowgetrelatedframe}
  89
  90 \constfunc{wxFrame*}{GetRelatedFrame}{\void}
  91
  92 Returns the related frame.
  93
  94 \membersection{wxHtmlWindow::HistoryBack}\label{wxhtmlwindowhistoryback}
  95
  96 \func{bool}{HistoryBack}{\void}
  97
  98 Moves back to the previous page. (each page displayed using
  99 \helpref{LoadPage}{wxhtmlwindowloadpage} is stored in history list.)
 100
 101 \membersection{wxHtmlWindow::HistoryCanBack}\label{wxhtmlwindowhistorycanback}
 102
 103 \func{bool}{HistoryCanBack}{\void}
 104
 105 Returns true if it is possible to go back in the history (i.e. HistoryBack()
 106 won't fail).
 107
 108 \membersection{wxHtmlWindow::HistoryCanForward}\label{wxhtmlwindowhistorycanforward}
 109
 110 \func{bool}{HistoryCanForward}{\void}
 111
 112 Returns true if it is possible to go forward in the history (i.e. HistoryBack()
 113 won't fail).
 114
 115
 116 \membersection{wxHtmlWindow::HistoryClear}\label{wxhtmlwindowhistoryclear}
 117
 118 \func{void}{HistoryClear}{\void}
 119
 120 Clears history.
 121
 122 \membersection{wxHtmlWindow::HistoryForward}\label{wxhtmlwindowhistoryforward}
 123
 124 \func{bool}{HistoryForward}{\void}
 125
 126 Moves to next page in history.
 127
 128 \membersection{wxHtmlWindow::LoadPage}\label{wxhtmlwindowloadpage}
 129
 130 \func{virtual bool}{LoadPage}{\param{const wxString\& }{location}}
 131
 132 Unlike SetPage this function first loads HTML page from {\it location}
 133 and then displays it. See example:
 134
 135 \begin{verbatim}
 136 htmlwin -> SetPage("help/myproject/index.htm");
 137 \end{verbatim}
 138
 139 \wxheading{Parameters}
 140
 141 \docparam{location}{The address of document. See \helpref{wxFileSystem}{wxfilesystem} for details on address format and behaviour of "opener".}
 142
 143 \wxheading{Return value}
 144
 145 FALSE if an error occurred, TRUE otherwise
 146
 147 \membersection{wxHtmlWindow::OnCellClicked}\label{wxhtmlwindowoncellclicked}
 148
 149 \func{virtual void}{OnCellClicked}{\param{wxHtmlCell }{*cell}, \param{wxCoord }{x}, \param{wxCoord }{y}, \param{const wxMouseEvent\& }{event}}
 150
 151 This method is called when a mouse button is clicked inside wxHtmlWindow.
 152 The default behaviour is to call
 153 \helpref{OnLinkClicked}{wxhtmlwindowonlinkclicked} if the cell contains a
 154 hypertext link.
 155
 156 \wxheading{Parameters}
 157
 158 \docparam{cell}{The cell inside which the mouse was clicked, always a simple
 159 (i.e. non container) cell}
 160
 161 \docparam{x, y}{The logical coordinates of the click point}
 162
 163 \docparam{event}{The mouse event containing other information about the click}
 164
 165 \membersection{wxHtmlWindow::OnCellMouseHover}\label{wxhtmlwindowoncellmousehover}
 166
 167 \func{virtual void}{OnCellMouseHover}{\param{wxHtmlCell }{*cell}, \param{wxCoord }{x}, \param{wxCoord }{y}}
 168
 169 This method is called when a mouse moves over an HTML cell.
 170
 171 \wxheading{Parameters}
 172
 173 \docparam{cell}{The cell inside which the mouse is currently, always a simple
 174 (i.e. non container) cell}
 175
 176 \docparam{x, y}{The logical coordinates of the click point}
 177
 178 \membersection{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked}
 179
 180 \func{virtual void}{OnLinkClicked}{\param{const wxHtmlLinkInfo\& }{link}}
 181
 182 Called when user clicks on hypertext link. Default behaviour is to call
 183 \helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else.
 184
 185 Also see \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}.
 186
 187
 188 \membersection{wxHtmlWindow::OnSetTitle}\label{wxhtmlwindowonsettitle}
 189
 190 \func{virtual void}{OnSetTitle}{\param{const wxString\& }{title}}
 191
 192 Called on parsing {\tt <TITLE>} tag.
 193
 194
 195 \membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization}
 196
 197 \func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
 198
 199 This reads custom settings from wxConfig. It uses the path 'path'
 200 if given, otherwise it saves info into currently selected path.
 201 The values are stored in sub-path {\tt wxHtmlWindow}
 202
 203 Read values: all things set by SetFonts, SetBorders.
 204
 205 \wxheading{Parameters}
 206
 207 \docparam{cfg}{wxConfig from which you want to read the configuration.}
 208
 209 \docparam{path}{Optional path in config tree. If not given current path is used.}
 210
 211 \membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders}
 212
 213 \func{void}{SetBorders}{\param{int }{b}}
 214
 215 This function sets the space between border of window and HTML contents. See image:
 216
 217 \helponly{\image{}{border.bmp}}
 218
 219 \wxheading{Parameters}
 220
 221 \docparam{b}{indentation from borders in pixels}
 222
 223 \membersection{wxHtmlWindow::SetFonts}\label{wxhtmlwindowsetfonts}
 224
 225 \func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{wxString }{fixed\_face}, \param{const int }{*sizes}}
 226
 227 This function sets font sizes and faces.
 228
 229 \wxheading{Parameters}
 230
 231 \docparam{normal\_face}{This is face name for normal (i.e. non-fixed) font.
 232 It can be either empty string (then the default face is choosen) or
 233 platform-specific face name. Examples are "helvetica" under Unix or
 234 "Times New Roman" under Windows.}
 235
 236 \docparam{fixed\_face}{The same thing for fixed face ( <TT>..</TT> )}
 237
 238 \docparam{sizes}{This is an array of 7 items of {\it int} type.
 239 The values represent size of font with HTML size from -2 to +4
 240 ( <FONT SIZE=-2> to <FONT SIZE=+4> )}
 241
 242 \wxheading{Defaults}
 243
 244 Under wxGTK:
 245
 246 \begin{verbatim}
 247     SetFonts("", "", {10, 12, 14, 16, 19, 24, 32});
 248 \end{verbatim}
 249
 250 Under Windows:
 251
 252 \begin{verbatim}
 253     SetFonts("", "", {7, 8, 10, 12, 16, 22, 30});
 254 \end{verbatim}
 255
 256 Athough it seems different the fact is that the fonts are of approximately
 257 same size under both platforms (due to wxMSW / wxGTK inconsistency)
 258
 259 \membersection{wxHtmlWindow::SetPage}\label{wxhtmlwindowsetpage}
 260
 261 \func{bool}{SetPage}{\param{const wxString\& }{source}}
 262
 263 Sets HTML page and display it. This won't {\bf load} the page!!
 264 It will display the {\it source}. See example:
 265
 266 \begin{verbatim}
 267 htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
 268 \end{verbatim}
 269
 270 If you want to load a document from some location use
 271 \helpref{LoadPage}{wxhtmlwindowloadpage} instead.
 272
 273 \wxheading{Parameters}
 274
 275 \docparam{source}{The HTML document source to be displayed.}
 276
 277 \wxheading{Return value}
 278
 279 FALSE if an error occurred, TRUE otherwise.
 280
 281 \membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe}
 282
 283 \func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}}
 284
 285 Sets the frame in which page title will be displayed. {\it format} is format of
 286 frame title, e.g. "HtmlHelp : \%s". It must contain exactly one \%s. This
 287 \%s is substituted with HTML page title.
 288
 289 \membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar}
 290
 291 \func{void}{SetRelatedStatusBar}{\param{int }{bar}}
 292
 293 {\bf After} calling \helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe},
 294 this sets statusbar slot where messages will be displayed.
 295 (Default is -1 = no messages.)
 296
 297 \wxheading{Parameters}
 298
 299 \docparam{bar}{statusbar slot number (0..n)}
 300
 301
 302 \membersection{wxHtmlWindow::WriteCustomization}\label{wxhtmlwindowwritecustomization}
 303
 304 \func{virtual void}{WriteCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
 305
 306 Saves custom settings into wxConfig. It uses the path 'path'
 307 if given, otherwise it saves info into currently selected path.
 308 Regardless of whether the path is given or not, the function creates sub-path
 309 {\tt wxHtmlWindow}.
 310
 311 Saved values: all things set by SetFonts, SetBorders.
 312
 313 \wxheading{Parameters}
 314
 315 \docparam{cfg}{wxConfig to which you want to save the configuration.}
 316
 317 \docparam{path}{Optional path in config tree. If not given, the current path is used.}
 318