cleanup - added whitespace around operators, some blank lines, fixed comment typos...

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

diff --git a/include/wx/gdicmn.h b/include/wx/gdicmn.h
index 029ce3def33f3a1ab6b4c95751752c79ece5b359..f823993b03a36a6535e70121edc024b0b0ac0b4e 100644 (file)
--- a/include/wx/gdicmn.h
+++ b/include/wx/gdicmn.h
@@ -1,11 +1,11 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     Common GDI classes, types and declarations
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Purpose:     Common GDI classes, types and declarations
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c)
+// Copyright:   (c) Julian Smart

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 


@@ -16,15 +16,12 @@
 // headers
 // ---------------------------------------------------------------------------
 
 // headers
 // ---------------------------------------------------------------------------
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "gdicmn.h"
-#endif
-
-#include "wx/setup.h"
+#include "wx/defs.h"

 #include "wx/list.h"
 #include "wx/string.h"
 #include "wx/fontenc.h"
 #include "wx/hashmap.h"
 #include "wx/list.h"
 #include "wx/string.h"
 #include "wx/fontenc.h"
 #include "wx/hashmap.h"

+#include "wx/math.h"

 
 // ---------------------------------------------------------------------------
 // forward declarations
 
 // ---------------------------------------------------------------------------
 // forward declarations


@@ -117,7 +114,7 @@ enum wxStockCursor
     wxCURSOR_DEFAULT, // standard X11 cursor
 #endif
 #ifdef __WXMAC__
     wxCURSOR_DEFAULT, // standard X11 cursor
 #endif
 #ifdef __WXMAC__

-       wxCURSOR_COPY_ARROW , // MacOS Theme Plus arrow
+    wxCURSOR_COPY_ARROW , // MacOS Theme Plus arrow

 #endif
 #ifdef __X__
     // Not yet implemented for Windows
 #endif
 #ifdef __X__
     // Not yet implemented for Windows


@@ -182,7 +179,12 @@ enum wxStockCursor
 
 #if defined(__WXMSW__) || defined(__WXPM__)
     #define wxBITMAP(name) wxBitmap(wxT(#name), wxBITMAP_TYPE_RESOURCE)
 
 #if defined(__WXMSW__) || defined(__WXPM__)
     #define wxBITMAP(name) wxBitmap(wxT(#name), wxBITMAP_TYPE_RESOURCE)

-#elif defined(__WXGTK__) || defined(__WXMOTIF__) || defined(__WXX11__) || defined(__WXMAC__) || defined(__WXMGL__) || defined(__WXCOCOA__)
+#elif defined(__WXGTK__)   || \
+      defined(__WXMOTIF__) || \
+      defined(__WXX11__)   || \
+      defined(__WXMAC__)   || \
+      defined(__WXMGL__)   || \
+      defined(__WXCOCOA__)

     // Initialize from an included XPM
     #define wxBITMAP(name) wxBitmap( (const char**) name##_xpm )
 #else // other platforms
     // Initialize from an included XPM
     #define wxBITMAP(name) wxBitmap( (const char**) name##_xpm )
 #else // other platforms


@@ -212,9 +214,15 @@ public:
     bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }
     bool operator!=(const wxSize& sz) const { return x != sz.x || y != sz.y; }
 
     bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }
     bool operator!=(const wxSize& sz) const { return x != sz.x || y != sz.y; }
 

-    // FIXME are these really useful? If they're, we should have += &c as well
-    wxSize operator+(const wxSize& sz) { return wxSize(x + sz.x, y + sz.y); }
-    wxSize operator-(const wxSize& sz) { return wxSize(x - sz.x, y - sz.y); }
+    wxSize operator+(const wxSize& sz) const { return wxSize(x + sz.x, y + sz.y); }
+    wxSize operator-(const wxSize& sz) const { return wxSize(x - sz.x, y - sz.y); }
+    wxSize operator/(int i) const { return wxSize(x / i, y / i); }
+    wxSize operator*(int i) const { return wxSize(x * i, y * i); }
+
+    wxSize& operator+=(const wxSize& sz) { x += sz.x; y += sz.y; return *this; }
+    wxSize& operator-=(const wxSize& sz) { x -= sz.x; y -= sz.y; return *this; }
+    wxSize& operator/=(const int i) { x /= i; y /= i; return *this; }
+    wxSize& operator*=(const int i) { x *= i; y *= i; return *this; }

 
     void IncTo(const wxSize& sz)
         { if ( sz.x > x ) x = sz.x; if ( sz.y > y ) y = sz.y; }
 
     void IncTo(const wxSize& sz)
         { if ( sz.x > x ) x = sz.x; if ( sz.y > y ) y = sz.y; }


