2 % automatically generated by HelpGen from
3 % htmlwindow.tex at 14/Mar/99 20:13:37
6 \section{\class{wxHtmlWindow
}}\label{wxhtmlwindow
}
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).
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
},
18 \helpref{LoadPage(filename)
}{wxhtmlwindowloadpage
} or
19 \helpref{LoadFile
}{wxhtmlwindowloadfile
}.
23 wxHtmlWindow uses the
\helpref{wxImage
}{wximage
} class for displaying images.
24 Don't forget to initialize all image formats you need before loading any page!
25 (See
\helpref{wxInitAllImageHandlers
}{wxinitallimagehandlers
} and
26 \helpref{wxImage::AddHandler
}{wximageaddhandler
}.)
28 \wxheading{Derived from
}
30 \helpref{wxScrolledWindow
}{wxscrolledwindow
}
32 \wxheading{Include files
}
36 \wxheading{Window styles
}
39 \begin{twocollist
}\itemsep=
0pt
40 \twocolitem{\windowstyle{wxHW
\_SCROLLBAR\_NEVER}}{Never display scrollbars, not
41 even when the page is larger than the window.
}
42 \twocolitem{\windowstyle{wxHP
\_SCROLLBAR\_AUTO}}{Display scrollbars only if
43 page's size exceeds window's size.
}
44 \twocolitem{\windowstyle{wxHP
\_NO\_SELECTION}}{Don't allow the user to select
48 \membersection{wxHtmlWindow::wxHtmlWindow
}\label{wxhtmlwindowwxhtmlwindow
}
50 \func{}{wxHtmlWindow
}{\void}
54 \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"
}}
56 Constructor. The parameters are the same as for the
\helpref{wxScrolledWindow
}{wxscrolledwindow
} constructor.
58 \wxheading{Parameters
}
60 \docparam{style
}{Window style. See
\helpref{wxHtmlWindow
}{wxhtmlwindow
}.
}
62 \membersection{wxHtmlWindow::AddFilter
}\label{wxhtmlwindowaddfilter
}
64 \func{static void
}{AddFilter
}{\param{wxHtmlFilter
}{*filter
}}
66 Adds
\helpref{input filter
}{filters
} to the static list of available
67 filters. These filters are present by default:
69 \begin{itemize
}\itemsep=
0pt
70 \item {\tt text/html
} MIME type
71 \item {\tt image/*
} MIME types
72 \item Plain Text filter (this filter is used if no other filter matches)
75 \membersection{wxHtmlWindow::AppendToPage
}\label{wxhtmlwindowappendtopage
}
77 \func{bool
}{AppendToPage
}{\param{const wxString\&
}{source
}}
79 Appends HTML fragment to currently displayed text and refreshes the window.
81 \wxheading{Parameters
}
83 \docparam{source
}{HTML code fragment
}
85 \wxheading{Return value
}
87 false if an error occurred, true otherwise.
89 \membersection{wxHtmlWindow::GetInternalRepresentation
}\label{wxhtmlwindowgetinternalrepresentation
}
91 \constfunc{wxHtmlContainerCell*
}{GetInternalRepresentation
}{\void}
93 Returns pointer to the top-level container.
95 See also:
\helpref{Cells Overview
}{cells
},
96 \helpref{Printing Overview
}{printing
}
98 \membersection{wxHtmlWindow::GetOpenedAnchor
}\label{wxhtmlwindowgetopenedanchor
}
100 \func{wxString
}{GetOpenedAnchor
}{\void}
102 Returns anchor within currently opened page
103 (see
\helpref{GetOpenedPage
}{wxhtmlwindowgetopenedpage
}).
104 If no page is opened or if the displayed page wasn't
105 produced by call to LoadPage, empty string is returned.
108 \membersection{wxHtmlWindow::GetOpenedPage
}\label{wxhtmlwindowgetopenedpage
}
110 \func{wxString
}{GetOpenedPage
}{\void}
112 Returns full location of the opened page. If no page is opened or if the displayed page wasn't
113 produced by call to LoadPage, empty string is returned.
115 \membersection{wxHtmlWindow::GetOpenedPageTitle
}\label{wxhtmlwindowgetopenedpagetitle
}
117 \func{wxString
}{GetOpenedPageTitle
}{\void}
119 Returns title of the opened page or wxEmptyString if current page does not contain
{\tt <TITLE>
} tag.
121 \membersection{wxHtmlWindow::GetRelatedFrame
}\label{wxhtmlwindowgetrelatedframe
}
123 \constfunc{wxFrame*
}{GetRelatedFrame
}{\void}
125 Returns the related frame.
127 \membersection{wxHtmlWindow::HistoryBack
}\label{wxhtmlwindowhistoryback
}
129 \func{bool
}{HistoryBack
}{\void}
131 Moves back to the previous page. (each page displayed using
132 \helpref{LoadPage
}{wxhtmlwindowloadpage
} is stored in history list.)
134 \membersection{wxHtmlWindow::HistoryCanBack
}\label{wxhtmlwindowhistorycanback
}
136 \func{bool
}{HistoryCanBack
}{\void}
138 Returns true if it is possible to go back in the history (i.e. HistoryBack()
141 \membersection{wxHtmlWindow::HistoryCanForward
}\label{wxhtmlwindowhistorycanforward
}
143 \func{bool
}{HistoryCanForward
}{\void}
145 Returns true if it is possible to go forward in the history (i.e. HistoryBack()
149 \membersection{wxHtmlWindow::HistoryClear
}\label{wxhtmlwindowhistoryclear
}
151 \func{void
}{HistoryClear
}{\void}
155 \membersection{wxHtmlWindow::HistoryForward
}\label{wxhtmlwindowhistoryforward
}
157 \func{bool
}{HistoryForward
}{\void}
159 Moves to next page in history.
161 \membersection{wxHtmlWindow::LoadFile
}\label{wxhtmlwindowloadfile
}
163 \func{virtual bool
}{LoadFile
}{\param{const wxFileName\&
}{filename
}}
165 Loads HTML page from file and displays it.
167 \wxheading{Return value
}
169 false if an error occurred, true otherwise
173 \helpref{LoadPage
}{wxhtmlwindowloadpage
}
175 \membersection{wxHtmlWindow::LoadPage
}\label{wxhtmlwindowloadpage
}
177 \func{virtual bool
}{LoadPage
}{\param{const wxString\&
}{location
}}
179 Unlike SetPage this function first loads HTML page from
{\it location
}
180 and then displays it. See example:
183 htmlwin->LoadPage("help/myproject/index.htm");
186 \wxheading{Parameters
}
188 \docparam{location
}{The address of
document. See
\helpref{wxFileSystem
}{wxfilesystem
} for details on address format and behaviour of "opener".
}
190 \wxheading{Return value
}
192 false if an error occurred, true otherwise
196 \helpref{LoadFile
}{wxhtmlwindowloadfile
}
198 \membersection{wxHtmlWindow::OnCellClicked
}\label{wxhtmlwindowoncellclicked
}
200 \func{virtual void
}{OnCellClicked
}{\param{wxHtmlCell
}{*cell
},
\param{wxCoord
}{x
},
\param{wxCoord
}{y
},
\param{const wxMouseEvent\&
}{event
}}
202 This method is called when a mouse button is clicked inside wxHtmlWindow.
203 The default behaviour is to call
204 \helpref{OnLinkClicked
}{wxhtmlwindowonlinkclicked
} if the cell contains a
207 \wxheading{Parameters
}
209 \docparam{cell
}{The cell inside which the mouse was clicked, always a simple
210 (i.e. non container) cell
}
212 \docparam{x, y
}{The logical coordinates of the click point
}
214 \docparam{event
}{The mouse event containing other information about the click
}
216 \membersection{wxHtmlWindow::OnCellMouseHover
}\label{wxhtmlwindowoncellmousehover
}
218 \func{virtual void
}{OnCellMouseHover
}{\param{wxHtmlCell
}{*cell
},
\param{wxCoord
}{x
},
\param{wxCoord
}{y
}}
220 This method is called when a mouse moves over an HTML cell.
222 \wxheading{Parameters
}
224 \docparam{cell
}{The cell inside which the mouse is currently, always a simple
225 (i.e. non container) cell
}
227 \docparam{x, y
}{The logical coordinates of the click point
}
229 \membersection{wxHtmlWindow::OnLinkClicked
}\label{wxhtmlwindowonlinkclicked
}
231 \func{virtual void
}{OnLinkClicked
}{\param{const wxHtmlLinkInfo\&
}{link
}}
233 Called when user clicks on hypertext link. Default behaviour is to call
234 \helpref{LoadPage
}{wxhtmlwindowloadpage
} and do nothing else.
236 Also see
\helpref{wxHtmlLinkInfo
}{wxhtmllinkinfo
}.
238 \membersection{wxHtmlWindow::OnOpeningURL
}\label{wxhtmlwindowonopeningurl
}
240 \func{virtual wxHtmlOpeningStatus
}{OnOpeningURL
}{\param{wxHtmlURLType
}{type
},
\param{const wxString\&
}{url
},
\param{wxString *
}{redirect
}}
242 Called when an URL is being opened (either when the user clicks on a link or
243 an image is loaded). The URL will be opened only if OnOpeningURL returns
244 {\tt wxHTML
\_OPEN}. This method is called by
245 \helpref{wxHtmlParser::OpenURL
}{wxhtmlparseropenurl
}.
246 You can override OnOpeningURL to selectively block some
247 URLs (e.g. for security reasons) or to redirect them elsewhere. Default
248 behaviour is to always return
{\tt wxHTML
\_OPEN}.
250 \wxheading{Parameters
}
252 \docparam{type
}{Indicates type of the resource. Is one of
253 \begin{twocollist
}\itemsep=
0pt
254 \twocolitem{{\bf wxHTML
\_URL\_PAGE}}{Opening a HTML page.
}
255 \twocolitem{{\bf wxHTML
\_URL\_IMAGE}}{Opening an image.
}
256 \twocolitem{{\bf wxHTML
\_URL\_OTHER}}{Opening a resource that doesn't fall into
260 \docparam{url
}{URL being opened.
}
262 \docparam{redirect
}{Pointer to wxString variable that must be filled with an
263 URL if OnOpeningURL returns
{\tt wxHTML
\_REDIRECT}.
}
265 \wxheading{Return value
}
266 \begin{twocollist
}\itemsep=
0pt
267 \twocolitem{{\bf wxHTML
\_OPEN}}{Open the URL.
}
268 \twocolitem{{\bf wxHTML
\_BLOCK}}{Deny access to the URL,
\helpref{wxHtmlParser::OpenURL
}{wxhtmlparseropenurl
} will return NULL.
}
269 \twocolitem{{\bf wxHTML
\_REDIRECT}}{Don't open
{\it url
}, redirect to another
270 URL. OnOpeningURL must fill
{\it *redirect
} with the new URL. OnOpeningURL will
271 be called again on returned URL.
}
274 \membersection{wxHtmlWindow::OnSetTitle
}\label{wxhtmlwindowonsettitle
}
276 \func{virtual void
}{OnSetTitle
}{\param{const wxString\&
}{title
}}
278 Called on parsing
{\tt <TITLE>
} tag.
281 \membersection{wxHtmlWindow::ReadCustomization
}\label{wxhtmlwindowreadcustomization
}
283 \func{virtual void
}{ReadCustomization
}{\param{wxConfigBase
}{*cfg
},
\param{wxString
}{path = wxEmptyString
}}
285 This reads custom settings from wxConfig. It uses the path 'path'
286 if given, otherwise it saves info into currently selected path.
287 The values are stored in sub-path
{\tt wxHtmlWindow
}
289 Read values: all things set by SetFonts, SetBorders.
291 \wxheading{Parameters
}
293 \docparam{cfg
}{wxConfig from which you want to read the configuration.
}
295 \docparam{path
}{Optional path in config tree. If not given current path is used.
}
297 \membersection{wxHtmlWindow::SelectAll
}\label{wxhtmlwindowselectall
}
299 \func{void
}{SelectAll
}{\void}
301 Selects all text in the window.
305 \helpref{SelectLine
}{wxhtmlwindowselectline
},
306 \helpref{SelectWord
}{wxhtmlwindowselectword
}
308 \membersection{wxHtmlWindow::SelectLine
}\label{wxhtmlwindowselectline
}
310 \func{void
}{SelectLine
}{\param{const wxPoint\&
}{pos
}}
312 Selects the line of text that
\arg{pos
} points at. Note that
\arg{pos
}
313 is relative to the top of displayed page, not to window's origin, use
314 \helpref{CalcUnscrolledPosition
}{wxscrolledwindowcalcunscrolledposition
}
315 to convert physical coordinate.
319 \helpref{SelectAll
}{wxhtmlwindowselectall
},
320 \helpref{SelectWord
}{wxhtmlwindowselectword
}
322 \membersection{wxHtmlWindow::SelectWord
}\label{wxhtmlwindowselectword
}
324 \func{void
}{SelectWord
}{\param{const wxPoint\&
}{pos
}}
326 Selects the word at position
\arg{pos
}. Note that
\arg{pos
}
327 is relative to the top of displayed page, not to window's origin, use
328 \helpref{CalcUnscrolledPosition
}{wxscrolledwindowcalcunscrolledposition
}
329 to convert physical coordinate.
333 \helpref{SelectAll
}{wxhtmlwindowselectall
},
334 \helpref{SelectLine
}{wxhtmlwindowselectline
}
336 \membersection{wxHtmlWindow::SetBorders
}\label{wxhtmlwindowsetborders
}
338 \func{void
}{SetBorders
}{\param{int
}{b
}}
340 This function sets the space between border of window and HTML contents. See image:
342 \helponly{\image{}{border.bmp
}}
344 \wxheading{Parameters
}
346 \docparam{b
}{indentation from borders in pixels
}
348 \membersection{wxHtmlWindow::SetFonts
}\label{wxhtmlwindowsetfonts
}
350 \func{void
}{SetFonts
}{\param{wxString
}{normal
\_face},
\param{wxString
}{fixed
\_face},
\param{const int
}{*sizes = NULL
}}
352 This function sets font sizes and faces.
354 \wxheading{Parameters
}
356 \docparam{normal
\_face}{This is face name for normal (i.e. non-fixed) font.
357 It can be either empty string (then the default face is chosen) or
358 platform-specific face name. Examples are "helvetica" under Unix or
359 "Times New Roman" under Windows.
}
361 \docparam{fixed
\_face}{The same thing for fixed face ( <TT>..</TT> )
}
363 \docparam{sizes
}{This is an array of
7 items of
{\it int
} type.
364 The values represent size of font with HTML size from -
2 to +
4
365 ( <FONT SIZE=-
2> to <FONT SIZE=+
4> ). Default sizes are used if
{\it sizes
}
370 Default font sizes are defined by constants wxHTML
\_FONT\_SIZE\_1,
371 wxHTML
\_FONT\_SIZE\_2, ..., wxHTML
\_FONT\_SIZE\_7. Note that they differ among
372 platforms. Default face names are empty strings.
374 \membersection{wxHtmlWindow::SetPage
}\label{wxhtmlwindowsetpage
}
376 \func{bool
}{SetPage
}{\param{const wxString\&
}{source
}}
378 Sets HTML page and display it. This won't
{\bf load
} the page!!
379 It will display the
{\it source
}. See example:
382 htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
385 If you want to load a
document from some location use
386 \helpref{LoadPage
}{wxhtmlwindowloadpage
} instead.
388 \wxheading{Parameters
}
390 \docparam{source
}{The HTML
document source to be displayed.
}
392 \wxheading{Return value
}
394 false if an error occurred, true otherwise.
396 \membersection{wxHtmlWindow::SetRelatedFrame
}\label{wxhtmlwindowsetrelatedframe
}
398 \func{void
}{SetRelatedFrame
}{\param{wxFrame*
}{frame
},
\param{const wxString\&
}{format
}}
400 Sets the frame in which page title will be displayed.
{\it format
} is format of
401 frame title, e.g. "HtmlHelp : \%s". It must contain exactly one \%s. This
402 \%s is substituted with HTML page title.
404 \membersection{wxHtmlWindow::SetRelatedStatusBar
}\label{wxhtmlwindowsetrelatedstatusbar
}
406 \func{void
}{SetRelatedStatusBar
}{\param{int
}{bar
}}
408 {\bf After
} calling
\helpref{SetRelatedFrame
}{wxhtmlwindowsetrelatedframe
},
409 this sets statusbar slot where messages will be displayed.
410 (Default is -
1 = no messages.)
412 \wxheading{Parameters
}
414 \docparam{bar
}{statusbar slot number (
0..n)
}
417 \membersection{wxHtmlWindow::WriteCustomization
}\label{wxhtmlwindowwritecustomization
}
419 \func{virtual void
}{WriteCustomization
}{\param{wxConfigBase
}{*cfg
},
\param{wxString
}{path = wxEmptyString
}}
421 Saves custom settings into wxConfig. It uses the path 'path'
422 if given, otherwise it saves info into currently selected path.
423 Regardless of whether the path is given or not, the function creates sub-path
426 Saved values: all things set by SetFonts, SetBorders.
428 \wxheading{Parameters
}
430 \docparam{cfg
}{wxConfig to which you want to save the configuration.
}
432 \docparam{path
}{Optional path in config tree. If not given, the current path is used.
}