X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/db67d86dd1de506a5bb14dd59e9c45230120758a..15f7c30516facfb272fc116aec4d3f9c3a9de085:/docs/latex/wx/hyperlink.tex diff --git a/docs/latex/wx/hyperlink.tex b/docs/latex/wx/hyperlink.tex index e68334a30e..d765e3bd10 100644 --- a/docs/latex/wx/hyperlink.tex +++ b/docs/latex/wx/hyperlink.tex @@ -12,27 +12,42 @@ \section{\class{wxHyperlinkCtrl}}\label{wxhyperlinkctrl} This class shows a static text element which links to an URL. -Appearance and behaviour is completely customizable. In fact, when the user clicks on the hyperlink, a \helpref{wxHyperlinkEvent}{wxhyperlinkctrlevent} is sent but if that event is not handled (or it's skipped; see \helpref{wxEvent::Skip}{wxeventskip}), then a call to \helpref{wxLaunchDefaultBrowser}{wxlaunchdefaultbrowser} is done with the hyperlink's URL. +Appearance and behaviour is completely customizable. In fact, when the user +clicks on the hyperlink, a \helpref{wxHyperlinkEvent}{wxhyperlinkevent} is +sent but if that event is not handled (or it's skipped; see +\helpref{wxEvent::Skip}{wxeventskip}), then a call to +\helpref{wxLaunchDefaultBrowser}{wxlaunchdefaultbrowser} is done with the +hyperlink's URL. Note that standard \helpref{wxWindow}{wxwindow} functions like \helpref{SetBackgroundColour}{wxwindowsetbackgroundcolour}, \helpref{SetFont}{wxwindowsetfont}, \helpref{SetCursor}{wxwindowsetcursor}, \helpref{SetLabel}{wxwindowsetlabel} can be used to customize appearance of the hyperlink. \wxheading{Derived from} -\helpref{wxControl}{wxcontrol} +\helpref{wxControl}{wxcontrol}\\ +\helpref{wxWindow}{wxwindow}\\ +\helpref{wxEvtHandler}{wxevthandler}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + \wxheading{Window styles} \twocolwidtha{7cm} \begin{twocollist}\itemsep=0pt +\twocolitem{\windowstyle{wxHL\_ALIGN\_LEFT}}{Align the text to the left.} +\twocolitem{\windowstyle{wxHL\_ALIGN\_RIGHT}}{Align the text to the right.} +\twocolitem{\windowstyle{wxHL\_ALIGN\_CENTRE}}{Center the text (horizontally).} \twocolitem{\windowstyle{wxHL\_CONTEXTMENU}}{Pop up a context menu when the hyperlink is right-clicked. The context menu contains a \texttt{``Copy URL"} menu item which is automatically handled by the hyperlink and which just copies in the clipboard the URL (not the label) of the control.} -\twocolitem{\windowstyle{wxHL\_DEFAULT\_STYLE}}{The default style for wxHyperlinkCtrl: \texttt{wxNO\_BORDER|wxHL\_CONTEXTMENU}.} +\twocolitem{\windowstyle{wxHL\_DEFAULT\_STYLE}}{The default style for wxHyperlinkCtrl: \texttt{wxBORDER\_NONE|wxHL\_CONTEXTMENU|wxHL\_ALIGN\_CENTRE}.} \end{twocollist} See also \helpref{window styles overview}{windowstyles}. @@ -40,8 +55,9 @@ See also \helpref{window styles overview}{windowstyles}. \wxheading{Event handling} -To process input from a list control, use these event handler macros to direct input to member -functions that take a \helpref{wxHyperlinkEvent}{wxhyperlinkctrlevent} argument. +To process input from an hyperlink control, use these event handler macros to +direct input to member functions that take a +\helpref{wxHyperlinkEvent}{wxhyperlinkevent} argument. \twocolwidtha{7cm} \begin{twocollist}\itemsep=0pt @@ -51,12 +67,12 @@ functions that take a \helpref{wxHyperlinkEvent}{wxhyperlinkctrlevent} argument. \wxheading{See also} -\helpref{wxURL}{wxurl} +\helpref{wxURL}{wxurl}, \helpref{wxHyperlinkEvent}{wxhyperlinkevent} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxHyperlinkCtrl::wxHyperLink}\label{wxhyperlinkctrlctor} +\membersection{wxHyperlinkCtrl::wxHyperLinkCtrl}\label{wxhyperlinkctrlctor} \func{}{wxHyperLink}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{const wxString \&}{ label}, \param{const wxString \&}{ url}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style}, \param{const wxString\& }{name = ``hyperlink"}} @@ -65,7 +81,7 @@ Constructor. See \helpref{Create}{wxhyperlinkctrlcreate} for more info. \membersection{wxHyperlinkCtrl::Create}\label{wxhyperlinkctrlcreate} -\func{}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id = wxID\_ANY} \param{const wxString \&}{ label}, \param{const wxString \&}{ url}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\param{long}{ style}, \param{const wxString\& }{name = ``hyperlink"}} +\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{const wxString \&}{ label}, \param{const wxString \&}{ url}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style}, \param{const wxString\& }{name = ``hyperlink"}} Creates the hyperlink control. @@ -77,7 +93,7 @@ Creates the hyperlink control. \docparam{label}{The label of the hyperlink.} -\docparam{url}{The URL which is .} +\docparam{url}{The URL associated with the given label.} \docparam{pos}{Window position.} @@ -169,7 +185,7 @@ Sets the URL associated with the hyperlink. -\section{\class{wxHyperlinkEvent}}\label{wxhyperlinkctrlevent} +\section{\class{wxHyperlinkEvent}}\label{wxhyperlinkevent} This event class is used for the events generated by \helpref{wxHyperlinkCtrl}{wxhyperlinkctrl}. @@ -184,11 +200,15 @@ This event class is used for the events generated by +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + \wxheading{Event handling} To process input from a wxHyperlinkCtrl, use one of these event handler macros to direct input to member function that take a -\helpref{wxHyperlinkEvent}{wxhyperlinkctrlevent} argument: +\helpref{wxHyperlinkEvent}{wxhyperlinkevent} argument: \twocolwidtha{7cm} \begin{twocollist} @@ -198,22 +218,23 @@ direct input to member function that take a \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxHyperlinkEvent::wxHyperlinkEvent}\label{wxhyperlinkctrlctor} +\membersection{wxHyperlinkEvent::wxHyperlinkEvent}\label{wxhyperlinkeventctor} \func{}{wxHyperlinkEvent}{\param{wxObject *}{ generator}, \param{int}{ id}, \param{const wxString \&}{ url}} The constructor is not normally used by the user code. -\membersection{wxHyperlinkEvent::GetURL}\label{wxhyperlinkctrlgeturl} +\membersection{wxHyperlinkEvent::GetURL}\label{wxhyperlinkeventgeturl} \constfunc{wxString}{GetURL}{\void} Returns the URL of the hyperlink where the user has just clicked. -\membersection{wxHyperlinkEvent::SetURL}\label{wxhyperlinkctrlseturl} +\membersection{wxHyperlinkEvent::SetURL}\label{wxhyperlinkeventseturl} \func{void}{SetURL}{\param{const wxString \&}{ url}} Sets the URL associated with the event. +