@@ -229,15 +237,15 @@ public:
     int GetWidth() const { return x; }
     int GetHeight() const { return y; }
 
     int GetWidth() const { return x; }
     int GetHeight() const { return y; }
 

-    bool IsFullySpecified() const { return x != -1 && y != -1; }
+    bool IsFullySpecified() const { return x != wxDefaultCoord && y != wxDefaultCoord; }

 
     // combine this size with the other one replacing the default (i.e. equal
 
     // combine this size with the other one replacing the default (i.e. equal

-    // to -1) components of this object with those of the other
+    // to wxDefaultCoord) components of this object with those of the other

     void SetDefaults(const wxSize& size)
     {
     void SetDefaults(const wxSize& size)
     {

-        if ( x == -1 )
+        if ( x == wxDefaultCoord )

             x = size.x;
             x = size.x;

-        if ( y == -1 )
+        if ( y == wxDefaultCoord )

             y = size.y;
     }
 
             y = size.y;
     }
 


@@ -262,10 +270,14 @@ public:
     wxRealPoint operator+(const wxRealPoint& pt) const { return wxRealPoint(x + pt.x, y + pt.y); }
     wxRealPoint operator-(const wxRealPoint& pt) const { return wxRealPoint(x - pt.x, y - pt.y); }
 
     wxRealPoint operator+(const wxRealPoint& pt) const { return wxRealPoint(x + pt.x, y + pt.y); }
     wxRealPoint operator-(const wxRealPoint& pt) const { return wxRealPoint(x - pt.x, y - pt.y); }
 

-    bool operator==(const wxRealPoint& pt) const { return x == pt.x && y == pt.y; }
-    bool operator!=(const wxRealPoint& pt) const { return x != pt.x || y != pt.y; }
+    bool operator==(const wxRealPoint& pt) const
+    {
+        return wxIsSameDouble(x, pt.x) && wxIsSameDouble(y, pt.y);
+    }
+    bool operator!=(const wxRealPoint& pt) const { return !(*this == pt); }

 };
 
 };
 

+

 class WXDLLEXPORT wxPoint
 {
 public:
 class WXDLLEXPORT wxPoint
 {
 public:


@@ -308,7 +320,12 @@ public:
         : x(xx), y(yy), width(ww), height(hh)
         { }
     wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
         : x(xx), y(yy), width(ww), height(hh)
         { }
     wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);

-    wxRect(const wxPoint& pos, const wxSize& size);
+    wxRect(const wxPoint& pt, const wxSize& size)
+        : x(pt.x), y(pt.y), width(size.x), height(size.y)
+        { }
+    wxRect(const wxSize& size)
+        : x(0), y(0), width(size.x), height(size.y)
+        { }

 
     // default copy ctor and assignment operators ok
 
 
     // default copy ctor and assignment operators ok
 


@@ -330,6 +347,8 @@ public:
     wxSize GetSize() const { return wxSize(width, height); }
     void SetSize( const wxSize &s ) { width = s.GetWidth(); height = s.GetHeight(); }
 
     wxSize GetSize() const { return wxSize(width, height); }
     void SetSize( const wxSize &s ) { width = s.GetWidth(); height = s.GetHeight(); }
 

+    bool IsEmpty() const { return (width <= 0) || (height <= 0); }
+

     wxPoint GetTopLeft() const { return GetPosition(); }
     wxPoint GetLeftTop() const { return GetTopLeft(); }
     void SetTopLeft(const wxPoint &p) { SetPosition(p); }
     wxPoint GetTopLeft() const { return GetPosition(); }
     wxPoint GetLeftTop() const { return GetTopLeft(); }
     void SetTopLeft(const wxPoint &p) { SetPosition(p); }


@@ -380,20 +399,49 @@ public:
         return r;
     }
 
         return r;
     }
 

