Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[ 1504474 ] Small hyperlink doc fix.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39762 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Włodzimierz Skiba
2006-06-16 09:11:09 +00:00
parent 1fe0a566bb
commit 103791a6d0
1 changed files with 14 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/latex/wx/hyperlink.tex
View File

@@ -12,7 +12,12 @@
\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.
@@ -40,8 +45,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,7 +57,7 @@ functions that take a \helpref{wxHyperlinkEvent}{wxhyperlinkctrlevent} argument.
\wxheading{See also}
\helpref{wxURL}{wxurl}
\helpref{wxURL}{wxurl}, \helpref{wxHyperlinkEvent}{wxhyperlinkevent}
\latexignore{\rtfignore{\wxheading{Members}}}
@@ -65,7 +71,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 +83,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 +175,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}.
@@ -188,7 +194,7 @@ This event class is used for the events generated by
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}