canvas/source/tools/imagecachedprimitive.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: imagecachedprimitive.hxx,v $
  10  * $Revision: 1.3 $
  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 INCLUDED_CANVAS_IMAGECACHEDPRIMITIVE_HXX
  32 #define INCLUDED_CANVAS_IMAGECACHEDPRIMITIVE_HXX
  33
  34 #include <canvas/rendering/icachedprimitive.hxx>
  35
  36 #include <boost/shared_ptr.hpp>
  37
  38
  39 namespace canvas
  40 {
  41     /** Objects with this interface are returned from every Image
  42         render operation.
  43
  44         These objects can be used to implement the
  45         rendering::XCachedPrimitive interface, which in turn caches
  46         render state and objects to facilitate quick redraws.
  47
  48         Derived from ICachedPrimitive, to add the setImage() method
  49         (which, strictly speaking, is a technicality, because Image
  50         cannot create objects with a shared_ptr to itself).
  51      */
  52     struct ImageCachedPrimitive : public ICachedPrimitive
  53     {
  54         virtual void setImage( const ::boost::shared_ptr< class Image >& rTargetImage ) = 0;
  55     };
  56
  57     typedef ::boost::shared_ptr< ImageCachedPrimitive > ImageCachedPrimitiveSharedPtr;
  58 }
  59
  60 #endif /* INCLUDED_CANVAS_IMAGECACHEDPRIMITIVE_HXX */