fixed outdated filenames

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

diff --git a/include/wx/gdicmn.h b/include/wx/gdicmn.h
index 6ec915655636d7dd0ca1586667b95d8e078399a9..d8d1bb44d660012fdc37b03d71abb2906e68485c 100644 (file)
--- a/include/wx/gdicmn.h
+++ b/include/wx/gdicmn.h
@@ -26,6 +26,7 @@
 #include "wx/string.h"
 #include "wx/setup.h"
 #include "wx/colour.h"
 #include "wx/string.h"
 #include "wx/setup.h"
 #include "wx/colour.h"

+#include "wx/font.h"

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


@@ -47,9 +48,10 @@ class WXDLLEXPORT wxString;
 // ---------------------------------------------------------------------------
 
 // Bitmap flags
 // ---------------------------------------------------------------------------
 
 // Bitmap flags

-enum
+enum wxBitmapType

 {
 {

-    wxBITMAP_TYPE_BMP = 1,
+    wxBITMAP_TYPE_INVALID,          // should be == 0 for compatibility!
+    wxBITMAP_TYPE_BMP,

     wxBITMAP_TYPE_BMP_RESOURCE,
     wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
     wxBITMAP_TYPE_ICO,
     wxBITMAP_TYPE_BMP_RESOURCE,
     wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
     wxBITMAP_TYPE_ICO,


@@ -68,6 +70,18 @@ enum
     wxBITMAP_TYPE_PNG_RESOURCE,
     wxBITMAP_TYPE_JPEG,
     wxBITMAP_TYPE_JPEG_RESOURCE,
     wxBITMAP_TYPE_PNG_RESOURCE,
     wxBITMAP_TYPE_JPEG,
     wxBITMAP_TYPE_JPEG_RESOURCE,

+    wxBITMAP_TYPE_PNM,
+    wxBITMAP_TYPE_PNM_RESOURCE,
+    wxBITMAP_TYPE_PCX,
+    wxBITMAP_TYPE_PCX_RESOURCE,
+    wxBITMAP_TYPE_PICT,
+    wxBITMAP_TYPE_PICT_RESOURCE,
+    wxBITMAP_TYPE_ICON,
+    wxBITMAP_TYPE_ICON_RESOURCE,
+    wxBITMAP_TYPE_ANI,
+    wxBITMAP_TYPE_IFF,
+    wxBITMAP_TYPE_MACCURSOR,
+    wxBITMAP_TYPE_MACCURSOR_RESOURCE,

     wxBITMAP_TYPE_ANY = 50
 };
 
     wxBITMAP_TYPE_ANY = 50
 };
 


@@ -76,6 +90,7 @@ enum wxStockCursor
 {
     wxCURSOR_NONE,          // should be 0
     wxCURSOR_ARROW,
 {
     wxCURSOR_NONE,          // should be 0
     wxCURSOR_ARROW,

+    wxCURSOR_RIGHT_ARROW,

     wxCURSOR_BULLSEYE,
     wxCURSOR_CHAR,
     wxCURSOR_CROSS,
     wxCURSOR_BULLSEYE,
     wxCURSOR_CHAR,
     wxCURSOR_CROSS,


@@ -100,6 +115,9 @@ enum wxStockCursor
     wxCURSOR_WAIT,
     wxCURSOR_WATCH,
     wxCURSOR_BLANK,
     wxCURSOR_WAIT,
     wxCURSOR_WATCH,
     wxCURSOR_BLANK,

+#ifdef __WXGTK__
+    wxCURSOR_DEFAULT, // standard X11 cursor
+#endif

 #ifdef __X__
     // Not yet implemented for Windows
     wxCURSOR_CROSS_REVERSE,
 #ifdef __X__
     // Not yet implemented for Windows
     wxCURSOR_CROSS_REVERSE,


@@ -108,9 +126,15 @@ enum wxStockCursor
     wxCURSOR_BASED_ARROW_DOWN,
 #endif // X11
 
     wxCURSOR_BASED_ARROW_DOWN,
 #endif // X11
 

+    wxCURSOR_ARROWWAIT,
+

     wxCURSOR_MAX
 };
 
     wxCURSOR_MAX
 };
 

+#ifndef __WXGTK__
+    #define wxCURSOR_DEFAULT wxCURSOR_ARROW
+#endif
+

 // ---------------------------------------------------------------------------
 // macros
 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------
 // macros
 // ---------------------------------------------------------------------------


