]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/hyperlink.h
removing old files
[wxWidgets.git] / interface / hyperlink.h
index 05bda19292552c615460e4a11d5cec51ec6d8ec6..5982f6d1cac46f1dde0418a3bfa6573c782e353b 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        hyperlink.h
-// Purpose:     documentation for wxHyperlinkEvent class
+// Purpose:     interface of wxHyperlinkEvent
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -37,6 +37,7 @@ public:
 };
 
 
+
 /**
     @class wxHyperlinkCtrl
     @wxheader{hyperlink.h}
@@ -46,42 +47,52 @@ public:
     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
+    wxLaunchDefaultBrowser() is done with the
     hyperlink's URL.
 
     Note that standard wxWindow functions like wxWindow::SetBackgroundColour,
     wxWindow::SetFont, wxWindow::SetCursor, wxWindow::SetLabel can be used to customize appearance of the hyperlink.
 
     @beginStyleTable
-    @style{wxHL_ALIGN_LEFT}:
+    @style{wxHL_ALIGN_LEFT}
            Align the text to the left.
-    @style{wxHL_ALIGN_RIGHT}:
+    @style{wxHL_ALIGN_RIGHT}
            Align the text to the right.
-    @style{wxHL_ALIGN_CENTRE}:
+    @style{wxHL_ALIGN_CENTRE}
            Center the text (horizontally).
-    @style{wxHL_CONTEXTMENU}:
+    @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
            handled by the hyperlink and which just copies in the clipboard the
            URL (not the label) of the control.
-    @style{wxHL_DEFAULT_STYLE}:
+    @style{wxHL_DEFAULT_STYLE}
            The default style for wxHyperlinkCtrl:
            wxBORDER_NONE|wxHL_CONTEXTMENU|wxHL_ALIGN_CENTRE.
     @endStyleTable
 
     @library{wxadv}
     @category{ctrl}
-    @appearance{hyperlinkctrl.png}
+    <!-- @appearance{hyperlinkctrl.png} -->
 
-    @seealso
-    wxURL, wxHyperlinkEvent
+    @see wxURL, wxHyperlinkEvent
 */
 class wxHyperlinkCtrl : public wxControl
 {
 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");
+
     /**
         Creates the hyperlink control.
-        
+
         @param parent
             Parent window. Must not be @NULL.
         @param id
@@ -107,7 +118,7 @@ public:
                 const wxString& url,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
-                long style,
+                long style = wxHL_DEFAULT_STYLE,
                 const wxString& name = "hyperlink");
 
     /**
@@ -132,7 +143,7 @@ public:
         Returns @true if the hyperlink has already been clicked by the user at least
         one time.
     */
-    bool GetVisited() const;
+    virtual bool GetVisited() const = 0;
 
     /**
         Returns the colour used to print the label when the mouse is not over the
@@ -163,7 +174,7 @@ public:
     /**
         Marks the hyperlink as visited (see wxHyperlinkCtrl::SetVisitedColour).
     */
-    void SetVisited(bool visited = true);
+    virtual void SetVisited(bool visited = true) = 0;
 
     /**
         Sets the colour used to print the label when the mouse is not over the control
@@ -171,15 +182,5 @@ public:
         visited).
     */
     void SetVisitedColour(const wxColour& colour);
-
-    /**
-        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,
-                const wxString& name = "hyperlink");
 };
+