projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 846914d1 VS |
1 | \section{\class{wxHtmlLinkInfo}}\label{wxhtmllinkinfo} |
| 2 | ||
| 3 | This class stores all neccessary information about hypertext | |
| 4 | links (as represented by {\tt <A>} tag in HTML documents). In | |
| 5 | current 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 | ||
| 846914d1 VS |
12 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 13 | ||
| 846914d1 VS |
14 | \membersection{wxHtmlLinkInfo::wxHtmlLinkInfo}\label{wxhtmllinkinfowxhtmllinkinfo} |
| 15 | ||
| 16 | \func{}{wxHtmlLinkInfo}{\void} | |
| 17 | ||
| 18 | Default ctor. | |
| 19 | ||
| 846914d1 VS |
20 | \func{}{wxHtmlLinkInfo}{\param{const wxString\& }{href}, \param{const wxString\& }{target = wxEmptyString}} |
| 21 | ||
| 22 | Construct hypertext link from HREF (aka URL) and TARGET (name of target | |
| 23 | frame). | |
| 24 | ||
| 9bc8fded VS |
25 | \membersection{wxHtmlLinkInfo::GetEvent}\label{wxhtmllinkinfogetevent} |
| 26 | ||
| 27 | \func{const wxMouseEvent *}{GetEvent}{\void} | |
| 28 | ||
| 29 | Return pointer to event that generated OnLinkClicked event. Valid | |
| 30 | only within \helpref{wxHtmlWindow::OnLinkClicked}{wxhtmlwindowonlinkclicked}, | |
| 31 | NULL otherwise. | |
| 32 | ||
| 33 | \membersection{wxHtmlLinkInfo::GetHtmlCell}\label{wxhtmllinkinfogethtmlcell} | |
| 34 | ||
| 35 | \func{const wxHtmlCell *}{GetHtmlCell}{\void} | |
| 36 | ||
| 37 | Return pointer to the cell that was clicked. Valid | |
| 38 | only within \helpref{wxHtmlWindow::OnLinkClicked}{wxhtmlwindowonlinkclicked}, | |
| 39 | NULL otherwise. | |
| 40 | ||
| 41 | ||
| 846914d1 VS |
42 | \membersection{wxHtmlLinkInfo::GetHref}\label{wxhtmllinkinfogethref} |
| 43 | ||
| 44 | \func{wxString}{GetHref}{\void} | |
| 45 | ||
| 9bc8fded | 46 | Return {\it HREF} value of the {\tt <A>} tag. |
| 846914d1 VS |
47 | |
| 48 | \membersection{wxHtmlLinkInfo::GetTarget}\label{wxhtmllinkinfogettarget} | |
| 49 | ||
| 50 | \func{wxString}{GetTarget}{\void} | |
| 51 | ||
| 9bc8fded | 52 | Return {\it TARGET} value of the {\tt <A>} tag (this value |
| 846914d1 VS |
53 | is used to specify in which frame should be the page pointed |
| 54 | by {\helpref{Href}{wxhtmllinkinfogethref} opened). | |
| e12be2f7 | 55 |