Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/pen.h b/include/wx/pen.h
index b94486f364297717e880d30f7b1191e2a905ce93..9210013b1f1a8234119e8e1c8838727fc4acf784 100644 (file)
--- a/include/wx/pen.h
+++ b/include/wx/pen.h
@@ -32,15 +32,14 @@ enum wxPenStyle
     wxPENSTYLE_STIPPLE_MASK = wxSTIPPLE_MASK,
     wxPENSTYLE_STIPPLE = wxSTIPPLE,
 
-    wxPENSTYLE_BDIAGONAL_HATCH = wxBDIAGONAL_HATCH,
-    wxPENSTYLE_CROSSDIAG_HATCH = wxCROSSDIAG_HATCH,
-    wxPENSTYLE_FDIAGONAL_HATCH = wxFDIAGONAL_HATCH,
-    wxPENSTYLE_CROSS_HATCH = wxCROSS_HATCH,
-    wxPENSTYLE_HORIZONTAL_HATCH = wxHORIZONTAL_HATCH,
-    wxPENSTYLE_VERTICAL_HATCH = wxVERTICAL_HATCH,
-
-    wxPENSTYLE_FIRST_HATCH = wxFIRST_HATCH,
-    wxPENSTYLE_LAST_HATCH = wxLAST_HATCH
+    wxPENSTYLE_BDIAGONAL_HATCH = wxHATCHSTYLE_BDIAGONAL,
+    wxPENSTYLE_CROSSDIAG_HATCH = wxHATCHSTYLE_CROSSDIAG,
+    wxPENSTYLE_FDIAGONAL_HATCH = wxHATCHSTYLE_FDIAGONAL,
+    wxPENSTYLE_CROSS_HATCH = wxHATCHSTYLE_CROSS,
+    wxPENSTYLE_HORIZONTAL_HATCH = wxHATCHSTYLE_HORIZONTAL,
+    wxPENSTYLE_VERTICAL_HATCH = wxHATCHSTYLE_VERTICAL,
+    wxPENSTYLE_FIRST_HATCH = wxHATCHSTYLE_FIRST,
+    wxPENSTYLE_LAST_HATCH = wxHATCHSTYLE_LAST
 };
 
 enum wxPenJoin
@@ -62,7 +61,7 @@ enum wxPenCap
 };
 
 
-class WXDLLEXPORT wxPenBase : public wxGDIObject
+class WXDLLIMPEXP_CORE wxPenBase : public wxGDIObject
 {
 public:
     virtual ~wxPenBase() { }
@@ -77,7 +76,7 @@ public:
     virtual void SetJoin(wxPenJoin join) = 0;
     virtual void SetCap(wxPenCap cap) = 0;
 
-    virtual wxColour& GetColour() const = 0;
+    virtual wxColour GetColour() const = 0;
     virtual wxBitmap *GetStipple() const = 0;
     virtual wxPenStyle GetStyle() const = 0;
     virtual wxPenJoin GetJoin() const = 0;
@@ -85,32 +84,36 @@ public:
     virtual int GetWidth() const = 0;
     virtual int GetDashes(wxDash **ptr) const = 0;
 
-#if FUTURE_WXWIN_COMPATIBILITY_3_0
-    wxDEPRECATED_FUTURE( void SetStyle(int style) )
-        { SetStyle((wxPenStyle)style); }
-#endif
+    // Convenient helpers for testing whether the pen is a transparent one:
+    // unlike GetStyle() == wxPENSTYLE_TRANSPARENT, they work correctly even if
+    // the pen is invalid (they both return false in this case).
+    bool IsTransparent() const
+    {
+        return IsOk() && GetStyle() == wxPENSTYLE_TRANSPARENT;
+    }
+
+    bool IsNonTransparent() const
+    {
+        return IsOk() && GetStyle() != wxPENSTYLE_TRANSPARENT;
+    }
 };
 
-#if defined(__WXPALMOS__)
-#include "wx/palmos/pen.h"
-#elif defined(__WXMSW__)
-#include "wx/msw/pen.h"
+#if defined(__WXMSW__)
+    #include "wx/msw/pen.h"
 #elif defined(__WXMOTIF__) || defined(__WXX11__)
-#include "wx/x11/pen.h"
+    #include "wx/x11/pen.h"
 #elif defined(__WXGTK20__)
-#include "wx/gtk/pen.h"
+    #include "wx/gtk/pen.h"
 #elif defined(__WXGTK__)
-#include "wx/gtk1/pen.h"
-#elif defined(__WXMGL__)
-#include "wx/mgl/pen.h"
+    #include "wx/gtk1/pen.h"
 #elif defined(__WXDFB__)
-#include "wx/dfb/pen.h"
+    #include "wx/dfb/pen.h"
 #elif defined(__WXMAC__)
-#include "wx/mac/pen.h"
+    #include "wx/osx/pen.h"
 #elif defined(__WXCOCOA__)
-#include "wx/cocoa/pen.h"
+    #include "wx/cocoa/pen.h"
 #elif defined(__WXPM__)
-#include "wx/os2/pen.h"
+    #include "wx/os2/pen.h"
 #endif
 
 class WXDLLIMPEXP_CORE wxPenList: public wxGDIObjListBase
@@ -130,7 +133,7 @@ public:
 #endif
 };
 
-extern WXDLLEXPORT_DATA(wxPenList*)   wxThePenList;
+extern WXDLLIMPEXP_DATA_CORE(wxPenList*)   wxThePenList;
 
 // provide comparison operators to allow code such as
 //
@@ -140,9 +143,14 @@ extern WXDLLEXPORT_DATA(wxPenList*)   wxThePenList;
 // compilers as it compares elements of different enums
 #if FUTURE_WXWIN_COMPATIBILITY_3_0
 
+// Unfortunately some compilers have ambiguity issues when enum comparisons are
+// overloaded so we have to disable the overloads in this case, see
+// wxCOMPILER_NO_OVERLOAD_ON_ENUM definition in wx/platform.h for more details.
+#ifndef wxCOMPILER_NO_OVERLOAD_ON_ENUM
+
 inline bool operator==(wxPenStyle s, wxDeprecatedGUIConstants t)
 {
-    return wx_static_cast(int, s) == wx_static_cast(int, t);
+    return static_cast<int>(s) == static_cast<int>(t);
 }
 
 inline bool operator!=(wxPenStyle s, wxDeprecatedGUIConstants t)
@@ -150,6 +158,8 @@ inline bool operator!=(wxPenStyle s, wxDeprecatedGUIConstants t)
     return !(s == t);
 }
 
+#endif // wxCOMPILER_NO_OVERLOAD_ON_ENUM
+
 #endif // FUTURE_WXWIN_COMPATIBILITY_3_0
 
 #endif // _WX_PEN_H_BASE_