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
} or
18 \helpref{LoadPage(filename)
}{wxhtmlwindowloadpage
}.
20 \wxheading{Derived from
}
24 \wxheading{Include files
}
28 \membersection{wxHtmlWindow::wxHtmlWindow
}\label{wxhtmlwindowwxhtmlwindow
}
30 \func{}{wxHtmlWindow
}{\void}
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"
}}
36 Constructor. The parameters are the same as for the
\helpref{wxScrolledWindow
}{wxscrolledwindow
} constructor.
38 \wxheading{Parameters
}
40 \docparam{style
}{wxHW
\_SCROLLBAR\_NEVER, or wxHW
\_SCROLLBAR\_AUTO.
41 Affects the appearance of vertical scrollbar in the window.
}
43 \membersection{wxHtmlWindow::AddFilter
}\label{wxhtmlwindowaddfilter
}
45 \func{static void
}{AddFilter
}{\param{wxHtmlFilter
}{*filter
}}
47 Adds
\helpref{input filter
}{filters
} to the static list of available
48 filters. These filters are present by default:
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)
56 \membersection{wxHtmlWindow::GetInternalRepresentation
}\label{wxhtmlwindowgetinternalrepresentation
}
58 \constfunc{wxHtmlContainerCell*
}{GetInternalRepresentation
}{\void}
60 Returns pointer to the top-level container.
62 See also:
\helpref{Cells Overview
}{cells
},
63 \helpref{Printing Overview
}{printing
}
65 \membersection{wxHtmlWindow::GetOpenedPage
}\label{wxhtmlwindowgetopenedpage
}
67 \func{wxString
}{GetOpenedPage
}{\void}
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.
72 \membersection{wxHtmlWindow::GetOpenedPageTitle
}\label{wxhtmlwindowgetopenedpagetitle
}
74 \func{wxString
}{GetOpenedPageTitle
}{\void}
76 Returns title of the opened page or wxEmptyString if current page does not contain
{\tt <TITLE>
} tag.
78 \membersection{wxHtmlWindow::GetRelatedFrame
}\label{wxhtmlwindowgetrelatedframe
}
80 \constfunc{wxFrame*
}{GetRelatedFrame
}{\void}
82 Returns the related frame.
84 \membersection{wxHtmlWindow::HistoryBack
}\label{wxhtmlwindowhistoryback
}
86 \func{bool
}{HistoryBack
}{\void}
88 Moves back to the previous page. (each page displayed using
89 \helpref{LoadPage
}{wxhtmlwindowloadpage
} is stored in history list.)
91 \membersection{wxHtmlWindow::HistoryClear
}\label{wxhtmlwindowhistoryclear
}
93 \func{void
}{HistoryClear
}{\void}
97 \membersection{wxHtmlWindow::HistoryForward
}\label{wxhtmlwindowhistoryforward
}
99 \func{bool
}{HistoryForward
}{\void}
101 Moves to next page in history.
103 \membersection{wxHtmlWindow::LoadPage
}\label{wxhtmlwindowloadpage
}
105 \func{bool
}{LoadPage
}{\param{const wxString\&
}{location
}}
107 Unlike SetPage this function first loads HTML page from
{\it location
}
108 and then displays it. See example:
111 htmlwin -> SetPage("help/myproject/index.htm");
114 \wxheading{Parameters
}
116 \docparam{location
}{The address of
document. See
\helpref{wxFileSystem
}{wxfilesystem
} for details on address format and behaviour of "opener".
}
118 \wxheading{Return value
}
120 FALSE if an error occured, TRUE otherwise
122 \membersection{wxHtmlWindow::OnLinkClicked
}\label{wxhtmlwindowonlinkclicked
}
124 \func{virtual void
}{OnLinkClicked
}{\param{const wxString\&
}{link
}}
126 Called when user clicks on hypertext link. Default behaviour is to call
127 \helpref{LoadPage
}{wxhtmlwindowloadpage
} and do nothing else.
130 \membersection{wxHtmlWindow::OnSetTitle
}\label{wxhtmlwindowonsettitle
}
132 \func{virtual void
}{OnSetTitle
}{\param{const wxString\&
}{title
}}
134 Called on parsing
{\tt <TITLE>
} tag.
137 \membersection{wxHtmlWindow::ReadCustomization
}\label{wxhtmlwindowreadcustomization
}
139 \func{virtual void
}{ReadCustomization
}{\param{wxConfigBase
}{*cfg
},
\param{wxString
}{path = wxEmptyString
}}
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
}
145 Read values: all things set by SetFonts, SetBorders.
147 \wxheading{Parameters
}
149 \docparam{cfg
}{wxConfig from which you want to read the configuration.
}
151 \docparam{path
}{Optional path in config tree. If not given current path is used.
}
153 \membersection{wxHtmlWindow::SetBorders
}\label{wxhtmlwindowsetborders
}
155 \func{void
}{SetBorders
}{\param{int
}{b
}}
157 This function sets the space between border of window and HTML contents. See image:
161 \wxheading{Parameters
}
163 \docparam{b
}{indentation from borders in pixels
}
165 \membersection{wxHtmlWindow::SetFonts
}\label{wxhtmlwindowsetfonts
}
167 \func{void
}{SetFonts
}{\param{wxString
}{normal
\_face},
\param{wxString
}{fixed
\_face},
\param{const int
}{*sizes
}}
169 This function sets font sizes and faces.
171 \wxheading{Parameters
}
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.
}
178 \docparam{fixed
\_face}{The same thing for fixed face ( <TT>..</TT> )
}
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> )
}
189 SetFonts("", "",
{10,
12,
14,
16,
19,
24,
32});
195 SetFonts("", "",
{7,
8,
10,
12,
16,
22,
30});
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)
201 \membersection{wxHtmlWindow::SetPage
}\label{wxhtmlwindowsetpage
}
203 \func{bool
}{SetPage
}{\param{const wxString\&
}{source
}}
205 Sets HTML page and display it. This won't
{\bf load
} the page!!
206 It will display the
{\it source
}. See example:
209 htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
212 If you want to load a
document from some location use
213 \helpref{LoadPage
}{wxhtmlwindowloadpage
} instead.
215 \wxheading{Parameters
}
217 \docparam{source
}{The HTML
document source to be displayed.
}
219 \wxheading{Return value
}
221 FALSE if an error occured, TRUE otherwise.
223 \membersection{wxHtmlWindow::SetRelatedFrame
}\label{wxhtmlwindowsetrelatedframe
}
225 \func{void
}{SetRelatedFrame
}{\param{wxFrame*
}{frame
},
\param{const wxString\&
}{format
}}
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.
231 \membersection{wxHtmlWindow::SetRelatedStatusBar
}\label{wxhtmlwindowsetrelatedstatusbar
}
233 \func{void
}{SetRelatedStatusBar
}{\param{int
}{bar
}}
235 {\bf After
} calling
\helpref{SetRelatedFrame
}{wxhtmlwindowsetrelatedframe
},
236 this sets statusbar slot where messages will be displayed.
237 (Default is -
1 = no messages.)
239 \wxheading{Parameters
}
241 \docparam{bar
}{statusbar slot number (
0..n)
}
244 \membersection{wxHtmlWindow::WriteCustomization
}\label{wxhtmlwindowwritecustomization
}
246 \func{virtual void
}{WriteCustomization
}{\param{wxConfigBase
}{*cfg
},
\param{wxString
}{path = wxEmptyString
}}
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
253 Saved values: all things set by SetFonts, SetBorders.
255 \wxheading{Parameters
}
257 \docparam{cfg
}{wxConfig to which you want to save the configuration.
}
259 \docparam{path
}{Optional path in config tree. If not given, the current path is used.
}