1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef _VCLCANVAS_BITMAPBACKBUFFER_HXX_ 29*cdf0e10cSrcweir #define _VCLCANVAS_BITMAPBACKBUFFER_HXX_ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir #include <vcl/virdev.hxx> 32*cdf0e10cSrcweir #include <vcl/bitmapex.hxx> 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir #include <canvas/vclwrapper.hxx> 35*cdf0e10cSrcweir #include "outdevprovider.hxx" 36*cdf0e10cSrcweir 37*cdf0e10cSrcweir #include <boost/shared_ptr.hpp> 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir namespace vclcanvas 41*cdf0e10cSrcweir { 42*cdf0e10cSrcweir /** Backbuffer implementation for canvas bitmap. 43*cdf0e10cSrcweir 44*cdf0e10cSrcweir This class abstracts away the renderable bitmap for the bitmap 45*cdf0e10cSrcweir canvas. The actual VirtualDevice is only created when 46*cdf0e10cSrcweir necessary, which makes read-only bitmaps a lot smaller. 47*cdf0e10cSrcweir */ 48*cdf0e10cSrcweir class BitmapBackBuffer : public OutDevProvider 49*cdf0e10cSrcweir { 50*cdf0e10cSrcweir public: 51*cdf0e10cSrcweir /** Create a backbuffer for given reference device 52*cdf0e10cSrcweir */ 53*cdf0e10cSrcweir BitmapBackBuffer( const BitmapEx& rBitmap, 54*cdf0e10cSrcweir const OutputDevice& rRefDevice ); 55*cdf0e10cSrcweir 56*cdf0e10cSrcweir ~BitmapBackBuffer(); 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir virtual OutputDevice& getOutDev(); 59*cdf0e10cSrcweir virtual const OutputDevice& getOutDev() const; 60*cdf0e10cSrcweir 61*cdf0e10cSrcweir /// Clear the underlying bitmap to white, all transparent 62*cdf0e10cSrcweir void clear(); 63*cdf0e10cSrcweir 64*cdf0e10cSrcweir /** Exposing our internal bitmap. Only to be used from 65*cdf0e10cSrcweir CanvasBitmapHelper 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir @internal 68*cdf0e10cSrcweir */ 69*cdf0e10cSrcweir BitmapEx& getBitmapReference(); 70*cdf0e10cSrcweir Size getBitmapSizePixel() const; 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir private: 73*cdf0e10cSrcweir void createVDev() const; 74*cdf0e10cSrcweir void updateVDev() const; 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir ::canvas::vcltools::VCLObject<BitmapEx> maBitmap; 77*cdf0e10cSrcweir mutable VirtualDevice* mpVDev; // created only on demand 78*cdf0e10cSrcweir 79*cdf0e10cSrcweir const OutputDevice& mrRefDevice; 80*cdf0e10cSrcweir 81*cdf0e10cSrcweir /** When true, the bitmap contains the last valid 82*cdf0e10cSrcweir content. When false, and mbVDevContentIsCurrent is true, 83*cdf0e10cSrcweir the VDev contains the last valid content (which must be 84*cdf0e10cSrcweir copied back to the bitmap, when getBitmapReference() is 85*cdf0e10cSrcweir called). When both are false, this object is just 86*cdf0e10cSrcweir initialized. 87*cdf0e10cSrcweir */ 88*cdf0e10cSrcweir mutable bool mbBitmapContentIsCurrent; 89*cdf0e10cSrcweir 90*cdf0e10cSrcweir /** When true, and mpVDev is non-NULL, the VDev contains the 91*cdf0e10cSrcweir last valid content. When false, and 92*cdf0e10cSrcweir mbBitmapContentIsCurrent is true, the bitmap contains the 93*cdf0e10cSrcweir last valid content. When both are false, this object is 94*cdf0e10cSrcweir just initialized. 95*cdf0e10cSrcweir */ 96*cdf0e10cSrcweir mutable bool mbVDevContentIsCurrent; 97*cdf0e10cSrcweir }; 98*cdf0e10cSrcweir 99*cdf0e10cSrcweir typedef ::boost::shared_ptr< BitmapBackBuffer > BitmapBackBufferSharedPtr; 100*cdf0e10cSrcweir 101*cdf0e10cSrcweir } 102*cdf0e10cSrcweir 103*cdf0e10cSrcweir #endif /* #ifndef _VCLCANVAS_BITMAPBACKBUFFER_HXX_ */ 104*cdf0e10cSrcweir 105