Missing header

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

diff --git a/include/wx/hyperlink.h b/include/wx/hyperlink.h
index 474951d97c62214cb3f7ae37a3685b82022533bf..eb45cd94668ee0001c7782bd778323c59409b1f9 100644 (file)
--- a/include/wx/hyperlink.h
+++ b/include/wx/hyperlink.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        hyperlink.h
+// Name:        wx/hyperlink.h

 // Purpose:     Hyperlink control
 // Author:      David Norris <danorris@gmail.com>, Otto Wyss
 // Modified by: Ryan Norton, Francesco Montorsi
 // Purpose:     Hyperlink control
 // Author:      David Norris <danorris@gmail.com>, Otto Wyss
 // Modified by: Ryan Norton, Francesco Montorsi


@@ -9,12 +9,8 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef _WX_HYPERLINK_H__
-#define _WX_HYPERLINK_H__
-
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "hyperlink.h"
-#endif
+#ifndef _WX_HYPERLINK_H_
+#define _WX_HYPERLINK_H_

 
 #include "wx/defs.h"
 
 
 #include "wx/defs.h"
 


@@ -27,9 +23,12 @@
 // ----------------------------------------------------------------------------
 
 #define wxHL_CONTEXTMENU        0x0001
 // ----------------------------------------------------------------------------
 
 #define wxHL_CONTEXTMENU        0x0001

-#define wxHL_DEFAULT_STYLE      wxHL_CONTEXTMENU|wxNO_BORDER
+#define wxHL_ALIGN_LEFT         0x0002
+#define wxHL_ALIGN_RIGHT        0x0004
+#define wxHL_ALIGN_CENTRE       0x0008
+#define wxHL_DEFAULT_STYLE      (wxHL_CONTEXTMENU|wxNO_BORDER|wxHL_ALIGN_CENTRE)

 
 

-extern WXDLLEXPORT_DATA(const wxChar) wxHyperlinkCtrlNameStr[];
+extern WXDLLIMPEXP_DATA_ADV(const wxChar) wxHyperlinkCtrlNameStr[];

 
 
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------


@@ -46,165 +45,104 @@ extern WXDLLEXPORT_DATA(const wxChar) wxHyperlinkCtrlNameStr[];
 // just like a wxCommandEvent.
 //
 // Use the EVT_HYPERLINK() to catch link events.
 // just like a wxCommandEvent.
 //
 // Use the EVT_HYPERLINK() to catch link events.

-class WXDLLIMPEXP_CORE wxHyperlinkCtrl : public wxControl
+class WXDLLIMPEXP_ADV wxHyperlinkCtrlBase : public wxControl

 {
 public:
 {
 public:

-    // Default constructor (for two-step construction).
-    wxHyperlinkCtrl() { }
-
-    // Constructor.
-    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)
-    {
-        (void)Create(parent, id, label, url, pos, size, style, name);
-    }
-
-    // Creation function (for two-step construction).
-    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 wxString& name = wxHyperlinkCtrlNameStr);
-

 
     // get/set
 
     // get/set

-    wxColour GetHoverColour() const { return m_hoverColour; }
-    void SetHoverColour(const wxColour &colour) { m_hoverColour = colour; }
+    virtual wxColour GetHoverColour() const = 0;
+    virtual void SetHoverColour(const wxColour &colour) = 0;

 
 

-    wxColour GetNormalColour() const { return m_normalColour; }
-    void SetNormalColour(const wxColour &colour);
+    virtual wxColour GetNormalColour() const = 0;
+    virtual void SetNormalColour(const wxColour &colour) = 0;

 
 

-    wxColour GetVisitedColour() const { return m_visitedColour; }
-    void SetVisitedColour(const wxColour &colour);
+    virtual wxColour GetVisitedColour() const = 0;
+    virtual void SetVisitedColour(const wxColour &colour) = 0;

 
 

-    wxString GetURL() const { return m_url; }
-    void SetURL (const wxString &url) { m_url=url; }
+    virtual wxString GetURL() const = 0;
+    virtual void SetURL (const wxString &url) = 0;

 
 

-    void SetVisited(bool visited = true) { m_visited=visited; }
-    bool GetVisited() const { return m_visited; }
+    virtual void SetVisited(bool visited = true) = 0;
+    virtual bool GetVisited() const = 0;

 
     // NOTE: also wxWindow::Set/GetLabel, wxWindow::Set/GetBackgroundColour,
     //       wxWindow::Get/SetFont, wxWindow::Get/SetCursor are important !
 
 
     // NOTE: also wxWindow::Set/GetLabel, wxWindow::Set/GetBackgroundColour,
     //       wxWindow::Get/SetFont, wxWindow::Get/SetCursor are important !
 

-

 protected:
 protected:

-    // event handlers
-
-    // Renders the hyperlink.
-    void OnPaint(wxPaintEvent& event);
-
-    // If the click originates inside the bounding box of the label,
-    // a flag is set so that an event will be fired when the left
-    // button is released.
-    void OnLeftDown(wxMouseEvent& event);
-
-    // If the click both originated and finished inside the bounding box
-    // of the label, a HyperlinkEvent is fired.
-    void OnLeftUp(wxMouseEvent& event);
-    void OnRightUp(wxMouseEvent& event);
-
-    // Changes the cursor to a hand, if the mouse is inside the label's
-    // bounding box.
-    void OnEnterWindow(wxMouseEvent& event);
-
-    // Changes the cursor back to the default, if necessary.
-    void OnLeaveWindow(wxMouseEvent& event);
-
-    // handles "Copy URL" menuitem
-    void OnPopUpCopy(wxCommandEvent& event);
-
-
-    // overridden base class virtuals
-
-    // Returns the best size for the window, which is the size needed
-    // to display the text label.
-    virtual void DoGetSize(int *width, int *height) const;
-    virtual wxSize DoGetBestSize() const;
-
-    // creates a context menu with "Copy URL" menuitem
-    virtual void DoContextMenu(const wxPoint &);
-
-private:
-    // URL associated with the link. This is transmitted inside
-    // the HyperlinkEvent fired when the user clicks on the label.
-    wxString m_url;
-
-    // Foreground colours for various link types.
-    // NOTE: wxWindow::m_backgroundColour is used for background,
-    //       wxWindow::m_foregroundColour is used to render non-visited links
-    wxColour m_hoverColour;
-    wxColour m_normalColour;
-    wxColour m_visitedColour;
+    virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }

 
 

