interface/dcmirror.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dcmirror.h
   3 // Purpose:     documentation for wxMirrorDC class
   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
  15     without changes (no mirroring takes place) or exchanges @e x and @e y
  16     coordinates which makes it possible to reuse the same code to draw a figure and
  17     its mirror -- i.e. reflection related to the diagonal line x == y.
  18
  19     wxMirrorDC has been added in wxWidgets version 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 @e dc. Everything
  29         drawn on wxMirrorDC will appear (and maybe mirrored) on @e dc.
  30
  31         @e 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 };