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::HistoryClear}\label{wxhtmlwindowhistoryclear}
 102
 103 \func{void}{HistoryClear}{\void}
 104
 105 Clears history.
 106
 107 \membersection{wxHtmlWindow::HistoryForward}\label{wxhtmlwindowhistoryforward}
 108
 109 \func{bool}{HistoryForward}{\void}
 110
 111 Moves to next page in history.
 112
 113 \membersection{wxHtmlWindow::LoadPage}\label{wxhtmlwindowloadpage}
 114
 115 \func{bool}{LoadPage}{\param{const wxString\& }{location}}
 116
 117 Unlike SetPage this function first loads HTML page from {\it location}
 118 and then displays it. See example:
 119
 120 \begin{verbatim}
 121 htmlwin -> SetPage("help/myproject/index.htm");
 122 \end{verbatim}
 123
 124 \wxheading{Parameters}
 125
 126 \docparam{location}{The address of document. See \helpref{wxFileSystem}{wxfilesystem} for details on address format and behaviour of "opener".}
 127
 128 \wxheading{Return value}
 129
 130 FALSE if an error occurred, TRUE otherwise
 131
 132 \membersection{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked}
 133
 134 \func{virtual void}{OnLinkClicked}{\param{const wxHtmlLinkInfo\& }{link}}
 135
 136 Called when user clicks on hypertext link. Default behaviour is to call
 137 \helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else.
 138
 139 Also see \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}.
 140
 141
 142 \membersection{wxHtmlWindow::OnSetTitle}\label{wxhtmlwindowonsettitle}
 143
 144 \func{virtual void}{OnSetTitle}{\param{const wxString\& }{title}}
 145
 146 Called on parsing {\tt <TITLE>} tag.
 147
 148
 149 \membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization}
 150
 151 \func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
 152
 153 This reads custom settings from wxConfig. It uses the path 'path'
 154 if given, otherwise it saves info into currently selected path.
 155 The values are stored in sub-path {\tt wxHtmlWindow}
 156
 157 Read values: all things set by SetFonts, SetBorders.
 158
 159 \wxheading{Parameters}
 160
 161 \docparam{cfg}{wxConfig from which you want to read the configuration.}
 162
 163 \docparam{path}{Optional path in config tree. If not given current path is used.}
 164
 165 \membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders}
 166
 167 \func{void}{SetBorders}{\param{int }{b}}
 168
 169 This function sets the space between border of window and HTML contents. See image:
 170
 171 \helponly{\image{}{border.bmp}}
 172
 173 \wxheading{Parameters}
 174
 175 \docparam{b}{indentation from borders in pixels}
 176
 177 \membersection{wxHtmlWindow::SetFonts}\label{wxhtmlwindowsetfonts}
 178
 179 \func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{wxString }{fixed\_face}, \param{const int }{*sizes}}
 180
 181 This function sets font sizes and faces.
 182
 183 \wxheading{Parameters}
 184
 185 \docparam{normal\_face}{This is face name for normal (i.e. non-fixed) font.
 186 It can be either empty string (then the default face is choosen) or
 187 platform-specific face name. Examples are "helvetica" under Unix or
 188 "Times New Roman" under Windows.}
 189
 190 \docparam{fixed\_face}{The same thing for fixed face ( <TT>..</TT> )}
 191
 192 \docparam{sizes}{This is an array of 7 items of {\it int} type.
 193 The values represent size of font with HTML size from -2 to +4
 194 ( <FONT SIZE=-2> to <FONT SIZE=+4> )}
 195
 196 \wxheading{Defaults}
 197
 198 Under wxGTK:
 199
 200 \begin{verbatim}
 201     SetFonts("", "", {10, 12, 14, 16, 19, 24, 32});
 202 \end{verbatim}
 203
 204 Under Windows:
 205
 206 \begin{verbatim}
 207     SetFonts("", "", {7, 8, 10, 12, 16, 22, 30});
 208 \end{verbatim}
 209
 210 Athough it seems different the fact is that the fonts are of approximately
 211 same size under both platforms (due to wxMSW / wxGTK inconsistency)
 212
 213 \membersection{wxHtmlWindow::SetPage}\label{wxhtmlwindowsetpage}
 214
 215 \func{bool}{SetPage}{\param{const wxString\& }{source}}
 216
 217 Sets HTML page and display it. This won't {\bf load} the page!!
 218 It will display the {\it source}. See example:
 219
 220 \begin{verbatim}
 221 htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
 222 \end{verbatim}
 223
 224 If you want to load a document from some location use
 225 \helpref{LoadPage}{wxhtmlwindowloadpage} instead.
 226
 227 \wxheading{Parameters}
 228
 229 \docparam{source}{The HTML document source to be displayed.}
 230
 231 \wxheading{Return value}
 232
 233 FALSE if an error occurred, TRUE otherwise.
 234
 235 \membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe}
 236
 237 \func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}}
 238
 239 Sets the frame in which page title will be displayed. {\it format} is format of
 240 frame title, e.g. "HtmlHelp : \%s". It must contain exactly one \%s. This
 241 \%s is substituted with HTML page title.
 242
 243 \membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar}
 244
 245 \func{void}{SetRelatedStatusBar}{\param{int }{bar}}
 246
 247 {\bf After} calling \helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe},
 248 this sets statusbar slot where messages will be displayed.
 249 (Default is -1 = no messages.)
 250
 251 \wxheading{Parameters}
 252
 253 \docparam{bar}{statusbar slot number (0..n)}
 254
 255
 256 \membersection{wxHtmlWindow::WriteCustomization}\label{wxhtmlwindowwritecustomization}
 257
 258 \func{virtual void}{WriteCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
 259
 260 Saves custom settings into wxConfig. It uses the path 'path'
 261 if given, otherwise it saves info into currently selected path.
 262 Regardless of whether the path is given or not, the function creates sub-path
 263 {\tt wxHtmlWindow}.
 264
 265 Saved values: all things set by SetFonts, SetBorders.
 266
 267 \wxheading{Parameters}
 268
 269 \docparam{cfg}{wxConfig to which you want to save the configuration.}
 270
 271 \docparam{path}{Optional path in config tree. If not given, the current path is used.}
 272