-    wxRect operator+(const wxRect& rect) const;
-    wxRect& operator+=(const wxRect& rect);
+    wxRect& Union(const wxRect& rect);
+    wxRect Union(const wxRect& rect) const
+    {
+        wxRect r = *this;
+        r.Union(rect);
+        return r;
+    }

 
     // compare rectangles
     bool operator==(const wxRect& rect) const;
     bool operator!=(const wxRect& rect) const { return !(*this == rect); }
 
 
     // compare rectangles
     bool operator==(const wxRect& rect) const;
     bool operator!=(const wxRect& rect) const { return !(*this == rect); }
 

-    // return TRUE if the point is (not strcitly) inside the rect
+    // return true if the point is (not strcitly) inside the rect

     bool Inside(int x, int y) const;
     bool Inside(const wxPoint& pt) const { return Inside(pt.x, pt.y); }
 
     bool Inside(int x, int y) const;
     bool Inside(const wxPoint& pt) const { return Inside(pt.x, pt.y); }
 

-    // return TRUE if the rectangles have a non empty intersection
+    // return true if the rectangles have a non empty intersection

     bool Intersects(const wxRect& rect) const;
 
     bool Intersects(const wxRect& rect) const;
 

+
+    // these are like Union() but don't ignore empty rectangles
+    wxRect operator+(const wxRect& rect) const;
+    wxRect& operator+=(const wxRect& rect)
+    {
+        *this = *this + rect;
+        return *this;
+    }
+
+
+    // centre this rectangle in the given (usually, but not necessarily,
+    // larger) one
+    wxRect CentreIn(const wxRect& r, int dir = wxBOTH) const
+    {
+        return wxRect(dir & wxHORIZONTAL ? r.x + (r.width - width)/2 : x,
+                      dir & wxVERTICAL ? r.y + (r.height - height)/2 : y,
+                      width, height);
+    }
+
+    wxRect CenterIn(const wxRect& r, int dir = wxBOTH) const
+    {
+        return CentreIn(r, dir);
+    }
+

 public:
     int x, y, width, height;
 };
 public:
     int x, y, width, height;
 };


@@ -423,7 +471,7 @@ public:
 
     void AddBrush(wxBrush *brush);
     void RemoveBrush(wxBrush *brush);
 
     void AddBrush(wxBrush *brush);
     void RemoveBrush(wxBrush *brush);

-    wxBrush *FindOrCreateBrush(const wxColour& colour, int style);
+    wxBrush *FindOrCreateBrush(const wxColour& colour, int style = wxSOLID);

 };
 
 class WXDLLEXPORT wxFontList : public wxList
 };
 
 class WXDLLEXPORT wxFontList : public wxList


@@ -435,7 +483,7 @@ public:
     void AddFont(wxFont *font);
     void RemoveFont(wxFont *font);
     wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
     void AddFont(wxFont *font);
     void RemoveFont(wxFont *font);
     wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,

-                             bool underline = FALSE,
+                             bool underline = false,

                              const wxString& face = wxEmptyString,
                              wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 };
                              const wxString& face = wxEmptyString,
                              wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 };


@@ -455,8 +503,10 @@ public:
     // add a new colour to the database
     void AddColour(const wxString& name, const wxColour& colour);
 
     // add a new colour to the database
     void AddColour(const wxString& name, const wxColour& colour);
 

+#if WXWIN_COMPATIBILITY_2_6

     // deprecated, use Find() instead
     wxDEPRECATED( wxColour *FindColour(const wxString& name) );
     // deprecated, use Find() instead
     wxDEPRECATED( wxColour *FindColour(const wxString& name) );

+#endif // WXWIN_COMPATIBILITY_2_6

 
 
 #ifdef __WXPM__
 
 
 #ifdef __WXPM__


