Applied patch [ 1211299 ] Minor mod to wxClassInfo to improve usability

[wxWidgets.git] / include / wx / msw / pen.h

diff --git a/include/wx/msw/pen.h b/include/wx/msw/pen.h
index 9604745a00e68eee947b9f8d26541fbe540e0728..7e682576d4249d9e8c83b41420d3030941cf1b24 100644 (file)
--- a/include/wx/msw/pen.h
+++ b/include/wx/msw/pen.h
@@ -1,98 +1,131 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        pen.h
+// Name:        wx/msw/pen.h

 // Purpose:     wxPen class
 // Author:      Julian Smart
 // Purpose:     wxPen class
 // Author:      Julian Smart

-// Modified by:
+// Modified by: Vadim Zeitlin: fixed operator=(), ==(), !=()

 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __PENH__
-#define __PENH__
-
-#ifdef __GNUG__
-#pragma interface "pen.h"
-#endif
+#ifndef _WX_PEN_H_
+#define _WX_PEN_H_

 
 #include "wx/gdiobj.h"
 
 #include "wx/gdiobj.h"

+#include "wx/bitmap.h"
+#include "wx/colour.h"

 
 

-typedef    WXDWORD  wxDash ;
+typedef WXDWORD wxMSWDash;

 
 class WXDLLEXPORT wxPen;
 
 
 class WXDLLEXPORT wxPen;
 

-class WXDLLEXPORT wxPenRefData: public wxGDIRefData
+// VZ: this class should be made private
+class WXDLLEXPORT wxPenRefData : public wxGDIRefData

 {
 {

-    friend class WXDLLEXPORT wxPen;

 public:
 public:

-    wxPenRefData(void);
-    ~wxPenRefData(void);
+    wxPenRefData();
+    wxPenRefData(const wxPenRefData& data);
+    virtual ~wxPenRefData();
+
+    bool operator==(const wxPenRefData& data) const
+    {
+        // we intentionally don't compare m_hPen fields here
+        return m_style == data.m_style &&
+               m_width == data.m_width &&
+               m_join == data.m_join &&
+               m_cap == data.m_cap &&
+               m_colour == data.m_colour &&
+               (m_style != wxSTIPPLE || m_stipple == data.m_stipple) &&
+               (m_style != wxUSER_DASH ||
+                (m_nbDash == data.m_nbDash &&
+                    memcmp(m_dash, data.m_dash, m_nbDash*sizeof(wxDash)) == 0));
+    }

 
 protected:
 
 protected:

-  int           m_width;
-  int           m_style;
-  int           m_join ;
-  int           m_cap ;
-  wxBitmap      m_stipple ;
-  int           m_nbDash ;
-  wxDash *      m_dash ;
-  wxColour      m_colour;
-  WXHPEN        m_hPen;
+    int           m_width;
+    int           m_style;
+    int           m_join;
+    int           m_cap;
+    wxBitmap      m_stipple;
+    int           m_nbDash;
+    wxDash *      m_dash;
+    wxColour      m_colour;
+    WXHPEN        m_hPen;
+
+private:
+    friend class WXDLLEXPORT wxPen;
+
+    // Cannot use
+    //  DECLARE_NO_COPY_CLASS(wxPenRefData)
+    // because copy constructor is explicitly declared above;
+    // but no copy assignment operator is defined, so declare
+    // it private to prevent the compiler from defining it:
+    wxPenRefData& operator=(const wxPenRefData&);

 };
 
 #define M_PENDATA ((wxPenRefData *)m_refData)
 };
 
 #define M_PENDATA ((wxPenRefData *)m_refData)

+#define wxPENDATA(x) ((wxPenRefData *)(x).m_refData)

 
 

+// ----------------------------------------------------------------------------

 // Pen
 // Pen

-class WXDLLEXPORT wxPen: public wxGDIObject
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxPen : public wxGDIObject

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxPen)

 public:
 public:

