wxWidgets/interface/wx/overlay.h
Vadim Zeitlin 3f66f6a5b3 Remove all lines containing cvs/svn "$Id$" keyword.
This keyword is not expanded by Git which means it's not replaced with the
correct revision value in the releases made using git-based scripts and it's
confusing to have lines with unexpanded "$Id$" in the released files. As
expanding them with Git is not that simple (it could be done with git archive
and export-subst attribute) and there are not many benefits in having them in
the first place, just remove all these lines.

If nothing else, this will make an eventual transition to Git simpler.

Closes #14487.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74602 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-07-26 16:02:46 +00:00

68 lines
1.5 KiB
Objective-C

/////////////////////////////////////////////////////////////////////////////
// Name: overlay.h
// Purpose: interface of wxOverlay
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxOverlay
Creates an overlay over an existing window, allowing for manipulations like
rubberbanding, etc. On wxOSX the overlay is implemented with native
platform APIs, on the other platforms it is simulated using wxMemoryDC.
@library{wxcore}
@see wxDCOverlay, wxDC
*/
class wxOverlay
{
public:
wxOverlay();
~wxOverlay();
/**
Clears the overlay without restoring the former state. To be done, for
example, when the window content has been changed and repainted.
*/
void Reset();
};
/**
@class wxDCOverlay
Connects an overlay with a drawing DC.
@library{wxcore}
@see wxOverlay, wxDC
*/
class wxDCOverlay
{
public:
/**
Connects this overlay to the corresponding drawing dc, if the overlay is
not initialized yet this call will do so.
*/
wxDCOverlay(wxOverlay &overlay, wxDC *dc, int x , int y , int width , int height);
/**
Convenience wrapper that behaves the same using the entire area of the dc.
*/
wxDCOverlay(wxOverlay &overlay, wxDC *dc);
/**
Removes the connection between the overlay and the dc.
*/
virtual ~wxDCOverlay();
/**
Clears the layer, restoring the state at the last init.
*/
void Clear();
};