-    // True if the mouse cursor is inside the label's bounding box.
-    bool m_rollover;
+    // checks for validity some of the ctor/Create() function parameters
+    void CheckParams(const wxString& label, const wxString& url, long style);

 
 

-    // True if the link has been clicked before.
-    bool m_visited;
-
-    // True if a click is in progress (left button down) and the click
-    // originated inside the label's bounding box.
-    bool m_clicking;
-
-private:
-    DECLARE_DYNAMIC_CLASS(wxHyperlinkCtrl)
-    DECLARE_EVENT_TABLE()
+public:
+    // not part of the public API but needs to be public as used by
+    // GTK+ callbacks:
+    void SendEvent();

 };
 
 };
 

+#ifndef __WXDEBUG__
+inline void wxHyperlinkCtrlBase::CheckParams(const wxString&, const wxString&, long) { }
+#endif

 
 // ----------------------------------------------------------------------------
 // wxHyperlinkEvent
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxHyperlinkEvent
 // ----------------------------------------------------------------------------
 

-// Declare an event identifier.
-BEGIN_DECLARE_EVENT_TYPES()
-    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, wxEVT_COMMAND_HYPERLINK, 3700)
-END_DECLARE_EVENT_TYPES()
+extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_HYPERLINK;

 
 //
 // An event fired when the user clicks on the label in a hyperlink control.
 // See HyperlinkControl for details.
 //
 
 //
 // An event fired when the user clicks on the label in a hyperlink control.
 // See HyperlinkControl for details.
 //

-class WXDLLIMPEXP_CORE wxHyperlinkEvent : public wxCommandEvent
+class WXDLLIMPEXP_ADV wxHyperlinkEvent : public wxCommandEvent

 {
 public:
 {
 public:

-

     wxHyperlinkEvent() {}
     wxHyperlinkEvent(wxObject *generator, wxWindowID id, const wxString& url)
     wxHyperlinkEvent() {}
     wxHyperlinkEvent(wxObject *generator, wxWindowID id, const wxString& url)

-     : wxCommandEvent(wxEVT_COMMAND_HYPERLINK, id), m_url(url)
-        { SetEventObject(generator); }
+        : wxCommandEvent(wxEVT_COMMAND_HYPERLINK, id),
+          m_url(url)
+    {
+        SetEventObject(generator);
+    }

 
     // Returns the URL associated with the hyperlink control
     // that the user clicked on.
     wxString GetURL() const { return m_url; }
     void SetURL(const wxString &url) { m_url=url; }
 
 
     // Returns the URL associated with the hyperlink control
     // that the user clicked on.
     wxString GetURL() const { return m_url; }
     void SetURL(const wxString &url) { m_url=url; }
 

+    // default copy ctor, assignment operator and dtor are ok
+    virtual wxEvent *Clone() const { return new wxHyperlinkEvent(*this); }
+

 private:
 
     // URL associated with the hyperlink control that the used clicked on.
     wxString m_url;
 private:
 
     // URL associated with the hyperlink control that the used clicked on.
     wxString m_url;

+
+    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHyperlinkEvent)

 };
 
 };
 

-// Define a typedef for event handler functions.
-typedef void (wxEvtHandler::*wxHyperlinkEventFunction)(wxHyperlinkEvent&);

 
 

-// Define an event table macro.
-#define EVT_HYPERLINK(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_COMMAND_HYPERLINK, \
-    id, id, (wxObjectEventFunction) (wxEventFunction) \
-    wxStaticCastEvent(wxHyperlinkEventFunction, &fn), (wxObject *) NULL),
+// ----------------------------------------------------------------------------
+// event types and macros
+// ----------------------------------------------------------------------------
+
+typedef void (wxEvtHandler::*wxHyperlinkEventFunction)(wxHyperlinkEvent&);

 
 

-// Newer event macro

 #define wxHyperlinkEventHandler(func) \
     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHyperlinkEventFunction, &func)
 
 #define wxHyperlinkEventHandler(func) \
     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHyperlinkEventFunction, &func)
 

-#endif // wxUSE_HYPERLINKCTRL
+#define EVT_HYPERLINK(id, fn) \
+    wx__DECLARE_EVT1(wxEVT_COMMAND_HYPERLINK, id, wxHyperlinkEventHandler(fn))

 
 

-#endif // _WX_HYPERLINK_H__

 
 

+#if defined(__WXGTK210__) && !defined(__WXUNIVERSAL__)
+    #include "wx/gtk/hyperlink.h"
+#else
+    #include "wx/generic/hyperlink.h"
+    #define wxHyperlinkCtrl     wxGenericHyperlinkCtrl
+#endif
+
+
+#endif // wxUSE_HYPERLINKCTRL
+
+#endif // _WX_HYPERLINK_H_