@@ -476,7 +526,7 @@ private:
 class WXDLLEXPORT wxBitmapList : public wxList
 {
 public:
 class WXDLLEXPORT wxBitmapList : public wxList
 {
 public:

-    wxBitmapList();
+    wxBitmapList(){}

     ~wxBitmapList();
 
     void AddBitmap(wxBitmap *bitmap);
     ~wxBitmapList();
 
     void AddBitmap(wxBitmap *bitmap);


@@ -498,71 +548,71 @@ public:
 // ---------------------------------------------------------------------------
 
 // Lists of GDI objects
 // ---------------------------------------------------------------------------
 
 // Lists of GDI objects

-WXDLLEXPORT_DATA(extern wxPenList*)   wxThePenList;
-WXDLLEXPORT_DATA(extern wxBrushList*)   wxTheBrushList;
-WXDLLEXPORT_DATA(extern wxFontList*)    wxTheFontList;
-WXDLLEXPORT_DATA(extern wxBitmapList*)  wxTheBitmapList;
+extern WXDLLEXPORT_DATA(wxPenList*)   wxThePenList;
+extern WXDLLEXPORT_DATA(wxBrushList*)   wxTheBrushList;
+extern WXDLLEXPORT_DATA(wxFontList*)    wxTheFontList;
+extern WXDLLEXPORT_DATA(wxBitmapList*)  wxTheBitmapList;

 
 // Stock objects
 
 // Stock objects

-WXDLLEXPORT_DATA(extern wxFont*)      wxNORMAL_FONT;
-WXDLLEXPORT_DATA(extern wxFont*)      wxSMALL_FONT;
-WXDLLEXPORT_DATA(extern wxFont*)      wxITALIC_FONT;
-WXDLLEXPORT_DATA(extern wxFont*)      wxSWISS_FONT;
-
-WXDLLEXPORT_DATA(extern wxPen*)      wxRED_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxCYAN_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxGREEN_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxWHITE_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxTRANSPARENT_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_DASHED_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxGREY_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxMEDIUM_GREY_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxLIGHT_GREY_PEN;
-
-WXDLLEXPORT_DATA(extern wxBrush*)    wxBLUE_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxGREEN_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxWHITE_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxBLACK_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxGREY_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxMEDIUM_GREY_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxLIGHT_GREY_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxTRANSPARENT_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxCYAN_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxRED_BRUSH;
-
-WXDLLEXPORT_DATA(extern wxColour*)    wxBLACK;
-WXDLLEXPORT_DATA(extern wxColour*)    wxWHITE;
-WXDLLEXPORT_DATA(extern wxColour*)    wxRED;
-WXDLLEXPORT_DATA(extern wxColour*)    wxBLUE;
-WXDLLEXPORT_DATA(extern wxColour*)    wxGREEN;
-WXDLLEXPORT_DATA(extern wxColour*)    wxCYAN;
-WXDLLEXPORT_DATA(extern wxColour*)    wxLIGHT_GREY;
+extern WXDLLEXPORT_DATA(wxFont*)      wxNORMAL_FONT;
+extern WXDLLEXPORT_DATA(wxFont*)      wxSMALL_FONT;
+extern WXDLLEXPORT_DATA(wxFont*)      wxITALIC_FONT;
+extern WXDLLEXPORT_DATA(wxFont*)      wxSWISS_FONT;
+
+extern WXDLLEXPORT_DATA(wxPen*)      wxRED_PEN;
+extern WXDLLEXPORT_DATA(wxPen*)      wxCYAN_PEN;
+extern WXDLLEXPORT_DATA(wxPen*)      wxGREEN_PEN;
+extern WXDLLEXPORT_DATA(wxPen*)      wxBLACK_PEN;
+extern WXDLLEXPORT_DATA(wxPen*)      wxWHITE_PEN;
+extern WXDLLEXPORT_DATA(wxPen*)      wxTRANSPARENT_PEN;
+extern WXDLLEXPORT_DATA(wxPen*)      wxBLACK_DASHED_PEN;
+extern WXDLLEXPORT_DATA(wxPen*)      wxGREY_PEN;
+extern WXDLLEXPORT_DATA(wxPen*)      wxMEDIUM_GREY_PEN;
+extern WXDLLEXPORT_DATA(wxPen*)      wxLIGHT_GREY_PEN;
+
+extern WXDLLEXPORT_DATA(wxBrush*)    wxBLUE_BRUSH;
+extern WXDLLEXPORT_DATA(wxBrush*)    wxGREEN_BRUSH;
+extern WXDLLEXPORT_DATA(wxBrush*)    wxWHITE_BRUSH;
+extern WXDLLEXPORT_DATA(wxBrush*)    wxBLACK_BRUSH;
+extern WXDLLEXPORT_DATA(wxBrush*)    wxGREY_BRUSH;
+extern WXDLLEXPORT_DATA(wxBrush*)    wxMEDIUM_GREY_BRUSH;
+extern WXDLLEXPORT_DATA(wxBrush*)    wxLIGHT_GREY_BRUSH;
+extern WXDLLEXPORT_DATA(wxBrush*)    wxTRANSPARENT_BRUSH;
+extern WXDLLEXPORT_DATA(wxBrush*)    wxCYAN_BRUSH;
+extern WXDLLEXPORT_DATA(wxBrush*)    wxRED_BRUSH;
+
+extern WXDLLEXPORT_DATA(wxColour*)    wxBLACK;
+extern WXDLLEXPORT_DATA(wxColour*)    wxWHITE;
+extern WXDLLEXPORT_DATA(wxColour*)    wxRED;
+extern WXDLLEXPORT_DATA(wxColour*)    wxBLUE;
+extern WXDLLEXPORT_DATA(wxColour*)    wxGREEN;
+extern WXDLLEXPORT_DATA(wxColour*)    wxCYAN;
+extern WXDLLEXPORT_DATA(wxColour*)    wxLIGHT_GREY;

 
 // 'Null' objects
 
 // 'Null' objects

-WXDLLEXPORT_DATA(extern wxBitmap)     wxNullBitmap;
-WXDLLEXPORT_DATA(extern wxIcon)       wxNullIcon;
-WXDLLEXPORT_DATA(extern wxCursor)     wxNullCursor;
-WXDLLEXPORT_DATA(extern wxPen)        wxNullPen;
-WXDLLEXPORT_DATA(extern wxBrush)      wxNullBrush;
-WXDLLEXPORT_DATA(extern wxPalette)     wxNullPalette;
-WXDLLEXPORT_DATA(extern wxFont)       wxNullFont;
-WXDLLEXPORT_DATA(extern wxColour)     wxNullColour;
+extern WXDLLEXPORT_DATA(wxBitmap)     wxNullBitmap;
+extern WXDLLEXPORT_DATA(wxIcon)       wxNullIcon;
+extern WXDLLEXPORT_DATA(wxCursor)     wxNullCursor;
+extern WXDLLEXPORT_DATA(wxPen)        wxNullPen;
+extern WXDLLEXPORT_DATA(wxBrush)      wxNullBrush;
+extern WXDLLEXPORT_DATA(wxPalette)     wxNullPalette;
+extern WXDLLEXPORT_DATA(wxFont)       wxNullFont;
+extern WXDLLEXPORT_DATA(wxColour)     wxNullColour;

 
 // Stock cursors types
 
 // Stock cursors types

-WXDLLEXPORT_DATA(extern wxCursor*)    wxSTANDARD_CURSOR;
-WXDLLEXPORT_DATA(extern wxCursor*)    wxHOURGLASS_CURSOR;
-WXDLLEXPORT_DATA(extern wxCursor*)    wxCROSS_CURSOR;
+extern WXDLLEXPORT_DATA(wxCursor*)    wxSTANDARD_CURSOR;
+extern WXDLLEXPORT_DATA(wxCursor*)    wxHOURGLASS_CURSOR;
+extern WXDLLEXPORT_DATA(wxCursor*)    wxCROSS_CURSOR;

 
 

-WXDLLEXPORT_DATA(extern wxColourDatabase*)  wxTheColourDatabase;
+extern WXDLLEXPORT_DATA(wxColourDatabase*)  wxTheColourDatabase;

 
 

-WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
+extern WXDLLEXPORT_DATA(const wxChar) wxPanelNameStr[];

 
 

-WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
-WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
+extern WXDLLEXPORT_DATA(const wxSize) wxDefaultSize;
+extern WXDLLEXPORT_DATA(const wxPoint) wxDefaultPosition;

 
 // The list of objects which should be deleted
 
 // The list of objects which should be deleted

-WXDLLEXPORT_DATA(extern wxList) wxPendingDelete;
+extern WXDLLEXPORT_DATA(wxList) wxPendingDelete;

 
 // ---------------------------------------------------------------------------
 // global functions
 
 // ---------------------------------------------------------------------------
 // global functions