Add wxProgressDialog::Was{Cancelled,Skipped}() convenience methods.

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

diff --git a/interface/wx/hyperlink.h b/interface/wx/hyperlink.h
index fa33892e62863c942fad4984e0d0d8d3544c027b..044604e725701acfe8c9c1824a6a0b24dd0e193d 100644 (file)
--- a/interface/wx/hyperlink.h
+++ b/interface/wx/hyperlink.h
@@ -9,11 +9,15 @@
 /**
     @class wxHyperlinkEvent
 
 /**
     @class wxHyperlinkEvent
 

-    This event class is used for the events generated by
-    wxHyperlinkCtrl.
+    This event class is used for the events generated by wxHyperlinkCtrl.
+
+    @beginEventTable{wxHyperlinkEvent}
+    @event{EVT_HYPERLINK(id, func)}
+        User clicked on an hyperlink.
+    @endEventTable

 
     @library{wxadv}
 
     @library{wxadv}

-    @category{FIXME}
+    @category{events}

 */
 class wxHyperlinkEvent : public wxCommandEvent
 {
 */
 class wxHyperlinkEvent : public wxCommandEvent
 {


@@ -21,8 +25,7 @@ public:
     /**
         The constructor is not normally used by the user code.
     */
     /**
         The constructor is not normally used by the user code.
     */

-    wxHyperlinkEvent(wxObject* generator, int id,
-                     const wxString& url);
+    wxHyperlinkEvent(wxObject* generator, int id, const wxString& url);

 
     /**
         Returns the URL of the hyperlink where the user has just clicked.
 
     /**
         Returns the URL of the hyperlink where the user has just clicked.


@@ -41,15 +44,15 @@ public:
     @class wxHyperlinkCtrl
 
     This class shows a static text element which links to an URL.
     @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
-    sent but if that event is not handled (or it's skipped; see
-    wxEvent::Skip), then a call to
-    wxLaunchDefaultBrowser() is done with the
-    hyperlink's URL.
+    Appearance and behaviour is completely customizable.
+
+    In fact, when the user clicks on the hyperlink, a wxHyperlinkEvent is
+    sent but if that event is not handled (or it's skipped; see wxEvent::Skip),
+    then a call to wxLaunchDefaultBrowser() is done with the hyperlink's URL.

 
     Note that standard wxWindow functions like wxWindow::SetBackgroundColour,
 
     Note that standard wxWindow functions like wxWindow::SetBackgroundColour,

-    wxWindow::SetFont, wxWindow::SetCursor, wxWindow::SetLabel can be used to customize appearance of the hyperlink.
+    wxWindow::SetFont, wxWindow::SetCursor, wxWindow::SetLabel can be used to
+    customize appearance of the hyperlink.

 
     @beginStyleTable
     @style{wxHL_ALIGN_LEFT}
 
     @beginStyleTable
     @style{wxHL_ALIGN_LEFT}


@@ -68,6 +71,14 @@ public:
            wxBORDER_NONE|wxHL_CONTEXTMENU|wxHL_ALIGN_CENTRE.
     @endStyleTable
 
            wxBORDER_NONE|wxHL_CONTEXTMENU|wxHL_ALIGN_CENTRE.
     @endStyleTable
 

+    @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
+
+

     @library{wxadv}
     @category{ctrl}
     @appearance{hyperlinkctrl.png}
     @library{wxadv}
     @category{ctrl}
     @appearance{hyperlinkctrl.png}


@@ -80,13 +91,13 @@ public:
     /**
         Constructor. See Create() for more info.
     */
     /**
         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.
 
     /**
         Creates the hyperlink control.


@@ -102,22 +113,18 @@ public:
         @param pos
             Window position.
         @param size
         @param pos
             Window position.
         @param size

-            Window size. If the wxDefaultSize is specified then the window is sized
-            appropriately.
+            Window size.
+            If the wxDefaultSize is specified then the window is sized appropriately.

         @param style
             Window style. See wxHyperlinkCtrl.
         @param style
             Window style. See wxHyperlinkCtrl.

-        @param validator
-            Window validator.

         @param name
             Window name.
     */
         @param name
             Window name.
     */

-    bool Create(wxWindow* parent, wxWindowID id,
-                const wxString& label,
-                const wxString& url,
-                const wxPoint& pos = wxDefaultPosition,
+    bool Create(wxWindow* parent, wxWindowID id, const wxString& label,
+                const wxString& url, const wxPoint& pos = wxDefaultPosition,

                 const wxSize& size = wxDefaultSize,
                 long style = wxHL_DEFAULT_STYLE,
                 const wxSize& size = wxDefaultSize,
                 long style = wxHL_DEFAULT_STYLE,

-                const wxString& name = "hyperlink");
+                const wxString& name = wxHyperlinkCtrlNameStr);

 
     /**
         Returns the colour used to print the label of the hyperlink when the mouse is
 
     /**
         Returns the colour used to print the label of the hyperlink when the mouse is


@@ -127,8 +134,7 @@ public:
 
     /**
         Returns the colour used to print the label when the link has never been clicked
 
     /**
         Returns the colour used to print the label when the link has never been clicked

-        before
-        (i.e. the link has not been @e visited) and the mouse is not over the control.
+        before (i.e. the link has not been @e visited) and the mouse is not over the control.

     */
     virtual wxColour GetNormalColour() const;
 
     */
     virtual wxColour GetNormalColour() const;
 


@@ -145,9 +151,8 @@ public:
 
     /**
         Returns the colour used to print the label when the mouse is not over the
 
     /**
         Returns the colour used to print the label when the mouse is not over the

-        control
-        and the link has already been clicked before (i.e. the link has been @e
-        visited).
+        control and the link has already been clicked before (i.e. the link has
+        been @e visited).

     */
     virtual wxColour GetVisitedColour() const;
 
     */
     virtual wxColour GetVisitedColour() const;
 


@@ -158,8 +163,7 @@ public:
     virtual void SetHoverColour(const wxColour& colour);
 
     /**
     virtual void SetHoverColour(const wxColour& colour);
 
     /**

-        Sets the colour used to print the label when the link has never been clicked
-        before
+        Sets the colour used to print the label when the link has never been clicked before

         (i.e. the link has not been @e visited) and the mouse is not over the control.
     */
     virtual void SetNormalColour(const wxColour& colour);
         (i.e. the link has not been @e visited) and the mouse is not over the control.
     */
     virtual void SetNormalColour(const wxColour& colour);


@@ -176,8 +180,7 @@ public:
 
     /**
         Sets the colour used to print the label when the mouse is not over the control
 
     /**
         Sets the colour used to print the label when the mouse is not over the control

-        and the link has already been clicked before (i.e. the link has been @e
-        visited).
+        and the link has already been clicked before (i.e. the link has been @e visited).

     */
     virtual void SetVisitedColour(const wxColour& colour);
 };
     */
     virtual void SetVisitedColour(const wxColour& colour);
 };