docs/latex/wx/mirrordc.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        mirrordc.tex
   3 %% Purpose:     wxMirrorDC documentation
   4 %% Author:      Vadim Zeitlin
   5 %% Modified by:
   6 %% Created:     21.07.03
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) 2003 Vadim Zeitlin
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxMirrorDC}}\label{wxmirrordc}
  13
  14 wxMirrorDC is a simple wrapper class which is always associated with a real
  15 \helpref{wxDC}{wxdc} object and either forwards all of its operations to it
  16 without changes (no mirroring takes place) or exchanges {\it x} and {\it y}
  17 coordinates which makes it possible to reuse the same code to draw a figure and
  18 its mirror -- i.e. reflection related to the diagonal line $x == y$.
  19
  20 wxMirrorDC has been added in wxWidgets version 2.5.0.
  21
  22 \wxheading{Derived from}
  23
  24 \helpref{wxDC}{wxdc}
  25
  26 \wxheading{Include files}
  27
  28 <wx/dcmirror.h>
  29
  30
  31 \helponly{\insertatlevel{2}{\wxheading{Members}}}
  32
  33 \membersection{wxMirrorDC::wxMirrorDC}\label{wxmirrordcwxmirrordc}
  34
  35 \func{}{wxMirrorDC}{\param{wxDC\& }{dc}, \param{bool }{mirror}}
  36
  37 Creates a (maybe) mirrored DC associated with the real \arg{dc}. Everything
  38 drawn on wxMirrorDC will appear (and maybe mirrored) on \arg{dc}.
  39
  40 \arg{mirror} specifies if we do mirror (if it is \true) or not (if it is
  41 \false).
  42