Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/cocoa/pen.h b/include/wx/cocoa/pen.h
index 400d8d8ee5e202418fbd9209810ffcd6cb3b23b5..279f3d38949b5d27434e0b0bedb9a70e41726119 100644 (file)
--- a/include/wx/cocoa/pen.h
+++ b/include/wx/cocoa/pen.h
@@ -3,101 +3,71 @@
 // Purpose:     wxPen class
 // Author:      David Elliott
 // Modified by:
-// Created:     22.03.2003
+// Created:     2003/08/02 (stubs from 22.03.2003)
 // RCS-ID:      $Id$
 // Copyright:   (c) 2003 David Elliott
-// Licence:    wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef _WX_PEN_H_
-#define _WX_PEN_H_
-
-#if defined(__GNUG__) && !defined(__APPLE__)
-#pragma interface "pen.h"
-#endif
+#ifndef __WX_COCOA_PEN_H__
+#define __WX_COCOA_PEN_H__
 
 #include "wx/gdiobj.h"
-#include "wx/colour.h"
-#include "wx/bitmap.h"
+#include "wx/gdicmn.h"
 
-class WXDLLEXPORT wxPen;
+class WXDLLIMPEXP_FWD_CORE wxColour;
+class WXDLLIMPEXP_FWD_CORE wxBitmap;
 
-class WXDLLEXPORT wxPenRefData: public wxGDIRefData
+// ========================================================================
+// wxPen
+// ========================================================================
+class WXDLLIMPEXP_CORE wxPen: public wxGDIObject
 {
-    friend class WXDLLEXPORT wxPen;
 public:
-    wxPenRefData();
-    wxPenRefData(const wxPenRefData& data);
-    ~wxPenRefData();
+    wxPen();
+    wxPen(const wxColour& col, int width = 1, wxPenStyle style = wxPENSTYLE_SOLID);
+#if FUTURE_WXWIN_COMPATIBILITY_3_0
+    wxDEPRECATED_FUTURE( wxPen(const wxColour& col, int width, int style) );
+#endif
+    wxPen(const wxBitmap& stipple, int width);
+    virtual ~wxPen();
+
+    // FIXME: operator==() is wrong
+    bool operator==(const wxPen& pen) const { return m_refData == pen.m_refData; }
+    bool operator!=(const wxPen& pen) const { return !(*this == pen); }
+
+    void SetColour(const wxColour& col) ;
+    void SetColour(unsigned char r, unsigned char g, unsigned char b)  ;
+
+    void SetWidth(int width);
+    void SetStyle(wxPenStyle style);
+    void SetStipple(const wxBitmap& stipple);
+    void SetDashes(int nb_dashes, const wxDash *dash);
+    void SetJoin(wxPenJoin join);
+    void SetCap(wxPenCap cap);
+
+    wxColour GetColour() const;
+    int GetWidth() const;
+    wxPenStyle GetStyle() const;
+    wxPenJoin GetJoin() const;
+    wxPenCap GetCap() const;
+    int GetDashes(wxDash **ptr) const;
+    wxBitmap *GetStipple() const;
+
+#if FUTURE_WXWIN_COMPATIBILITY_3_0
+    wxDEPRECATED_FUTURE( void SetStyle(int style) )
+        { SetStyle((wxPenStyle)style); }
+#endif
 
-    wxPenRefData& operator=(const wxPenRefData& data);
+    // Cocoa-specific
+    WX_NSColor GetNSColor();
+    int GetCocoaLineDash(const CGFloat **pattern);
 
 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;
-/* TODO: implementation
-  WXHPEN        m_hPen;
-*/
-};
-
-#define M_PENDATA ((wxPenRefData *)m_refData)
-
-// Pen
-class WXDLLEXPORT wxPen: public wxGDIObject
-{
-  DECLARE_DYNAMIC_CLASS(wxPen)
-public:
-  wxPen();
-  wxPen(const wxColour& col, int width = 1, int style = wxSOLID);
-  wxPen(const wxBitmap& stipple, int width);
-  wxPen(const wxPen& pen)
-      : wxGDIObject()
-      { Ref(pen); }
-  ~wxPen();
+    wxGDIRefData *CreateGDIRefData() const;
+    wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
 
-  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() 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)  ;
-
-  inline wxColour& GetColour() const { return (M_PENDATA ? M_PENDATA->m_colour : wxNullColour); };
-  inline int GetWidth() const { return (M_PENDATA ? M_PENDATA->m_width : 0); };
-  inline int GetStyle() const { return (M_PENDATA ? M_PENDATA->m_style : 0); };
-  inline int GetJoin() const { return (M_PENDATA ? M_PENDATA->m_join : 0); };
-  inline int GetCap() const { return (M_PENDATA ? M_PENDATA->m_cap : 0); };
-  inline int GetDashes(wxDash **ptr) const {
-     *ptr = (M_PENDATA ? M_PENDATA->m_dash : (wxDash*) NULL); return (M_PENDATA ? M_PENDATA->m_nbDash : 0);
-  }
-
-  inline wxBitmap *GetStipple() const { return (M_PENDATA ? (& M_PENDATA->m_stipple) : (wxBitmap*) NULL); };
-
-// Implementation
-
-  // Useful helper: create the brush resource
-  bool RealizeResource();
-
-  // When setting properties, we must make sure we're not changing
-  // another object
-  void Unshare();
+    DECLARE_DYNAMIC_CLASS(wxPen)
 };
 
-#endif
-    // _WX_PEN_H_
+#endif // __WX_COCOA_PEN_H__