interface/wx/dcmirror.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dcmirror.h
   3 // Purpose:     interface of wxMirrorDC
   4 // Author:      wxWidgets team
   5 // Licence:     wxWindows licence
   6 /////////////////////////////////////////////////////////////////////////////
   7
   8 /**
   9     @class wxMirrorDC
  10
  11     wxMirrorDC is a simple wrapper class which is always associated with a real
  12     wxDC object and either forwards all of its operations to it without changes
  13     (no mirroring takes place) or exchanges @e x and @e y coordinates which
  14     makes it possible to reuse the same code to draw a figure and its mirror --
  15     i.e. reflection related to the diagonal line x == y.
  16
  17     @since 2.5.0
  18
  19     @library{wxcore}
  20     @category{dc}
  21 */
  22 class wxMirrorDC : public wxDC
  23 {
  24 public:
  25     /**
  26         Creates a (maybe) mirrored DC associated with the real @a dc.
  27         Everything drawn on wxMirrorDC will appear (and maybe mirrored) on
  28         @a dc.
  29
  30         @a mirror specifies if we do mirror (if it is @true) or not (if it is
  31         @false).
  32     */
  33     wxMirrorDC(wxDC& dc, bool mirror);
  34 };
  35