canvas/source/vcl/backbuffer.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: backbuffer.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _VCLCANVAS_BACKBUFFER_HXX_
  32 #define _VCLCANVAS_BACKBUFFER_HXX_
  33
  34 #include <vcl/virdev.hxx>
  35
  36 #include <canvas/vclwrapper.hxx>
  37 #include "outdevprovider.hxx"
  38
  39 #include <boost/shared_ptr.hpp>
  40
  41
  42 namespace vclcanvas
  43 {
  44     /// Background buffer abstraction
  45     class BackBuffer : public OutDevProvider
  46     {
  47     public:
  48         /** Create a backbuffer for given reference device
  49
  50             @param bMonochromeBuffer
  51             When false, default depth of reference device is
  52             chosen. When true, the buffer will be monochrome, i.e. one
  53             bit deep.
  54          */
  55         BackBuffer( const OutputDevice& rRefDevice,
  56                     bool                                bMonochromeBuffer=false );
  57
  58         virtual OutputDevice&           getOutDev();
  59         virtual const OutputDevice&     getOutDev() const;
  60
  61         void setSize( const ::Size& rNewSize );
  62
  63     private:
  64         ::canvas::vcltools::VCLObject<VirtualDevice>    maVDev;
  65     };
  66
  67     typedef ::boost::shared_ptr< BackBuffer > BackBufferSharedPtr;
  68 }
  69
  70 #endif /* #ifndef _VCLCANVAS_BACKBUFFER_HXX_ */