-  wxPen(void);
-  wxPen(const wxColour& col, const int width, const int style);
-  wxPen(const wxString& col, const int width, const int style);
-  wxPen(const wxBitmap& stipple, const int width);
-  inline wxPen(const wxPen& pen) { Ref(pen); }
-  inline wxPen(const wxPen* pen) { /* UnRef(); */ if (pen) Ref(*pen); }
-  ~wxPen(void);
-
-  inline wxPen& operator = (const wxPen& pen) { if (*this == pen) return (*this); Ref(pen); return *this; }
-  inline bool operator == (const wxPen& pen) { return m_refData == pen.m_refData; }
-  inline bool operator != (const wxPen& pen) { return m_refData != pen.m_refData; }
-
-  virtual bool Ok(void) const { return (m_refData != NULL) ; }
-
-  // Override in order to recreate the pen
-  void SetColour(const wxColour& col) ;
-  void SetColour(const wxString& col)  ;
-  void SetColour(const unsigned char r, const unsigned char g, const unsigned char b)  ;
-
-  void SetWidth(const int width)  ;
-  void SetStyle(const int style)  ;
-  void SetStipple(const wxBitmap& stipple)  ;
-  void SetDashes(const int nb_dashes, const wxDash *dash)  ;
-  void SetJoin(const int join)  ;
-  void SetCap(const int cap)  ;
-
-  inline wxColour& GetColour(void) const { return (M_PENDATA ? M_PENDATA->m_colour : wxNullColour); };
-  inline int GetWidth(void) const { return (M_PENDATA ? M_PENDATA->m_width : 0); };
-  inline int GetStyle(void) const { return (M_PENDATA ? M_PENDATA->m_style : 0); };
-  inline int GetJoin(void) const { return (M_PENDATA ? M_PENDATA->m_join : 0); };
-  inline int GetCap(void) const { return (M_PENDATA ? M_PENDATA->m_cap : 0); };
-  inline int GetDashes(wxDash **ptr) const {
-     *ptr = (M_PENDATA ? M_PENDATA->m_dash : NULL); return (M_PENDATA ? M_PENDATA->m_nbDash : 0);
-  }
-
-  inline wxBitmap *GetStipple(void) const { return (M_PENDATA ? (& M_PENDATA->m_stipple) : NULL); };
-
-  // Internal
-  bool RealizeResource(void);
-  bool FreeResource(bool force = FALSE);
-  WXHANDLE GetResourceHandle(void) ;
-  bool IsFree(void);
+    wxPen();
+    wxPen(const wxColour& col, int width = 1, int style = wxSOLID);
+    wxPen(const wxBitmap& stipple, int width);
+    virtual ~wxPen();
+
+    bool operator==(const wxPen& pen) const
+    {
+        const wxPenRefData *penData = (wxPenRefData *)pen.m_refData;
+
+        // an invalid pen is only equal to another invalid pen
+        return m_refData ? penData && *M_PENDATA == *penData : !penData;
+    }
+
+    bool operator!=(const wxPen& pen) const { return !(*this == pen); }
+
+    virtual bool Ok() const { return (m_refData != NULL); }
+
+    // Override in order to recreate the pen
+    void SetColour(const wxColour& col);
+    void SetColour(unsigned char r, unsigned char g, unsigned char b);
+
+    void SetWidth(int width);
+    void SetStyle(int style);
+    void SetStipple(const wxBitmap& stipple);
+    void SetDashes(int nb_dashes, const wxDash *dash);
+    void SetJoin(int join);
+    void SetCap(int cap);
+
+    wxColour& GetColour() const { return (M_PENDATA ? M_PENDATA->m_colour : wxNullColour); };
+    int GetWidth() const { return (M_PENDATA ? M_PENDATA->m_width : 0); };
+    int GetStyle() const { return (M_PENDATA ? M_PENDATA->m_style : 0); };
+    int GetJoin() const { return (M_PENDATA ? M_PENDATA->m_join : 0); };
+    int GetCap() const { return (M_PENDATA ? M_PENDATA->m_cap : 0); };
+    int GetDashes(wxDash **ptr) const
+    {
+        *ptr = (M_PENDATA ? (wxDash*)M_PENDATA->m_dash : (wxDash*) NULL);
+        return (M_PENDATA ? M_PENDATA->m_nbDash : 0);
+    }
+    wxDash* GetDash() const { return (M_PENDATA ? (wxDash*)M_PENDATA->m_dash : (wxDash*)NULL); };
+    inline int GetDashCount() const { return (M_PENDATA ? M_PENDATA->m_nbDash : 0); };
+
+    inline wxBitmap *GetStipple() const { return (M_PENDATA ? (& M_PENDATA->m_stipple) : (wxBitmap*) NULL); };
+
+    // Internal
+    bool RealizeResource();
+    bool FreeResource(bool force = false);
+    WXHANDLE GetResourceHandle() const;
+    bool IsFree() const;
+    void Unshare();
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxPen)

 };
 
 };
 

-int wx2msPenStyle(int wx_style);
-
-#endif
-    // __PENH__
+#endif // _WX_PEN_H_