docs/latex/wx/htlnkinf.tex

   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
  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
  22 Default ctor.
  23
  24 \func{}{wxHtmlLinkInfo}{\param{const wxString\& }{href}, \param{const wxString\& }{target = wxEmptyString}}
  25
  26 Construct hypertext link from HREF (aka URL) and TARGET (name of target
  27 frame).
  28
  29 \membersection{wxHtmlLinkInfo::GetEvent}\label{wxhtmllinkinfogetevent}
  30
  31 \func{const wxMouseEvent *}{GetEvent}{\void}
  32
  33 Return pointer to event that generated OnLinkClicked event. Valid
  34 only within \helpref{wxHtmlWindow::OnLinkClicked}{wxhtmlwindowonlinkclicked},
  35 NULL otherwise.
  36
  37 \membersection{wxHtmlLinkInfo::GetHtmlCell}\label{wxhtmllinkinfogethtmlcell}
  38
  39 \func{const wxHtmlCell *}{GetHtmlCell}{\void}
  40
  41 Return pointer to the cell that was clicked. Valid
  42 only within \helpref{wxHtmlWindow::OnLinkClicked}{wxhtmlwindowonlinkclicked},
  43 NULL otherwise.
  44
  45
  46 \membersection{wxHtmlLinkInfo::GetHref}\label{wxhtmllinkinfogethref}
  47
  48 \func{wxString}{GetHref}{\void}
  49
  50 Return {\it HREF} value of the {\tt <A>} tag.
  51
  52 \membersection{wxHtmlLinkInfo::GetTarget}\label{wxhtmllinkinfogettarget}
  53
  54 \func{wxString}{GetTarget}{\void}
  55
  56 Return {\it TARGET} value of the {\tt <A>} tag (this value
  57 is used to specify in which frame should be the page pointed
  58 by \helpref{Href}{wxhtmllinkinfogethref} opened).
  59