include/wx/dcmirror.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/dcmirror.h
   3 // Purpose:     wxMirrorDC class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     21.07.2003
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_DCMIRROR_H_
  13 #define _WX_DCMIRROR_H_
  14
  15 #include "wx/dc.h"
  16
  17 // ----------------------------------------------------------------------------
  18 // wxMirrorDC allows to write the same code for horz/vertical layout
  19 // ----------------------------------------------------------------------------
  20
  21 class WXDLLEXPORT wxMirrorDC : public wxDC
  22 {
  23 public:
  24     // constructs a mirror DC associated with the given real DC
  25     //
  26     // if mirror parameter is true, all vertical and horizontal coordinates are
  27     // exchanged, otherwise this class behaves in exactly the same way as a
  28     // plain DC
  29     //
  30     // the cast to wxMirrorDC is a dirty hack done to allow us to call the
  31     // protected methods of wxDCBase directly in our code below, without it it
  32     // would be impossible (this is correct from C++ point of view but doesn't
  33     // make any sense in this particular situation)
  34     wxMirrorDC(wxDC& dc, bool mirror) : m_dc((wxMirrorDC&)dc)
  35         { m_mirror = mirror; }
  36
  37     // wxDCBase operations
  38     virtual void Clear() { m_dc.Clear(); }
  39     virtual void SetFont(const wxFont& font) { m_dc.SetFont(font); }
  40     virtual void SetPen(const wxPen& pen) { m_dc.SetPen(pen); }
  41     virtual void SetBrush(const wxBrush& brush) { m_dc.SetBrush(brush); }
  42     virtual void SetBackground(const wxBrush& brush)
  43         { m_dc.SetBackground(brush); }
  44     virtual void SetBackgroundMode(int mode) { m_dc.SetBackgroundMode(mode); }
  45 #if wxUSE_PALETTE
  46     virtual void SetPalette(const wxPalette& palette)
  47         { m_dc.SetPalette(palette); }
  48 #endif // wxUSE_PALETTE
  49     virtual void DestroyClippingRegion() { m_dc.DestroyClippingRegion(); }
  50     virtual wxCoord GetCharHeight() const { return m_dc.GetCharHeight(); }
  51     virtual wxCoord GetCharWidth() const { return m_dc.GetCharWidth(); }
  52     virtual bool CanDrawBitmap() const { return m_dc.CanDrawBitmap(); }
  53     virtual bool CanGetTextExtent() const { return m_dc.CanGetTextExtent(); }
  54     virtual int GetDepth() const { return m_dc.GetDepth(); }
  55     virtual wxSize GetPPI() const { return m_dc.GetPPI(); }
  56     virtual bool Ok() const { return m_dc.Ok(); }
  57     virtual void SetMapMode(int mode) { m_dc.SetMapMode(mode); }
  58     virtual void SetUserScale(double x, double y)
  59         { m_dc.SetUserScale(GetX(x, y), GetY(x, y)); }
  60     virtual void SetLogicalOrigin(wxCoord x, wxCoord y)
  61         { m_dc.SetLogicalOrigin(GetX(x, y), GetY(x, y)); }
  62     virtual void SetDeviceOrigin(wxCoord x, wxCoord y)
  63         { m_dc.SetDeviceOrigin(GetX(x, y), GetY(x, y)); }
  64     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp)
  65         { m_dc.SetAxisOrientation(GetX(xLeftRight, yBottomUp),
  66                                   GetY(xLeftRight, yBottomUp)); }
  67     virtual void SetLogicalFunction(int function)
  68         { m_dc.SetLogicalFunction(function); }
  69
  70     // helper functions which may be useful for the users of this class
  71     wxSize Reflect(const wxSize& sizeOrig)
  72     {
  73         return m_mirror ? wxSize(sizeOrig.y, sizeOrig.x) : sizeOrig;
  74     }
  75
  76 protected:
  77     // returns x and y if not mirroring or y and x if mirroring
  78     wxCoord GetX(wxCoord x, wxCoord y) const { return m_mirror ? y : x; }
  79     wxCoord GetY(wxCoord x, wxCoord y) const { return m_mirror ? x : y; }
  80     double GetX(double x, double y) const { return m_mirror ? y : x; }
  81     double GetY(double x, double y) const { return m_mirror ? x : y; }
  82     bool GetX(bool x, bool y) const { return m_mirror ? y : x; }
  83     bool GetY(bool x, bool y) const { return m_mirror ? x : y; }
  84
  85     // same thing but for pointers
  86     wxCoord *GetX(wxCoord *x, wxCoord *y) const { return m_mirror ? y : x; }
  87     wxCoord *GetY(wxCoord *x, wxCoord *y) const { return m_mirror ? x : y; }
  88
  89     // exchange x and y unconditionally
  90     static void Swap(wxCoord& x, wxCoord& y)
  91     {
  92         wxCoord t = x;
  93         x = y;
  94         y = t;
  95     }
  96
  97     // exchange x and y components of all points in the array if necessary
  98     void Mirror(int n, wxPoint points[]) const
  99     {
 100         if ( m_mirror )
 101         {
 102             for ( int i = 0; i < n; i++ )
 103             {
 104                 Swap(points[i].x, points[i].y);
 105             }
 106         }
 107     }
 108
 109
 110     // wxDCBase functions
 111     virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
 112                              int style = wxFLOOD_SURFACE)
 113     {
 114         return m_dc.DoFloodFill(GetX(x, y), GetY(x, y), col, style);
 115     }
 116
 117     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const
 118     {
 119         return m_dc.DoGetPixel(GetX(x, y), GetY(x, y), col);
 120     }
 121
 122
 123     virtual void DoDrawPoint(wxCoord x, wxCoord y)
 124     {
 125         m_dc.DoDrawPoint(GetX(x, y), GetY(x, y));
 126     }
 127
 128     virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2)
 129     {
 130         m_dc.DoDrawLine(GetX(x1, y1), GetY(x1, y1), GetX(x2, y2), GetY(x2, y2));
 131     }
 132
 133     virtual void DoDrawArc(wxCoord x1, wxCoord y1,
 134                            wxCoord x2, wxCoord y2,
 135                            wxCoord xc, wxCoord yc)
 136     {
 137         wxFAIL_MSG( _T("this is probably wrong") );
 138
 139         m_dc.DoDrawArc(GetX(x1, y1), GetY(x1, y1),
 140                        GetX(x2, y2), GetY(x2, y2),
 141                        xc, yc);
 142     }
 143
 144     virtual void DoDrawCheckMark(wxCoord x, wxCoord y,
 145                                  wxCoord w, wxCoord h)
 146     {
 147         m_dc.DoDrawCheckMark(GetX(x, y), GetY(x, y),
 148                              GetX(w, h), GetY(w, h));
 149     }
 150
 151     virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
 152                                    double sa, double ea)
 153     {
 154         wxFAIL_MSG( _T("this is probably wrong") );
 155
 156         m_dc.DoDrawEllipticArc(GetX(x, y), GetY(x, y),
 157                                GetX(w, h), GetY(w, h),
 158                                sa, ea);
 159     }
 160
 161     virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord w, wxCoord h)
 162     {
 163         m_dc.DoDrawRectangle(GetX(x, y), GetY(x, y), GetX(w, h), GetY(w, h));
 164     }
 165
 166     virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
 167                                         wxCoord w, wxCoord h,
 168                                         double radius)
 169     {
 170         m_dc.DoDrawRoundedRectangle(GetX(x, y), GetY(x, y),
 171                                     GetX(w, h), GetY(w, h),
 172                                     radius);
 173     }
 174
 175     virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord w, wxCoord h)
 176     {
 177         m_dc.DoDrawEllipse(GetX(x, y), GetY(x, y), GetX(w, h), GetY(w, h));
 178     }
 179
 180     virtual void DoCrossHair(wxCoord x, wxCoord y)
 181     {
 182         m_dc.DoCrossHair(GetX(x, y), GetY(x, y));
 183     }
 184
 185     virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y)
 186     {
 187         m_dc.DoDrawIcon(icon, GetX(x, y), GetY(x, y));
 188     }
 189
 190     virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
 191                               bool useMask = FALSE)
 192     {
 193         m_dc.DoDrawBitmap(bmp, GetX(x, y), GetY(x, y), useMask);
 194     }
 195
 196     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y)
 197     {
 198         // this is never mirrored
 199         m_dc.DoDrawText(text, x, y);
 200     }
 201
 202     virtual void DoDrawRotatedText(const wxString& text,
 203                                    wxCoord x, wxCoord y, double angle)
 204     {
 205         // this is never mirrored
 206         m_dc.DoDrawRotatedText(text, x, y, angle);
 207     }
 208
 209     virtual bool DoBlit(wxCoord xdest, wxCoord ydest,
 210                         wxCoord w, wxCoord h,
 211                         wxDC *source, wxCoord xsrc, wxCoord ysrc,
 212                         int rop = wxCOPY, bool useMask = FALSE,
 213                         wxCoord xsrcMask = -1, wxCoord ysrcMask = -1)
 214     {
 215         return m_dc.DoBlit(GetX(xdest, ydest), GetY(xdest, ydest),
 216                            GetX(w, h), GetY(w, h),
 217                            source, GetX(xsrc, ysrc), GetY(xsrc, ysrc),
 218                            rop, useMask,
 219                            GetX(xsrcMask, ysrcMask), GetX(xsrcMask, ysrcMask));
 220     }
 221
 222     virtual void DoGetSize(int *w, int *h) const
 223     {
 224         m_dc.DoGetSize(GetX(w, h), GetY(w, h));
 225     }
 226
 227     virtual void DoGetSizeMM(int *w, int *h) const
 228     {
 229         m_dc.DoGetSizeMM(GetX(w, h), GetY(w, h));
 230     }
 231
 232     virtual void DoDrawLines(int n, wxPoint points[],
 233                              wxCoord xoffset, wxCoord yoffset)
 234     {
 235         Mirror(n, points);
 236
 237         m_dc.DoDrawLines(n, points,
 238                          GetX(xoffset, yoffset), GetY(xoffset, yoffset));
 239
 240         Mirror(n, points);
 241     }
 242
 243     virtual void DoDrawPolygon(int n, wxPoint points[],
 244                                wxCoord xoffset, wxCoord yoffset,
 245                                int fillStyle = wxODDEVEN_RULE)
 246     {
 247         Mirror(n, points);
 248
 249         m_dc.DoDrawPolygon(n, points,
 250                            GetX(xoffset, yoffset), GetY(xoffset, yoffset),
 251                            fillStyle);
 252
 253         Mirror(n, points);
 254     }
 255
 256     virtual void DoSetClippingRegionAsRegion(const wxRegion& WXUNUSED(region))
 257     {
 258         wxFAIL_MSG( _T("not implemented") );
 259     }
 260
 261     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
 262                                      wxCoord w, wxCoord h)
 263     {
 264         m_dc.DoSetClippingRegion(GetX(x, y), GetY(x, y), GetX(w, h), GetY(w, h));
 265     }
 266
 267     virtual void DoGetTextExtent(const wxString& string,
 268                                  wxCoord *x, wxCoord *y,
 269                                  wxCoord *descent = NULL,
 270                                  wxCoord *externalLeading = NULL,
 271                                  wxFont *theFont = NULL) const
 272     {
 273         // never mirrored
 274         m_dc.DoGetTextExtent(string, x, y, descent, externalLeading, theFont);
 275     }
 276
 277 private:
 278     wxMirrorDC& m_dc;
 279
 280     bool m_mirror;
 281
 282     DECLARE_NO_COPY_CLASS(wxMirrorDC)
 283 };
 284
 285 #endif // _WX_DCMIRROR_H_
 286