canvas/source/cairo/cairo_surfaceprovider.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef _CAIROCANVAS_SURFACEPROVIDER_HXX
  29 #define _CAIROCANVAS_SURFACEPROVIDER_HXX
  30
  31 #include <rtl/ref.hxx>
  32 #include <com/sun/star/uno/XInterface.hpp>
  33
  34 #include "cairo_cairo.hxx"
  35
  36 using namespace ::cairo;
  37
  38 class OutputDevice;
  39 class Bitmap;
  40
  41 namespace cairocanvas
  42 {
  43     class Bitmap;
  44
  45     /* Definition of RepaintTarget interface */
  46
  47     /** Target interface for XCachedPrimitive implementations
  48
  49         This interface must be implemented on all canvas
  50         implementations that hand out XCachedPrimitives
  51      */
  52     class SurfaceProvider : public ::com::sun::star::uno::XInterface
  53     {
  54     public:
  55         virtual ~SurfaceProvider() {}
  56
  57         /** Query surface from this provider
  58
  59             This should return the default surface to render on.
  60          */
  61         virtual SurfaceSharedPtr getSurface() = 0;
  62
  63         /// create new surface in given size
  64         virtual SurfaceSharedPtr createSurface( const ::basegfx::B2ISize& rSize,
  65                                                 Content aContent = CAIRO_CONTENT_COLOR_ALPHA ) = 0;
  66         /// create new surface from given bitmap
  67         virtual SurfaceSharedPtr createSurface( ::Bitmap& rBitmap ) = 0;
  68
  69         /** convert surface between alpha and non-alpha
  70             channel. returns new surface on success, NULL otherwise
  71         */
  72         virtual SurfaceSharedPtr changeSurface( bool bHasAlpha, bool bCopyContent ) = 0;
  73
  74         /** Provides the underlying vcl outputdevice this surface renders on
  75          */
  76         virtual OutputDevice* getOutputDevice() = 0;
  77     };
  78
  79     typedef ::rtl::Reference< SurfaceProvider > SurfaceProviderRef;
  80 }
  81
  82 #endif