interface/wx/overlay.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        overlay.h
   3 // Purpose:     interface of wxOverlay
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10    @class wxOverlay
  11
  12    Creates an overlay over an existing window, allowing for manipulations like
  13    rubberbanding, etc.  On wxOSX the overlay is implemented with native
  14    platform APIs, on the other platforms it is simulated using wxMemoryDC.
  15
  16    @library{wxcore}
  17
  18    @see wxDCOverlay, wxDC
  19  */
  20 class wxOverlay
  21 {
  22 public:
  23     wxOverlay();
  24     ~wxOverlay();
  25
  26     /**
  27        Clears the overlay without restoring the former state.  To be done, for
  28        example, when the window content has been changed and repainted.
  29     */
  30     void Reset();
  31 };
  32
  33
  34
  35 /**
  36    @class wxDCOverlay
  37
  38    Connects an overlay with a drawing DC.
  39
  40    @library{wxcore}
  41
  42    @see wxOverlay, wxDC
  43
  44  */
  45 class wxDCOverlay
  46 {
  47 public:
  48     /**
  49        Connects this overlay to the corresponding drawing dc, if the overlay is
  50        not initialized yet this call will do so.
  51     */
  52     wxDCOverlay(wxOverlay &overlay, wxDC *dc, int x , int y , int width , int height);
  53
  54     /**
  55        Convenience wrapper that behaves the same using the entire area of the dc.
  56     */
  57     wxDCOverlay(wxOverlay &overlay, wxDC *dc);
  58
  59     /**
  60        Removes the connection between the overlay and the dc.
  61     */
  62     virtual ~wxDCOverlay();
  63
  64     /**
  65        Clears the layer, restoring the state at the last init.
  66     */
  67     void Clear();
  68 };