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 #pragma once
  21
  22 #include <rtl/ref.hxx>
  23 #include <com/sun/star/uno/XInterface.hpp>
  24
  25 #include <basegfx/vector/b2isize.hxx>
  26 #include <vcl/cairo.hxx>
  27
  28 class OutputDevice;
  29 class Bitmap;
  30
  31 namespace cairocanvas
  32 {
  33     /* Definition of RepaintTarget interface */
  34
  35     /** Target interface for XCachedPrimitive implementations
  36
  37         This interface must be implemented on all canvas
  38         implementations that hand out XCachedPrimitives
  39      */
  40     class SAL_LOPLUGIN_ANNOTATE("crosscast") SurfaceProvider : public css::uno::XInterface
  41     {
  42     public:
  43         virtual ~SurfaceProvider() {}
  44
  45         /** Query surface from this provider
  46
  47             This should return the default surface to render on.
  48          */
  49         virtual ::cairo::SurfaceSharedPtr getSurface() = 0;
  50
  51         /// create new surface in given size
  52         virtual ::cairo::SurfaceSharedPtr createSurface( const ::basegfx::B2ISize& rSize,
  53                                                          int aContent ) = 0;
  54         /// create new surface from given bitmap
  55         virtual ::cairo::SurfaceSharedPtr createSurface( ::Bitmap& rBitmap ) = 0;
  56
  57         /** convert surface from alpha to non-alpha, does not copy content
  58             channel. returns new surface on success, NULL otherwise
  59         */
  60         virtual ::cairo::SurfaceSharedPtr changeSurface() = 0;
  61
  62         /** Provides the underlying vcl outputdevice this surface renders on
  63          */
  64         virtual OutputDevice* getOutputDevice() = 0;
  65     };
  66
  67     typedef ::rtl::Reference< SurfaceProvider > SurfaceProviderRef;
  68 }
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */