canvas/source/cairo/cairo_surfaceprovider.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef _CAIROCANVAS_SURFACEPROVIDER_HXX
  21 #define _CAIROCANVAS_SURFACEPROVIDER_HXX
  22
  23 #include <rtl/ref.hxx>
  24 #include <com/sun/star/uno/XInterface.hpp>
  25
  26 #include "cairo_cairo.hxx"
  27
  28 using namespace ::cairo;
  29
  30 class OutputDevice;
  31 class Bitmap;
  32
  33 namespace cairocanvas
  34 {
  35     class Bitmap;
  36
  37     /* Definition of RepaintTarget interface */
  38
  39     /** Target interface for XCachedPrimitive implementations
  40
  41         This interface must be implemented on all canvas
  42         implementations that hand out XCachedPrimitives
  43      */
  44     class SurfaceProvider : public ::com::sun::star::uno::XInterface
  45     {
  46     public:
  47         virtual ~SurfaceProvider() {}
  48
  49         /** Query surface from this provider
  50
  51             This should return the default surface to render on.
  52          */
  53         virtual SurfaceSharedPtr getSurface() = 0;
  54
  55         /// create new surface in given size
  56         virtual SurfaceSharedPtr createSurface( const ::basegfx::B2ISize& rSize,
  57                                                 Content aContent = CAIRO_CONTENT_COLOR_ALPHA ) = 0;
  58         /// create new surface from given bitmap
  59         virtual SurfaceSharedPtr createSurface( ::Bitmap& rBitmap ) = 0;
  60
  61         /** convert surface between alpha and non-alpha
  62             channel. returns new surface on success, NULL otherwise
  63         */
  64         virtual SurfaceSharedPtr changeSurface( bool bHasAlpha, bool bCopyContent ) = 0;
  65
  66         /** Provides the underlying vcl outputdevice this surface renders on
  67          */
  68         virtual OutputDevice* getOutputDevice() = 0;
  69     };
  70
  71     typedef ::rtl::Reference< SurfaceProvider > SurfaceProviderRef;
  72 }
  73
  74 #endif
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */