interface/dcmirror.h

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