]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/msw/dc.h
Added missing | symbol
[wxWidgets.git] / include / wx / msw / dc.h
index b0c49d268f6477b4d33ac87b0299a21419937674..29a3ca1acbbf4c719f3f0babe6e9877949cc1349 100644 (file)
@@ -5,12 +5,12 @@
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:    wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef __DCH__
-#define __DCH__
+#ifndef _WX_DC_H_
+#define _WX_DC_H_
 
 #ifdef __GNUG__
 #pragma interface "dc.h"
 #include "wx/icon.h"
 #include "wx/font.h"
 #include "wx/gdicmn.h"
+#include "wx/window.h"
+
+// Clash with Windows header files
+#ifdef StartDoc
+#undef StartDoc
+#endif
+
+#ifdef DrawText
+#undef DrawText
+#endif
+
+#ifdef GetCharWidth
+#undef GetCharWidth
+#endif
 
 class WXDLLEXPORT wxDC: public wxObject
 {
@@ -30,28 +44,124 @@ public:
   wxDC(void);
   ~wxDC(void);
 
+#ifdef WX_COMP_INLINE_NO_CLASS
+  inline void BeginDrawing(void) {}
+  inline void EndDrawing(void) {}
+#else
   inline void wxDC::BeginDrawing(void) {}
   inline void wxDC::EndDrawing(void) {}
+#endif
+
+  virtual void FloodFill(long x1, long y1, const wxColour& col, int style=wxFLOOD_SURFACE) ;
+  inline void FloodFill(const wxPoint& pt, const wxColour& col, int style=wxFLOOD_SURFACE)
+  {
+    FloodFill(pt.x, pt.y, col, style);
+  }
 
-  virtual void FloodFill(long x1, long y1, wxColour *col, int style=wxFLOOD_SURFACE) ;
   virtual bool GetPixel(long x1, long y1, wxColour *col) const ;
+  inline bool GetPixel(const wxPoint& pt, wxColour *col) const
+  {
+    return GetPixel(pt.x, pt.y, col);
+  }
 
   virtual void DrawLine(long x1, long y1, long x2, long y2);
+  inline void DrawLine(const wxPoint& pt1, const wxPoint& pt2)
+  {
+    DrawLine(pt1.x, pt1.y, pt2.x, pt2.y);
+  }
+
   virtual void CrossHair(long x, long y) ;
-  virtual void DrawArc(long x1,long y1,long x2,long y2,double xc, double yc);
+  inline void CrossHair(const wxPoint& pt)
+  {
+    CrossHair(pt.x, pt.y);
+  }
+
+  virtual void DrawArc(long x1,long y1,long x2,long y2,long xc, long yc);
+  inline void DrawArc(const wxPoint& pt1, const wxPoint& pt2, const wxPoint& centre)
+  {
+    DrawArc(pt1.x, pt1.y, pt2.x, pt2.y, centre.x, centre.y);
+  }
+
   virtual void DrawEllipticArc (long x, long y, long w, long h, double sa, double ea);
+  virtual void DrawEllipticArc (const wxPoint& pt, const wxSize& sz, double sa, double ea)
+  {
+    DrawEllipticArc(pt.x, pt.y, sz.x, sz.y, sa, ea);
+  }
+
   virtual void DrawPoint(long x, long y);
+  inline void DrawPoint(const wxPoint& pt)
+  {
+    DrawPoint(pt.x, pt.y);
+  }
 
   virtual void DrawLines(int n, wxPoint points[], long xoffset = 0, long yoffset = 0);
 
   virtual void DrawPolygon(int n, wxPoint points[], long xoffset = 0, long yoffset = 0, int fillStyle=wxODDEVEN_RULE);
 
   virtual void DrawRectangle(long x, long y, long width, long height);
+  inline void DrawRectangle(const wxPoint& pt, const wxSize& sz)
+  {
+    DrawRectangle(pt.x, pt.y, sz.x, sz.y);
+  }
+  inline void DrawRectangle(const wxRect& rect)
+  {
+    DrawRectangle(rect.x, rect.y, rect.width, rect.height);
+  }
+
   virtual void DrawRoundedRectangle(long x, long y, long width, long height, double radius = 20.0);
+  inline void DrawRoundedRectangle(const wxPoint& pt, const wxSize& sz, double radius = 20.0)
+  {
+    DrawRoundedRectangle(pt.x, pt.y, sz.x, sz.y, radius);
+  }
+  inline void DrawRoundedRectangle(const wxRect& rect, double radius = 20.0)
+  {
+    DrawRoundedRectangle(rect.x, rect.y, rect.width, rect.height, radius);
+  }
+
   virtual void DrawEllipse(long x, long y, long width, long height);
+  inline void DrawEllipse(const wxPoint& pt, const wxSize& sz)
+  {
+    DrawEllipse(pt.x, pt.y, sz.x, sz.y);
+  }
+  inline void DrawEllipse(const wxRect& rect)
+  {
+    DrawEllipse(rect.x, rect.y, rect.width, rect.height);
+  }
 
   virtual void DrawIcon(const wxIcon& icon, long x, long y);
+  inline void DrawIcon(const wxIcon& icon, const wxPoint& pt)
+  {
+    DrawIcon(icon, pt.x, pt.y);
+  }
+
+  virtual void DrawBitmap( const wxBitmap &bmp, long x, long y, bool useMask=FALSE );
+
+  inline void DrawPoint(wxPoint& point) { DrawPoint(point.x, point.y); }
+  virtual void DrawLines(wxList *list, long xoffset = 0, long yoffset = 0);
+  virtual void DrawPolygon(wxList *list, long xoffset = 0, long yoffset = 0, int fillStyle=wxODDEVEN_RULE);
+
+  virtual void DrawText(const wxString& text, long x, long y, bool use16bit = FALSE);
+  inline void DrawText(const wxString& text, const wxPoint& pt, bool use16bit = FALSE)
+  {
+    DrawText(text, pt.x, pt.y, use16bit);
+  }
+
+  virtual bool Blit(long xdest, long ydest, long width, long height,
+            wxDC *source, long xsrc, long ysrc, int rop = wxCOPY, bool useMask = FALSE);
+  inline bool Blit(const wxPoint& destPt, const wxSize& sz,
+            wxDC *source, const wxPoint& srcPt, int rop = wxCOPY, bool useMask = FALSE)
+  {
+    return Blit(destPt.x, destPt.y, sz.x, sz.y, source, srcPt.x, srcPt.y, rop, useMask);
+  }
 
+#if wxUSE_SPLINES
+  // Splines
+  // 3-point spline
+  virtual void DrawSpline(long x1, long y1, long x2, long y2, long x3, long y3);
+  // Any number of control points - a list of pointers to wxPoints
+  virtual void DrawSpline(wxList *points);
+  virtual void DrawSpline(int n, wxPoint points[]);
+#endif
   virtual void Clear(void);
   virtual void SetFont(const wxFont& font);
   virtual void SetPen(const wxPen& pen);
@@ -59,14 +169,23 @@ public:
   virtual void SetLogicalFunction(int function);
   virtual void SetBackground(const wxBrush& brush);
   virtual void SetBackgroundMode(int mode);
+
   virtual void SetClippingRegion(long x, long y, long width, long height);
+  inline void SetClippingRegion(const wxPoint& pt, const wxSize& sz)
+  {
+    SetClippingRegion(pt.x, pt.y, sz.x, sz.y);
+  }
+  inline void SetClippingRegion(const wxRect& rect)
+  {
+    SetClippingRegion(rect.x, rect.y, rect.width, rect.height);
+  }
+  virtual void SetClippingRegion(const wxRegion& region);
+
   virtual void SetPalette(const wxPalette& palette);
 #if WXWIN_COMPATIBILITY
   virtual inline void SetColourMap(const wxPalette& palette) { SetPalette(palette); };
 #endif
   virtual void DestroyClippingRegion(void);
-  virtual void DrawText(const wxString& text, long x, long y, bool use16bit = FALSE);
-
   virtual long GetCharHeight(void) const;
   virtual long GetCharWidth(void) const;
   virtual void GetTextExtent(const wxString& string, long *x, long *y,
@@ -100,6 +219,7 @@ public:
   virtual void SetSystemScale(double x, double y);
   virtual void SetLogicalOrigin(long x, long y);
   virtual void SetDeviceOrigin(long x, long y);
+  virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
 
   // This group of functions does actual conversion
   // of the input, as you'd expect.
@@ -126,46 +246,19 @@ public:
   long ImplLogicalToDeviceXRel(long x) const;
   long ImplLogicalToDeviceYRel(long y) const;
 
-  virtual bool Blit(long xdest, long ydest, long width, long height,
-            wxDC *source, long xsrc, long ysrc, int rop = wxCOPY, bool useMask = FALSE);
-
   virtual bool CanDrawBitmap(void) const;
   virtual bool CanGetTextExtent(void) const;
 
-  //
-  // This function is intended to improves drawing, by avoiding to
-  // repeatly call ::SetPen/::SetBrush. If set to FALSE, these functions
-  // aren't called when calling ::DrawLine(),...
-  // Please note that this is YOUR responsability to use it, and do it
-  // only when you KNOWN that pen/brush isn't changed between 2 calls to
-  // DrawLine,... !!!
-  // Note also that in X, we don't test m_autoSetting on brushes, because they
-  // modify Foreground, as pens. So, convention is:
-  //   - call your SetBrush(), THEN your SetPen, THEN AutoSetTools(FALSE)
-  //   - call DrawLine,...
-  // [mainly coded for Windows]
-  inline virtual void AutoSetTools(bool auto_setting) { m_autoSetting = auto_setting ; }
-  inline virtual void DrawPoint(wxPoint& point) { DrawPoint(point.x, point.y); }
-  virtual void DrawLines(wxList *list, long xoffset = 0, long yoffset = 0);
-  virtual void DrawPolygon(wxList *list, long xoffset = 0, long yoffset = 0, int fillStyle=wxODDEVEN_RULE);
-#if USE_SPLINES
-  // Splines
-  // 3-point spline
-  virtual void DrawSpline(long x1, long y1, long x2, long y2, long x3, long y3);
-  // Any number of control points - a list of pointers to wxPoints
-  virtual void DrawSpline(wxList *points);
-  virtual void DrawSpline(int n, wxPoint points[]);
-#endif
   virtual void SetTextForeground(const wxColour& colour);
   virtual void SetTextBackground(const wxColour& colour);
   inline virtual bool Ok(void) const {return m_ok;};
   inline virtual int  GetMapMode(void) const {return m_mappingMode;};
 
-  inline virtual wxBrush *GetBackground(void) const { return (wxBrush*) &m_backgroundBrush ;}
-  inline virtual wxBrush *GetBrush(void) const { return (wxBrush*) &m_brush ;}
-  inline virtual wxFont  *GetFont(void) const { return (wxFont*) &m_font ;}
+  inline virtual wxBrush& GetBackground(void) const { return (wxBrush&) m_backgroundBrush ;}
+  inline virtual wxBrush& GetBrush(void) const { return (wxBrush&) m_brush ;}
+  inline virtual wxFont& GetFont(void) const { return (wxFont&) m_font ;}
   inline virtual int      GetLogicalFunction(void) const { return m_logicalFunction ;}
-  inline virtual wxPen   *GetPen(void) const { return (wxPen*) &m_pen ;}
+  inline virtual wxPen&   GetPen(void) const { return (wxPen&) m_pen ;}
   inline virtual wxColour&GetTextBackground(void) const { return (wxColour&) m_textBackgroundColour ;}
   inline virtual wxColour&GetTextForeground(void) const { return (wxColour&) m_textForegroundColour ;}
 
@@ -184,7 +277,20 @@ public:
   virtual inline bool GetOptimization(void) { return FALSE; }
 
   virtual void GetClippingBox(long *x,long *y,long *w,long *h) const ;
+  inline void GetClippingBox(wxRect& rect) const
+  {
+    long x, y, w, h;
+    GetClippingBox(&x, &y, &w, &h); rect.x = x; rect.y = y; rect.width = w; rect.height = h;
+  }
+
+  // This should probably be made available on other platforms
+#ifdef WX_COMP_INLINE_NO_CLASS
+  int GetDepth(void) const ;
+#else
+  int wxDC::GetDepth(void) const ;
+#endif
 
+// Implementation
   virtual void SetRop(WXHDC cdc);
   virtual void DoClipping(WXHDC cdc);
   virtual void SelectOldObjects(WXHDC dc);
@@ -193,10 +299,6 @@ public:
   inline void SetWindow(wxWindow *win) { m_canvas = win; }
   inline WXHDC GetHDC(void) const { return m_hDC; }
   inline void SetHDC(WXHDC dc, bool bOwnsDC = FALSE) { m_hDC = dc; m_bOwnsDC = bOwnsDC; }
-  inline bool GetAutoSetting(void) const { return m_autoSetting; }
-
-//  inline bool GetScaleGDI(void) const { return m_scaleGDI; }
-//  inline void SetScaleGDI(bool flag) { m_scaleGDI = flag; }
 
 protected:
   bool              m_colour;
@@ -217,6 +319,9 @@ protected:
   double             m_userScaleX;
   double             m_userScaleY;
 
+  int                m_signX;          // Used by SetAxisOrientation() to
+  int                m_signY;          // invert the axes
+
   int               m_mappingMode;
 
   long             m_minX;          // bounding box
@@ -234,7 +339,6 @@ protected:
   wxColour          m_textBackgroundColour;
   wxFont            m_font;
   wxPalette         m_palette;
-  bool              m_autoSetting ;
   int               m_clipX1;
   int               m_clipY1;
   int               m_clipX2;
@@ -316,8 +420,8 @@ protected:
 #define MS_XDEV2LOGREL(x) DeviceToLogicalXRel(x)
 #define MS_YDEV2LOGREL(y) DeviceToLogicalYRel(y)
 
-#define MM_POINTS      7
-#define MM_METRIC      8
+#define MM_POINTS      9
+#define MM_METRIC     10
 
 extern int wxPageNumber;
 
@@ -338,4 +442,4 @@ extern int wxPageNumber;
 
 
 #endif
-    // __DCH__
+    // _WX_DC_H_