interface/wx/overlay.h

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