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