@@ -128,17 +152,42 @@ enum wxStockCursor
 #ifdef __WXMSW__
     // Load from a resource
     #define wxICON(X) wxIcon("" #X "")
 #ifdef __WXMSW__
     // Load from a resource
     #define wxICON(X) wxIcon("" #X "")

+#elif defined(__WXPM__)
+    // Load from a resource
+    #define wxICON(X) wxIcon("" #X "")
+#elif defined(__WXMGL__)
+    // Initialize from an included XPM
+    #define wxICON(X) wxIcon( (const char**) X##_xpm )

 #elif defined(__WXGTK__)
     // Initialize from an included XPM
     #define wxICON(X) wxIcon( (const char**) X##_xpm )
 #elif defined(__WXGTK__)
     // Initialize from an included XPM
     #define wxICON(X) wxIcon( (const char**) X##_xpm )

+#elif defined(__WXMAC__)
+    // Initialize from an included XPM
+    #define wxICON(X) wxIcon( (const char**) X##_xpm )

 #elif defined(__WXMOTIF__)
     // Initialize from an included XPM
     #define wxICON(X) wxIcon( X##_xpm )
 #elif defined(__WXMOTIF__)
     // Initialize from an included XPM
     #define wxICON(X) wxIcon( X##_xpm )

+#elif defined(__WXX11__)
+    // Initialize from an included XPM
+    #define wxICON(X) wxIcon( X##_xpm )

 #else
     // This will usually mean something on any platform
     #define wxICON(X) wxIcon("" #X "")
 #endif // platform
 
 #else
     // This will usually mean something on any platform
     #define wxICON(X) wxIcon("" #X "")
 #endif // platform
 

+/* Another macro: this one is for portable creation of bitmaps. We assume that
+   under Unix bitmaps live in XPMs and under Windows they're in ressources.
+ */
+
+#if defined(__WXMSW__) || defined(__WXPM__)
+    #define wxBITMAP(name) wxBitmap(#name, wxBITMAP_TYPE_RESOURCE)
+#elif defined(__WXGTK__) || defined(__WXMOTIF__) || defined(__WXX11__) || defined(__WXMAC__) || defined(__WXMGL__)
+    // Initialize from an included XPM
+    #define wxBITMAP(name) wxBitmap( (const char**) name##_xpm )
+#else // other platforms
+    #define wxBITMAP(name) wxBitmap(name##_xpm, wxBITMAP_TYPE_XPM)
+#endif // platform
+

 // ===========================================================================
 // classes
 // ===========================================================================
 // ===========================================================================
 // classes
 // ===========================================================================


@@ -146,34 +195,45 @@ enum wxStockCursor
 // ---------------------------------------------------------------------------
 // wxSize
 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------
 // wxSize
 // ---------------------------------------------------------------------------

+

 class WXDLLEXPORT wxSize
 {
 public:
 class WXDLLEXPORT wxSize
 {
 public:

-    // members are public for compatibility
-    long x;
-    long y;
+    // members are public for compatibility (don't use them directly,
+    // especially that there names were chosen very unfortunately - they should
+    // have been called width and height)
+    int x, y;

 
     // constructors
     wxSize() { x = y = 0; }
 
     // constructors
     wxSize() { x = y = 0; }

-    wxSize(long xx, long yy) { Set(xx, yy); }
+    wxSize(int xx, int yy) { Set(xx, yy); }

 
     // no copy ctor or assignment operator - the defaults are ok
 
     bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }
 
     // no copy ctor or assignment operator - the defaults are ok
 
     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); }
 
 
     // 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); }
 

-    void Set(long xx, long yy) { x = xx; y = yy; }
+    // accessors
+    void Set(int xx, int yy) { x = xx; y = yy; }
+    void SetWidth(int w) { x = w; }
+    void SetHeight(int h) { y = h; }

 
 

-    long GetX() const { return x; }
-    long GetY() const { return y; }
+    int GetWidth() const { return x; }
+    int GetHeight() const { return y; }
+
+    // compatibility
+    int GetX() const { return x; }
+    int GetY() const { return y; }

 };
 
 // ---------------------------------------------------------------------------
 // Point classes: with real or integer coordinates
 // ---------------------------------------------------------------------------
 };
 
 // ---------------------------------------------------------------------------
 // Point classes: with real or integer coordinates
 // ---------------------------------------------------------------------------

