]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/htlnkinf.tex
remove C++ comment
[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\wxheading{Library}
17
18\helpref{wxHtml}{librarieslist}
19
20\latexignore{\rtfignore{\wxheading{Members}}}
21
22\membersection{wxHtmlLinkInfo::wxHtmlLinkInfo}\label{wxhtmllinkinfowxhtmllinkinfo}
23
24\func{}{wxHtmlLinkInfo}{\void}
25
26Default ctor.
27
28\func{}{wxHtmlLinkInfo}{\param{const wxString\& }{href}, \param{const wxString\& }{target = wxEmptyString}}
29
30Construct hypertext link from HREF (aka URL) and TARGET (name of target
31frame).
32
33\membersection{wxHtmlLinkInfo::GetEvent}\label{wxhtmllinkinfogetevent}
34
35\func{const wxMouseEvent *}{GetEvent}{\void}
36
37Return pointer to event that generated OnLinkClicked event. Valid
38only within \helpref{wxHtmlWindow::OnLinkClicked}{wxhtmlwindowonlinkclicked},
39NULL otherwise.
40
41\membersection{wxHtmlLinkInfo::GetHtmlCell}\label{wxhtmllinkinfogethtmlcell}
42
43\func{const wxHtmlCell *}{GetHtmlCell}{\void}
44
45Return pointer to the cell that was clicked. Valid
46only within \helpref{wxHtmlWindow::OnLinkClicked}{wxhtmlwindowonlinkclicked},
47NULL otherwise.
48
49
50\membersection{wxHtmlLinkInfo::GetHref}\label{wxhtmllinkinfogethref}
51
52\func{wxString}{GetHref}{\void}
53
54Return {\it HREF} value of the {\tt <A>} tag.
55
56\membersection{wxHtmlLinkInfo::GetTarget}\label{wxhtmllinkinfogettarget}
57
58\func{wxString}{GetTarget}{\void}
59
60Return {\it TARGET} value of the {\tt <A>} tag (this value
61is used to specify in which frame should be the page pointed
62by \helpref{Href}{wxhtmllinkinfogethref} opened).
63