use wx-style header and commets; fix indentation to be 4 spaces; move Doxygen comment...

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

diff --git a/include/wx/cocoa/brush.h b/include/wx/cocoa/brush.h
index 205e7b7a2dea5e0d1406ed5286bf8f09b938c40d..eec16bc96d717b82f895bd87334d3ca27b535062 100644 (file)
--- a/include/wx/cocoa/brush.h
+++ b/include/wx/cocoa/brush.h
@@ -1,68 +1,66 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        brush.h
+// Name:        wx/cocoa/brush.h

 // Purpose:     wxBrush class
 // Purpose:     wxBrush class

-// Author:      AUTHOR
+// Author:      David Elliott <dfe@cox.net>

 // Modified by:
 // Modified by:

-// Created:     ??/??/98
+// Created:     2003/07/03

 // RCS-ID:      $Id$
 // RCS-ID:      $Id$

-// Copyright:   (c) AUTHOR
-// Licence:    wxWindows licence
+// Copyright:   (c) 2003 David Elliott
+// Licence:     wxWindows licence

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

-#ifndef _WX_BRUSH_H_
-#define _WX_BRUSH_H_
-
-#if defined(__GNUG__) && !defined(__APPLE__)
-#pragma interface "brush.h"
-#endif
+#ifndef __WX_COCOA_BRUSH_H__
+#define __WX_COCOA_BRUSH_H__

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

-class WXDLLEXPORT wxBrush;
+class WXDLLIMPEXP_FWD_CORE wxBrush;

 
 

-// Brush
-class WXDLLEXPORT wxBrush: public wxGDIObject
+// ========================================================================
+// wxBrush
+// ========================================================================
+class WXDLLEXPORT wxBrush: public wxBrushBase

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxBrush)
-
+    DECLARE_DYNAMIC_CLASS(wxBrush)
+// ------------------------------------------------------------------------
+// initialization
+// ------------------------------------------------------------------------

 public:
 public:

-  wxBrush();
-  wxBrush(const wxColour& col, int style);
-  wxBrush(const wxBitmap& stipple);
-  wxBrush(const wxBrush& brush)
-      : wxGDIObject()
-      { Ref(brush); }
-  ~wxBrush();
-
-  virtual void SetColour(const wxColour& col)  ;
-  virtual void SetColour(unsigned char r, unsigned char g, unsigned char b)  ;
-  virtual void SetStyle(int style)  ;
-  virtual void SetStipple(const wxBitmap& stipple)  ;
-
-  wxBrush& operator = (const wxBrush& brush)
-  { if (*this == brush) return (*this); Ref(brush); return *this; }
-  bool operator == (const wxBrush& brush)
-  { return m_refData == brush.m_refData; }
-  bool operator != (const wxBrush& brush)
-  { return m_refData != brush.m_refData; }
+    wxBrush();
+    wxBrush(const wxColour& col, wxBrushStyle style = wxBRUSHSTYLE_SOLID);
+#if FUTURE_WXWIN_COMPATIBILITY_3_0
+    wxDEPRECATED_FUTURE( wxBrush(const wxColour& col, int style) );
+#endif
+    wxBrush(const wxBitmap& stipple);
+    virtual ~wxBrush();

 
 

-  wxColour& GetColour() const ;
-  int GetStyle() const ;
-  wxBitmap *GetStipple() const ;
+// ------------------------------------------------------------------------
+// Implementation
+// ------------------------------------------------------------------------
+    virtual void SetColour(const wxColour& col) ;
+    virtual void SetColour(unsigned char r, unsigned char g, unsigned char b) ;
+    virtual void SetStyle(wxBrushStyle style) ;
+    virtual void SetStipple(const wxBitmap& stipple) ;

 
 

-  virtual bool Ok() const { return (m_refData != NULL) ; }
+    // comparison
+    bool operator == (const wxBrush& brush) const
+    {   return m_refData == brush.m_refData; }
+    bool operator != (const wxBrush& brush) const
+    {   return m_refData != brush.m_refData; }

 
 

-// Implementation
+    // accessors
+    wxColour GetColour() const;
+    virtual wxBrushStyle GetStyle() const;
+    wxBitmap *GetStipple() const;

 
 

-  // Useful helper: create the brush resource
-  bool RealizeResource();
+    // wxCocoa
+    WX_NSColor GetNSColor();

 
 

-  // When setting properties, we must make sure we're not changing
-  // another object
-  void Unshare();
+protected:
+    wxGDIRefData *CreateGDIRefData() const;
+    wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;

 };
 
 };
 

-#endif
-    // _WX_BRUSH_H_
+#endif // __WX_COCOA_BRUSH_H__