Add documentation of emitted events to wxScrolled documentation.

[wxWidgets.git] / interface / wx / hyperlink.h

diff --git a/interface/wx/hyperlink.h b/interface/wx/hyperlink.h
index 115db369cbaf0e5257dd86b1a3c26f5eb8bffcd5..1d2bb02c8a26a69be852b8a9076c4f11a31ba769 100644 (file)
--- a/interface/wx/hyperlink.h
+++ b/interface/wx/hyperlink.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxHyperlinkEvent
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -44,6 +44,7 @@ public:
     @class 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 wxHyperlinkEvent is
@@ -58,9 +59,11 @@ public:
     @style{wxHL_ALIGN_LEFT}
            Align the text to the left.
     @style{wxHL_ALIGN_RIGHT}
-           Align the text to the right.
+           Align the text to the right. This style is not supported under
+           Windows XP but is supported under all the other Windows versions.
     @style{wxHL_ALIGN_CENTRE}
-           Center the text (horizontally).
+           Center the text (horizontally). This style is not supported by the
+           native MSW implementation used under Windows XP and later.
     @style{wxHL_CONTEXTMENU}
            Pop up a context menu when the hyperlink is right-clicked. The
            context menu contains a "Copy URL" menu item which is automatically
@@ -71,13 +74,16 @@ public:
            wxBORDER_NONE|wxHL_CONTEXTMENU|wxHL_ALIGN_CENTRE.
     @endStyleTable
 
-    @beginEventTable{wxHyperlinkEvent}
+    @beginEventEmissionTable{wxHyperlinkEvent}
     @event{EVT_HYPERLINK(id, func)}
         The hyperlink was (left) clicked. If this event is not handled in user's
         code (or it's skipped; see wxEvent::Skip), then a call to wxLaunchDefaultBrowser
         is done with the hyperlink's URL.
     @endEventTable
 
+    Currently this class is implemented using native support in wxGTK and wxMSW
+    (under Windows XP and later only) and a generic version is used by the
+    other ports.
 
     @library{wxadv}
     @category{ctrl}
@@ -91,13 +97,13 @@ public:
     /**
         Constructor. See Create() for more info.
     */
-    wxHyperLink(wxWindow* parent, wxWindowID id,
-                const wxString& label,
-                const wxString& url,
-                const wxPoint& pos = wxDefaultPosition,
-                const wxSize& size = wxDefaultSize,
-                long style = wxHL_DEFAULT_STYLE,
-                const wxString& name = "hyperlink");
+    wxHyperlinkCtrl(wxWindow* parent, wxWindowID id,
+                    const wxString& label,
+                    const wxString& url,
+                    const wxPoint& pos = wxDefaultPosition,
+                    const wxSize& size = wxDefaultSize,
+                    long style = wxHL_DEFAULT_STYLE,
+                    const wxString& name = wxHyperlinkCtrlNameStr);
 
     /**
         Creates the hyperlink control.