interface/wx/dcmirror.h

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