+

 class WXDLLEXPORT wxRealPoint
 {
 public:
 class WXDLLEXPORT wxRealPoint
 {
 public:


@@ -183,8 +243,8 @@ public:
     wxRealPoint() { x = y = 0.0; };
     wxRealPoint(double xx, double yy) { x = xx; y = yy; };
 
     wxRealPoint() { x = y = 0.0; };
     wxRealPoint(double xx, double yy) { x = xx; y = yy; };
 

-    wxRealPoint operator+(const wxRealPoint& pt) { return wxRealPoint(x + pt.x, y + pt.y); }
-    wxRealPoint operator-(const wxRealPoint& pt) { 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; }
 };


@@ -192,23 +252,23 @@ public:
 class WXDLLEXPORT wxPoint
 {
 public:
 class WXDLLEXPORT wxPoint
 {
 public:

-#if defined(__WXMSW__) && !defined(__WIN32__)
-    int x;
-    int y;
-#else
-    long x;
-    long y;
-#endif
+    int x, y;

 
     wxPoint() { x = y = 0; };
 
     wxPoint() { x = y = 0; };

-    wxPoint(long xx, long yy) { x = xx; y = yy; };
+    wxPoint(int xx, int yy) { x = xx; y = yy; };

 
     // no copy ctor or assignment operator - the defaults are ok
 
 
     // no copy ctor or assignment operator - the defaults are ok
 

-    bool operator==(const wxPoint& pt) const { return x == pt.x && y == pt.y; }
+    // comparison
+    bool operator==(const wxPoint& p) const { return x == p.x && y == p.y; }
+    bool operator!=(const wxPoint& p) const { return !(*this == p); }

 
 

-    wxPoint operator + (const wxPoint& pt) { return wxPoint(x + pt.x, y + pt.y); }
-    wxPoint operator - (const wxPoint& pt) { return wxPoint(x - pt.x, y - pt.y); }
+    // arithmetic operations (component wise)
+    wxPoint operator+(const wxPoint& p) const { return wxPoint(x + p.x, y + p.y); }
+    wxPoint operator-(const wxPoint& p) const { return wxPoint(x - p.x, y - p.y); }
+
+    wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
+    wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }

 };
 
 #if WXWIN_COMPATIBILITY
 };
 
 #if WXWIN_COMPATIBILITY


