addind nonowned window implementation

[wxWidgets.git] / interface / hyperlink.h

diff --git a/interface/hyperlink.h b/interface/hyperlink.h
index 0e7b171f38d369ef46515090d88b2e461e86396e..5421ca0e0c07f7f4148b7035f4022664f13ba73b 100644 (file)
--- a/interface/hyperlink.h
+++ b/interface/hyperlink.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        hyperlink.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        hyperlink.h

-// Purpose:     documentation for wxHyperlinkEvent class
+// Purpose:     interface of wxHyperlinkEvent

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -22,21 +22,22 @@ 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.
     */

-#define wxString GetURL()     /* implementation is private */
+    wxString GetURL() const;

 
     /**
         Sets the URL associated with the event.
     */
 
     /**
         Sets the URL associated with the event.
     */

-#define void SetURL(const wxString & url)     /* implementation is private */
+    void SetURL(const wxString& url);

 };
 
 
 };
 
 

+

 /**
     @class wxHyperlinkCtrl
     @wxheader{hyperlink.h}
 /**
     @class wxHyperlinkCtrl
     @wxheader{hyperlink.h}


@@ -46,7 +47,7 @@ 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
     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,
     hyperlink's URL.
 
     Note that standard wxWindow functions like wxWindow::SetBackgroundColour,


@@ -73,46 +74,37 @@ public:
     @category{ctrl}
     @appearance{hyperlinkctrl.png}
 
     @category{ctrl}
     @appearance{hyperlinkctrl.png}
 

-    @seealso
-    wxURL, wxHyperlinkEvent
+    @see wxURL, wxHyperlinkEvent

 */
 class wxHyperlinkCtrl : public wxControl
 {
 public:
     /**
         Creates the hyperlink control.
 */
 class wxHyperlinkCtrl : public wxControl
 {
 public:
     /**
         Creates the hyperlink control.

-        
+

         @param parent
         @param parent

-        Parent window. Must not be @NULL.
-        
+            Parent window. Must not be @NULL.

         @param id
         @param id

-        Window identifier. A value of wxID_ANY indicates a default value.
-        
+            Window identifier. A value of wxID_ANY indicates a default value.

         @param label
         @param label

-        The label of the hyperlink.
-        
+            The label of the hyperlink.

         @param url
         @param url

-        The URL associated with the given label.
-        
+            The URL associated with the given label.

         @param pos
         @param pos

-        Window position.
-        
+            Window position.

         @param size
         @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
         @param style

-        Window style. See wxHyperlinkCtrl.
-        
+            Window style. See wxHyperlinkCtrl.

         @param validator
         @param validator

-        Window validator.
-        
+            Window validator.

         @param name
         @param name

-        Window name.
+            Window name.

     */
     bool Create(wxWindow* parent, wxWindowID id,
     */
     bool Create(wxWindow* parent, wxWindowID id,

-                const wxString & label,
-                const wxString & url,
+                const wxString& label,
+                const wxString& url,

                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style,


@@ -122,25 +114,25 @@ public:
         Returns the colour used to print the label of the hyperlink when the mouse is
         over the control.
     */
         Returns the colour used to print the label of the hyperlink when the mouse is
         over the control.
     */

-    wxColour GetHoverColour();
+    wxColour GetHoverColour() const;

 
     /**
         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.
     */
 
     /**
         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.
     */

-    wxColour GetNormalColour();
+    wxColour GetNormalColour() const;

 
     /**
         Returns the URL associated with the hyperlink.
     */
 
     /**
         Returns the URL associated with the hyperlink.
     */

-#define wxString GetURL()     /* implementation is private */
+    wxString GetURL() const;

 
     /**
         Returns @true if the hyperlink has already been clicked by the user at least
         one time.
     */
 
     /**
         Returns @true if the hyperlink has already been clicked by the user at least
         one time.
     */

-    bool GetVisited();
+    bool GetVisited() const;

 
     /**
         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


@@ -148,46 +140,47 @@ public:
         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).
     */

-    wxColour GetVisitedColour();
+    wxColour GetVisitedColour() const;

 
     /**
         Sets the colour used to print the label of the hyperlink when the mouse is over
         the control.
     */
 
     /**
         Sets the colour used to print the label of the hyperlink when the mouse is over
         the control.
     */

-    void SetHoverColour(const wxColour & colour);
+    void SetHoverColour(const wxColour& colour);

 
     /**
         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.
     */
 
     /**
         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.
     */

-    void SetNormalColour(const wxColour & colour);
+    void SetNormalColour(const wxColour& colour);

 
     /**
         Sets the URL associated with the hyperlink.
     */
 
     /**
         Sets the URL associated with the hyperlink.
     */

-#define void SetURL(const wxString & url)     /* implementation is private */
+    void SetURL(const wxString& url);

 
     /**
         Marks the hyperlink as visited (see wxHyperlinkCtrl::SetVisitedColour).
     */
 
     /**
         Marks the hyperlink as visited (see wxHyperlinkCtrl::SetVisitedColour).
     */

-    void SetVisited(bool visited = @true);
+    void SetVisited(bool visited = true);

 
     /**
         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).
     */
 
     /**
         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).
     */

-    void SetVisitedColour(const wxColour & colour);
+    void SetVisitedColour(const wxColour& colour);

 
     /**
         Constructor. See Create() for more info.
     */
     wxHyperLink(wxWindow* parent, wxWindowID id,
 
     /**
         Constructor. See Create() for more info.
     */
     wxHyperLink(wxWindow* parent, wxWindowID id,

-                const wxString & label,
-                const wxString & url,
+                const wxString& label,
+                const wxString& url,

                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style,
                 const wxString& name = "hyperlink");
 };
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style,
                 const wxString& name = "hyperlink");
 };

+