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
}\\
31 \helpref{wxPanel
}{wxpanel
}\\
32 \helpref{wxWindow
}{wxwindow
}\\
33 \helpref{wxEvtHandler
}{wxevthandler
}\\
34 \helpref{wxObject
}{wxobject
}
36 \wxheading{Include files
}
42 \helpref{wxHtml
}{librarieslist
}
44 \wxheading{Window styles
}
47 \begin{twocollist
}\itemsep=
0pt
48 \twocolitem{\windowstyle{wxHW
\_SCROLLBAR\_NEVER}}{Never display scrollbars, not
49 even when the page is larger than the window.
}
50 \twocolitem{\windowstyle{wxHW
\_SCROLLBAR\_AUTO}}{Display scrollbars only if
51 page's size exceeds window's size.
}
52 \twocolitem{\windowstyle{wxHW
\_NO\_SELECTION}}{Don't allow the user to select
57 \wxheading{Event handling
}
59 To process input from a wxHtmlWindow, use these event handler macros to direct input to member
60 functions that take a
\helpref{wxHtmlCellEvent
}{wxhtmlcellevent
} argument or a
\helpref{wxHtmlLinkEvent
}{wxhtmllinkevent
}.
63 \begin{twocollist
}\itemsep=
0pt
64 \twocolitem{{\bf EVT
\_HTML\_CELL\_CLICKED(id, func)
}}{A
\helpref{wxHtmlCell
}{wxhtmlcell
} was clicked.
}
65 \twocolitem{{\bf EVT
\_HTML\_CELL\_HOVER(id, func)
}}{The mouse passed over a
\helpref{wxHtmlCell
}{wxhtmlcell
}.
}
66 \twocolitem{{\bf EVT
\_HTML\_LINK\_CLICKED(id, func)
}}{A
\helpref{wxHtmlCell
}{wxhtmlcell
} which contains an hyperlink was clicked.
}
72 \helpref{wxHtmlLinkEvent
}{wxhtmllinkevent
},
\helpref{wxHtmlCellEvent
}{wxhtmlcellevent
}
76 \membersection{wxHtmlWindow::wxHtmlWindow
}\label{wxhtmlwindowwxhtmlwindow
}
78 \func{}{wxHtmlWindow
}{\void}
82 \func{}{wxHtmlWindow
}{\param{wxWindow
}{*parent
},
\param{wxWindowID
}{id = -
1},
\param{const wxPoint\&
}{pos = wxDefaultPosition
},
\param{const wxSize\&
}{size = wxDefaultSize
},
\param{long
}{style = wxHW
\_DEFAULT\_STYLE},
\param{const wxString\&
}{name = "htmlWindow"
}}
84 Constructor. The parameters are the same as for the
\helpref{wxScrolledWindow
}{wxscrolledwindow
} constructor.
86 \wxheading{Parameters
}
88 \docparam{style
}{Window style. See
\helpref{wxHtmlWindow
}{wxhtmlwindow
}.
}
90 \membersection{wxHtmlWindow::AddFilter
}\label{wxhtmlwindowaddfilter
}
92 \func{static void
}{AddFilter
}{\param{wxHtmlFilter
}{*filter
}}
94 Adds
\helpref{input filter
}{filters
} to the static list of available
95 filters. These filters are present by default:
97 \begin{itemize
}\itemsep=
0pt
98 \item {\tt text/html
} MIME type
99 \item {\tt image/*
} MIME types
100 \item Plain Text filter (this filter is used if no other filter matches)
103 \membersection{wxHtmlWindow::AppendToPage
}\label{wxhtmlwindowappendtopage
}
105 \func{bool
}{AppendToPage
}{\param{const wxString\&
}{source
}}
107 Appends HTML fragment to currently displayed text and refreshes the window.
109 \wxheading{Parameters
}
111 \docparam{source
}{HTML code fragment
}
113 \wxheading{Return value
}
115 false if an error occurred, true otherwise.
117 \membersection{wxHtmlWindow::GetInternalRepresentation
}\label{wxhtmlwindowgetinternalrepresentation
}
119 \constfunc{wxHtmlContainerCell*
}{GetInternalRepresentation
}{\void}
121 Returns pointer to the top-level container.
123 See also:
\helpref{Cells Overview
}{cells
},
124 \helpref{Printing Overview
}{printing
}
126 \membersection{wxHtmlWindow::GetOpenedAnchor
}\label{wxhtmlwindowgetopenedanchor
}
128 \func{wxString
}{GetOpenedAnchor
}{\void}
130 Returns anchor within currently opened page
131 (see
\helpref{GetOpenedPage
}{wxhtmlwindowgetopenedpage
}).
132 If no page is opened or if the displayed page wasn't
133 produced by call to LoadPage, empty string is returned.
136 \membersection{wxHtmlWindow::GetOpenedPage
}\label{wxhtmlwindowgetopenedpage
}
138 \func{wxString
}{GetOpenedPage
}{\void}
140 Returns full location of the opened page. If no page is opened or if the displayed page wasn't
141 produced by call to LoadPage, empty string is returned.
143 \membersection{wxHtmlWindow::GetOpenedPageTitle
}\label{wxhtmlwindowgetopenedpagetitle
}
145 \func{wxString
}{GetOpenedPageTitle
}{\void}
147 Returns title of the opened page or wxEmptyString if current page does not contain
{\tt <TITLE>
} tag.
149 \membersection{wxHtmlWindow::GetRelatedFrame
}\label{wxhtmlwindowgetrelatedframe
}
151 \constfunc{wxFrame*
}{GetRelatedFrame
}{\void}
153 Returns the related frame.
155 \membersection{wxHtmlWindow::HistoryBack
}\label{wxhtmlwindowhistoryback
}
157 \func{bool
}{HistoryBack
}{\void}
159 Moves back to the previous page. (each page displayed using
160 \helpref{LoadPage
}{wxhtmlwindowloadpage
} is stored in history list.)
162 \membersection{wxHtmlWindow::HistoryCanBack
}\label{wxhtmlwindowhistorycanback
}
164 \func{bool
}{HistoryCanBack
}{\void}
166 Returns true if it is possible to go back in the history (i.e. HistoryBack()
169 \membersection{wxHtmlWindow::HistoryCanForward
}\label{wxhtmlwindowhistorycanforward
}
171 \func{bool
}{HistoryCanForward
}{\void}
173 Returns true if it is possible to go forward in the history (i.e. HistoryBack()
177 \membersection{wxHtmlWindow::HistoryClear
}\label{wxhtmlwindowhistoryclear
}
179 \func{void
}{HistoryClear
}{\void}
183 \membersection{wxHtmlWindow::HistoryForward
}\label{wxhtmlwindowhistoryforward
}
185 \func{bool
}{HistoryForward
}{\void}
187 Moves to next page in history.
189 \membersection{wxHtmlWindow::LoadFile
}\label{wxhtmlwindowloadfile
}
191 \func{virtual bool
}{LoadFile
}{\param{const wxFileName\&
}{filename
}}
193 Loads HTML page from file and displays it.
195 \wxheading{Return value
}
197 false if an error occurred, true otherwise
201 \helpref{LoadPage
}{wxhtmlwindowloadpage
}
203 \membersection{wxHtmlWindow::LoadPage
}\label{wxhtmlwindowloadpage
}
205 \func{virtual bool
}{LoadPage
}{\param{const wxString\&
}{location
}}
207 Unlike SetPage this function first loads HTML page from
{\it location
}
208 and then displays it. See example:
211 htmlwin->LoadPage("help/myproject/index.htm");
214 \wxheading{Parameters
}
216 \docparam{location
}{The address of
document. See
\helpref{wxFileSystem
}{wxfilesystem
} for details on address format and behaviour of "opener".
}
218 \wxheading{Return value
}
220 false if an error occurred, true otherwise
224 \helpref{LoadFile
}{wxhtmlwindowloadfile
}
226 \membersection{wxHtmlWindow::OnCellClicked
}\label{wxhtmlwindowoncellclicked
}
228 \func{virtual bool
}{OnCellClicked
}{\param{wxHtmlCell
}{*cell
},
\param{wxCoord
}{x
},
\param{wxCoord
}{y
},
\param{const wxMouseEvent\&
}{event
}}
230 This method is called when a mouse button is clicked inside wxHtmlWindow.
232 The default behaviour is to emit a
\helpref{wxHtmlCellEvent
}{wxhtmlcellevent
}
233 and, if the event was not processed or skipped, call
234 \helpref{OnLinkClicked
}{wxhtmlwindowonlinkclicked
} if the cell contains an
237 Overloading this method is deprecated; intercept the event instead.
240 \wxheading{Parameters
}
242 \docparam{cell
}{The cell inside which the mouse was clicked, always a simple
243 (i.e. non-container) cell
}
245 \docparam{x, y
}{The logical coordinates of the click point
}
247 \docparam{event
}{The mouse event containing other information about the click
}
249 \wxheading{Return value
}
251 \true if a link was clicked,
\false otherwise.
253 \membersection{wxHtmlWindow::OnCellMouseHover
}\label{wxhtmlwindowoncellmousehover
}
255 \func{virtual void
}{OnCellMouseHover
}{\param{wxHtmlCell
}{*cell
},
\param{wxCoord
}{x
},
\param{wxCoord
}{y
}}
257 This method is called when a mouse moves over an HTML cell.
258 Default behaviour is to emit a
\helpref{wxHtmlCellEvent
}{wxhtmlcellevent
}.
259 Overloading this method is deprecated; intercept the event instead.
261 \wxheading{Parameters
}
263 \docparam{cell
}{The cell inside which the mouse is currently, always a simple
264 (i.e. non-container) cell
}
266 \docparam{x, y
}{The logical coordinates of the click point
}
268 \membersection{wxHtmlWindow::OnLinkClicked
}\label{wxhtmlwindowonlinkclicked
}
270 \func{virtual void
}{OnLinkClicked
}{\param{const wxHtmlLinkInfo\&
}{link
}}
272 Called when user clicks on hypertext link. Default behaviour is to emit a
273 \helpref{wxHtmlLinkEvent
}{wxhtmllinkevent
} and, if the event was not processed
274 or skipped, call
\helpref{LoadPage
}{wxhtmlwindowloadpage
} and do nothing else.
275 Overloading this method is deprecated; intercept the event instead.
277 Also see
\helpref{wxHtmlLinkInfo
}{wxhtmllinkinfo
}.
279 \membersection{wxHtmlWindow::OnOpeningURL
}\label{wxhtmlwindowonopeningurl
}
281 \func{virtual wxHtmlOpeningStatus
}{OnOpeningURL
}{\param{wxHtmlURLType
}{type
},
\param{const wxString\&
}{url
},
\param{wxString *
}{redirect
}}
283 Called when an URL is being opened (either when the user clicks on a link or
284 an image is loaded). The URL will be opened only if OnOpeningURL returns
285 {\tt wxHTML
\_OPEN}. This method is called by
286 \helpref{wxHtmlParser::OpenURL
}{wxhtmlparseropenurl
}.
287 You can override OnOpeningURL to selectively block some
288 URLs (e.g. for security reasons) or to redirect them elsewhere. Default
289 behaviour is to always return
{\tt wxHTML
\_OPEN}.
291 \wxheading{Parameters
}
293 \docparam{type
}{Indicates type of the resource. Is one of
294 \begin{twocollist
}\itemsep=
0pt
295 \twocolitem{{\bf wxHTML
\_URL\_PAGE}}{Opening a HTML page.
}
296 \twocolitem{{\bf wxHTML
\_URL\_IMAGE}}{Opening an image.
}
297 \twocolitem{{\bf wxHTML
\_URL\_OTHER}}{Opening a resource that doesn't fall into
301 \docparam{url
}{URL being opened.
}
303 \docparam{redirect
}{Pointer to wxString variable that must be filled with an
304 URL if OnOpeningURL returns
{\tt wxHTML
\_REDIRECT}.
}
306 \wxheading{Return value
}
307 \begin{twocollist
}\itemsep=
0pt
308 \twocolitem{{\bf wxHTML
\_OPEN}}{Open the URL.
}
309 \twocolitem{{\bf wxHTML
\_BLOCK}}{Deny access to the URL,
\helpref{wxHtmlParser::OpenURL
}{wxhtmlparseropenurl
} will return NULL.
}
310 \twocolitem{{\bf wxHTML
\_REDIRECT}}{Don't open
{\it url
}, redirect to another
311 URL. OnOpeningURL must fill
{\it *redirect
} with the new URL. OnOpeningURL will
312 be called again on returned URL.
}
315 \membersection{wxHtmlWindow::OnSetTitle
}\label{wxhtmlwindowonsettitle
}
317 \func{virtual void
}{OnSetTitle
}{\param{const wxString\&
}{title
}}
319 Called on parsing
{\tt <TITLE>
} tag.
322 \membersection{wxHtmlWindow::ReadCustomization
}\label{wxhtmlwindowreadcustomization
}
324 \func{virtual void
}{ReadCustomization
}{\param{wxConfigBase
}{*cfg
},
\param{wxString
}{path = wxEmptyString
}}
326 This reads custom settings from wxConfig. It uses the path 'path'
327 if given, otherwise it saves info into currently selected path.
328 The values are stored in sub-path
{\tt wxHtmlWindow
}
330 Read values: all things set by SetFonts, SetBorders.
332 \wxheading{Parameters
}
334 \docparam{cfg
}{wxConfig from which you want to read the configuration.
}
336 \docparam{path
}{Optional path in config tree. If not given current path is used.
}
338 \membersection{wxHtmlWindow::SelectAll
}\label{wxhtmlwindowselectall
}
340 \func{void
}{SelectAll
}{\void}
342 Selects all text in the window.
346 \helpref{SelectLine
}{wxhtmlwindowselectline
},
347 \helpref{SelectWord
}{wxhtmlwindowselectword
}
349 \membersection{wxHtmlWindow::SelectionToText
}\label{wxhtmlwindowselectiontotext
}
351 \func{wxString
}{SelectionToText
}{\void}
353 Returns current selection as plain text. Returns empty string if no text
354 is currently selected.
356 \membersection{wxHtmlWindow::SelectLine
}\label{wxhtmlwindowselectline
}
358 \func{void
}{SelectLine
}{\param{const wxPoint\&
}{pos
}}
360 Selects the line of text that
\arg{pos
} points at. Note that
\arg{pos
}
361 is relative to the top of displayed page, not to window's origin, use
362 \helpref{CalcUnscrolledPosition
}{wxscrolledwindowcalcunscrolledposition
}
363 to convert physical coordinate.
367 \helpref{SelectAll
}{wxhtmlwindowselectall
},
368 \helpref{SelectWord
}{wxhtmlwindowselectword
}
370 \membersection{wxHtmlWindow::SelectWord
}\label{wxhtmlwindowselectword
}
372 \func{void
}{SelectWord
}{\param{const wxPoint\&
}{pos
}}
374 Selects the word at position
\arg{pos
}. Note that
\arg{pos
}
375 is relative to the top of displayed page, not to window's origin, use
376 \helpref{CalcUnscrolledPosition
}{wxscrolledwindowcalcunscrolledposition
}
377 to convert physical coordinate.
381 \helpref{SelectAll
}{wxhtmlwindowselectall
},
382 \helpref{SelectLine
}{wxhtmlwindowselectline
}
384 \membersection{wxHtmlWindow::SetBorders
}\label{wxhtmlwindowsetborders
}
386 \func{void
}{SetBorders
}{\param{int
}{b
}}
388 This function sets the space between border of window and HTML contents. See image:
390 \helponly{\image{}{border.bmp
}}
392 \wxheading{Parameters
}
394 \docparam{b
}{indentation from borders in pixels
}
396 \membersection{wxHtmlWindow::SetFonts
}\label{wxhtmlwindowsetfonts
}
398 \func{void
}{SetFonts
}{\param{const wxString\&
}{normal
\_face},
\param{const wxString\&
}{fixed
\_face},
\param{const int
}{*sizes = NULL
}}
400 This function sets font sizes and faces.
402 \wxheading{Parameters
}
404 \docparam{normal
\_face}{This is face name for normal (i.e. non-fixed) font.
405 It can be either empty string (then the default face is chosen) or
406 platform-specific face name. Examples are "helvetica" under Unix or
407 "Times New Roman" under Windows.
}
409 \docparam{fixed
\_face}{The same thing for fixed face ( <TT>..</TT> )
}
411 \docparam{sizes
}{This is an array of
7 items of
{\it int
} type.
412 The values represent size of font with HTML size from -
2 to +
4
413 ( <FONT SIZE=-
2> to <FONT SIZE=+
4> ). Default sizes are used if
{\it sizes
}
418 Default font sizes are defined by constants wxHTML
\_FONT\_SIZE\_1,
419 wxHTML
\_FONT\_SIZE\_2, ..., wxHTML
\_FONT\_SIZE\_7. Note that they differ among
420 platforms. Default face names are empty strings.
422 \membersection{wxHtmlWindow::SetPage
}\label{wxhtmlwindowsetpage
}
424 \func{bool
}{SetPage
}{\param{const wxString\&
}{source
}}
426 Sets HTML page and display it. This won't
{\bf load
} the page!!
427 It will display the
{\it source
}. See example:
430 htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
433 If you want to load a
document from some location use
434 \helpref{LoadPage
}{wxhtmlwindowloadpage
} instead.
436 \wxheading{Parameters
}
438 \docparam{source
}{The HTML
document source to be displayed.
}
440 \wxheading{Return value
}
442 false if an error occurred, true otherwise.
444 \membersection{wxHtmlWindow::SetRelatedFrame
}\label{wxhtmlwindowsetrelatedframe
}
446 \func{void
}{SetRelatedFrame
}{\param{wxFrame*
}{frame
},
\param{const wxString\&
}{format
}}
448 Sets the frame in which page title will be displayed.
{\it format
} is format of
449 frame title, e.g. "HtmlHelp : \%s". It must contain exactly one \%s. This
450 \%s is substituted with HTML page title.
452 \membersection{wxHtmlWindow::SetRelatedStatusBar
}\label{wxhtmlwindowsetrelatedstatusbar
}
454 \func{void
}{SetRelatedStatusBar
}{\param{int
}{bar
}}
456 {\bf After
} calling
\helpref{SetRelatedFrame
}{wxhtmlwindowsetrelatedframe
},
457 this sets statusbar slot where messages will be displayed.
458 (Default is -
1 = no messages.)
460 \wxheading{Parameters
}
462 \docparam{bar
}{statusbar slot number (
0..n)
}
464 \membersection{wxHtmlWindow::ToText
}\label{wxhtmlwindowtotext
}
466 \func{wxString
}{ToText
}{\void}
468 Returns content of currently displayed page as plain text.
470 \membersection{wxHtmlWindow::WriteCustomization
}\label{wxhtmlwindowwritecustomization
}
472 \func{virtual void
}{WriteCustomization
}{\param{wxConfigBase
}{*cfg
},
\param{wxString
}{path = wxEmptyString
}}
474 Saves custom settings into wxConfig. It uses the path 'path'
475 if given, otherwise it saves info into currently selected path.
476 Regardless of whether the path is given or not, the function creates sub-path
479 Saved values: all things set by SetFonts, SetBorders.
481 \wxheading{Parameters
}
483 \docparam{cfg
}{wxConfig to which you want to save the configuration.
}
485 \docparam{path
}{Optional path in config tree. If not given, the current path is used.
}
493 \section{\class{wxHtmlLinkEvent
}}\label{wxhtmllinkevent
}
495 This event class is used for the events generated by
\helpref{wxHtmlWindow
}{wxhtmlwindow
}.
497 \wxheading{Derived from
}
499 \helpref{wxCommandEvent
}{wxcommandevent
}\\
500 \helpref{wxEvent
}{wxevent
}\\
501 \helpref{wxObject
}{wxobject
}
503 \wxheading{Include files
}
509 \helpref{wxHtml
}{librarieslist
}
511 \wxheading{Event handling
}
513 To process input from a wxHtmlLinkEvent, use one of these event handler macros to
514 direct input to member function that take a
\helpref{wxHtmlLinkEvent
}{wxhtmllinkevent
} argument:
518 \twocolitem{{\bf EVT
\_HTML\_LINK\_CLICKED(id, func)
}}{User clicked on an hyperlink.
}
522 \latexignore{\rtfignore{\wxheading{Members
}}}
524 \membersection{wxHtmlLinkEvent::wxHtmlLinkEvent
}\label{wxhtmllinkeventctor
}
526 \func{}{wxHyperlinkEvent
}{\param{int
}{ id
},
\param{const wxHtmlLinkInfo \&
}{ linkinfo
}}
528 The constructor is not normally used by the user code.
531 \membersection{wxHtmlLinkEvent::GetLinkInfo
}\label{wxhtmllinkeventgetlinkinfo
}
533 \constfunc{const wxHtmlLinkInfo &
}{GetLinkInfo
}{\void}
535 Returns the
\helpref{wxHtmlLinkInfo
}{wxhtmllinkinfo
} which contains info about the cell clicked and the hyperlink it contains.
542 \section{\class{wxHtmlCellEvent
}}\label{wxhtmlcellevent
}
544 This event class is used for the events generated by
\helpref{wxHtmlWindow
}{wxhtmlwindow
}.
546 \wxheading{Derived from
}
548 \helpref{wxCommandEvent
}{wxcommandevent
}\\
549 \helpref{wxEvent
}{wxevent
}\\
550 \helpref{wxObject
}{wxobject
}
552 \wxheading{Include files
}
558 \helpref{wxHtml
}{librarieslist
}
560 \wxheading{Event handling
}
562 To process input from a wxHtmlCellEvent, use one of these event handler macros to
563 direct input to member function that take a
\helpref{wxHtmlCellEvent
}{wxhtmlcellevent
} argument:
567 \twocolitem{{\bf EVT
\_HTML\_CELL\_HOVER(id, func)
}}{User moved the mouse over a
\helpref{wxHtmlCell
}{wxhtmlcell
}.
}
568 \twocolitem{{\bf EVT
\_HTML\_CELL\_CLICKED(id, func)
}}{User clicked on a
\helpref{wxHtmlCell
}{wxhtmlcell
}. When handling this event, remember to use
\helpref{wxHtmlCell::SetLinkClicked(true)
}{wxhtmlcelleventsetlinkclicked
} if the cell contains a link.
}
572 \latexignore{\rtfignore{\wxheading{Members
}}}
574 \membersection{wxHtmlCellEvent::wxHtmlCellEvent
}\label{wxhtmlcelleventctor
}
576 \func{}{wxHtmlCellEvent
}{\param{wxEventType
}{ commandType
},
\param{int
}{ id
},
\param{wxHtmlCell *
}{ cell
},
\param{const wxPoint \&
}{ point
}}
578 The constructor is not normally used by the user code.
581 \membersection{wxHtmlCellEvent::GetCell
}\label{wxhtmlcelleventgetcell
}
583 \constfunc{wxHtmlCell *
}{GetCell
}{\void}
585 Returns the
\helpref{wxHtmlCellEvent
}{wxhtmlcellevent
} associated with the event.
588 \membersection{wxHtmlCellEvent::GetPoint
}\label{wxhtmlcelleventgetpoint
}
590 \constfunc{wxPoint
}{GetPoint
}{\void}
592 Returns the
\helpref{wxPoint
}{wxpoint
} associated with the event.
595 \membersection{wxHtmlCellEvent::SetLinkClicked
}\label{wxhtmlcelleventsetlinkclicked
}
597 \func{bool
}{SetLinkClicked
}{\param{bool
}{ linkclicked
}}
599 Call this function with
{\tt linkclicked
} set to
\true if the cell which has been clicked contained a link or
600 \false otherwise (which is the default). With this function the event handler can return info to the
601 wxHtmlWindow which sent the event.
604 \membersection{wxHtmlCellEvent::GetLinkClicked
}\label{wxhtmlcelleventgetlinkclicked
}
606 \constfunc{bool
}{GetLinkClicked
}{\void}
608 Returns
\true if
\helpref{SetLinkClicked(true)
}{wxhtmlcelleventsetlinkclicked
} has previously been called;