@@ -223,44 +283,93 @@ public:
 class WXDLLEXPORT wxRect
 {
 public:
 class WXDLLEXPORT wxRect
 {
 public:

-    wxRect();
-    wxRect(long x, long y, long w, long h);
+    wxRect() { x = y = width = height = 0; }
+    wxRect(int xx, int yy, int ww, int hh)
+        { 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& topLeft, const wxPoint& bottomRight);
     wxRect(const wxPoint& pos, const wxSize& size);

-    wxRect(const wxRect& rect);
-
-    long GetX() const { return x; }
-    void SetX(long xx) { x = xx; }

 
 

-    long GetY() const { return y; }
-    void SetY(long yy) { y = yy; }
-
-    long GetWidth() const { return width; }
-    void SetWidth(long w) { width = w; }
-
-    long GetHeight() const { return height; }
-    void SetHeight(long h) { height = h; }
-
-    wxPoint GetPosition() { return wxPoint(x, y); }
-    wxSize GetSize() { return wxSize(width, height); }
-
-    long GetLeft()   const { return x; }
-    long GetTop()    const { return y; }
-    long GetBottom() const { return y + height; }
-    long GetRight()  const { return x + width; }
-
-    wxRect& operator = (const wxRect& rect);
-    bool operator == (const wxRect& rect);
-    bool operator != (const wxRect& rect);
+    // default copy ctor and assignment operators ok
+
+    int GetX() const { return x; }
+    void SetX(int xx) { x = xx; }
+
+    int GetY() const { return y; }
+    void SetY(int yy) { y = yy; }
+
+    int GetWidth() const { return width; }
+    void SetWidth(int w) { width = w; }
+
+    int GetHeight() const { return height; }
+    void SetHeight(int h) { height = h; }
+
+    wxPoint GetPosition() const { return wxPoint(x, y); }
+    wxSize GetSize() const { return wxSize(width, height); }
+
+    int GetLeft()   const { return x; }
+    int GetTop()    const { return y; }
+    int GetBottom() const { return y + height - 1; }
+    int GetRight()  const { return x + width - 1; }
+
+    void SetLeft(int left) { x = left; }
+    void SetRight(int right) { width = right - x + 1; }
+    void SetTop(int top) { y = top; }
+    void SetBottom(int bottom) { height = bottom - y + 1; }
+
+    // operations with rect
+    wxRect& Inflate(wxCoord dx, wxCoord dy);
+    wxRect& Inflate(wxCoord d) { return Inflate(d, d); }
+    wxRect Inflate(wxCoord dx, wxCoord dy) const
+    {
+        wxRect r = *this;
+        r.Inflate(dx, dy);
+        return r;
+    }
+
+    wxRect& Deflate(wxCoord dx, wxCoord dy) { return Inflate(-dx, -dy); }
+    wxRect& Deflate(wxCoord d) { return Inflate(-d); }
+    wxRect Deflate(wxCoord dx, wxCoord dy) const
+    {
+        wxRect r = *this;
+        r.Deflate(dx, dy);
+        return r;
+    }
+
+    void Offset(wxCoord dx, wxCoord dy) { x += dx; y += dy; }
+    void Offset(const wxPoint& pt) { Offset(pt.x, pt.y); }
+
+    wxRect& Intersect(const wxRect& rect);
+    wxRect Intersect(const wxRect& rect) const
+    {
+        wxRect r = *this;
+        r.Intersect(rect);
+        return r;
+    }
+
+    wxRect operator+(const wxRect& rect) const;
+    wxRect& operator+=(const wxRect& 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
+    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
+    bool Intersects(const wxRect& rect) const;

 
 public:
 
 public:

-    long x, y, width, height;
+    int x, y, width, height;

 };
 
 // ---------------------------------------------------------------------------
 // Management of pens, brushes and fonts
 // ---------------------------------------------------------------------------
 
 };
 
 // ---------------------------------------------------------------------------
 // Management of pens, brushes and fonts
 // ---------------------------------------------------------------------------
 

+typedef wxInt8 wxDash;
+

 class WXDLLEXPORT wxPenList : public wxList
 {
     DECLARE_DYNAMIC_CLASS(wxPenList)
 class WXDLLEXPORT wxPenList : public wxList
 {
     DECLARE_DYNAMIC_CLASS(wxPenList)


@@ -301,7 +410,8 @@ public:
     void RemoveFont(wxFont *font);
     wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
                              bool underline = FALSE,
     void RemoveFont(wxFont *font);
     wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
                              bool underline = FALSE,

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

 };
 
 class WXDLLEXPORT wxColourDatabase : public wxList
 };
 
 class WXDLLEXPORT wxColourDatabase : public wxList


@@ -316,6 +426,11 @@ public:
     wxColour *FindColour(const wxString& colour) ;
     wxString FindName(const wxColour& colour) const;
     void Initialize();
     wxColour *FindColour(const wxString& colour) ;
     wxString FindName(const wxColour& colour) const;
     void Initialize();

+#ifdef __WXPM__
+    // PM keeps its own type of colour table
+    long*                           m_palTable;
+    size_t                          m_nSize;
+#endif

 };
 
 class WXDLLEXPORT wxBitmapList : public wxList
 };
 
 class WXDLLEXPORT wxBitmapList : public wxList


@@ -429,9 +544,15 @@ extern bool WXDLLEXPORT wxColourDisplay();
 extern int WXDLLEXPORT wxDisplayDepth();
 #define wxGetDisplayDepth wxDisplayDepth
 
 extern int WXDLLEXPORT wxDisplayDepth();
 #define wxGetDisplayDepth wxDisplayDepth
 

-// get the diaplay size
+// get the display size

 extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
 extern wxSize WXDLLEXPORT wxGetDisplaySize();
 extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
 extern wxSize WXDLLEXPORT wxGetDisplaySize();

+extern void WXDLLEXPORT wxDisplaySizeMM(int *width, int *height);
+extern wxSize WXDLLEXPORT wxGetDisplaySizeMM();
+
+// Get position and size of the display workarea
+extern void WXDLLEXPORT wxClientDisplayRect(int *x, int *y, int *width, int *height);
+extern wxRect WXDLLEXPORT wxGetClientDisplayRect();

 
 // set global cursor
 extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);
 
 // set global cursor
 extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);