]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/htlnkinf.tex
clarified the parameters of MB2WC and WC2MB a little in the docs/headers
[wxWidgets.git] / docs / latex / wx / htlnkinf.tex
... / ...
CommitLineData
1\section{\class{wxHtmlLinkInfo}}\label{wxhtmllinkinfo}
2
3This class stores all necessary information about hypertext
4links (as represented by {\tt <A>} tag in HTML documents). In
5current implementation it stores URL and target frame name.
6{\it Note that frames are not currently supported by wxHTML!}
7
8\wxheading{Derived from}
9
10\helpref{wxObject}{wxobject}
11
12\wxheading{Include files}
13
14<wx/html/htmlcell.h>
15
16\latexignore{\rtfignore{\wxheading{Members}}}
17
18\membersection{wxHtmlLinkInfo::wxHtmlLinkInfo}\label{wxhtmllinkinfowxhtmllinkinfo}
19
20\func{}{wxHtmlLinkInfo}{\void}
21
22Default ctor.
23
24\func{}{wxHtmlLinkInfo}{\param{const wxString\& }{href}, \param{const wxString\& }{target = wxEmptyString}}
25
26Construct hypertext link from HREF (aka URL) and TARGET (name of target
27frame).
28
29\membersection{wxHtmlLinkInfo::GetEvent}\label{wxhtmllinkinfogetevent}
30
31\func{const wxMouseEvent *}{GetEvent}{\void}
32
33Return pointer to event that generated OnLinkClicked event. Valid
34only within \helpref{wxHtmlWindow::OnLinkClicked}{wxhtmlwindowonlinkclicked},
35NULL otherwise.
36
37\membersection{wxHtmlLinkInfo::GetHtmlCell}\label{wxhtmllinkinfogethtmlcell}
38
39\func{const wxHtmlCell *}{GetHtmlCell}{\void}
40
41Return pointer to the cell that was clicked. Valid
42only within \helpref{wxHtmlWindow::OnLinkClicked}{wxhtmlwindowonlinkclicked},
43NULL otherwise.
44
45
46\membersection{wxHtmlLinkInfo::GetHref}\label{wxhtmllinkinfogethref}
47
48\func{wxString}{GetHref}{\void}
49
50Return {\it HREF} value of the {\tt <A>} tag.
51
52\membersection{wxHtmlLinkInfo::GetTarget}\label{wxhtmllinkinfogettarget}
53
54\func{wxString}{GetTarget}{\void}
55
56Return {\it TARGET} value of the {\tt <A>} tag (this value
57is used to specify in which frame should be the page pointed
58by \helpref{Href}{wxhtmllinkinfogethref} opened).
59