canvas/inc/base/bitmapcanvasbase.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 <base/canvasbase.hxx>
  23 #include <com/sun/star/geometry/IntegerSize2D.hpp>
  24
  25 namespace com::sun::star::rendering { class XBitmapCanvas; }
  26
  27 namespace canvas
  28 {
  29     /** Helper template to handle XBitmapCanvas method forwarding to
  30         BitmapCanvasHelper
  31
  32         Use this helper to handle the XBitmapCanvas part of your
  33         implementation.
  34
  35         @tpl Base
  36         Base class to use, most probably one of the
  37         WeakComponentImplHelperN templates with the appropriate
  38         interfaces. At least XBitmapCanvas should be among them (why
  39         else would you use this template, then?). Base class must have
  40         a Base( const Mutex& ) constructor (like the
  41         WeakComponentImplHelperN templates have).
  42
  43         @tpl CanvasHelper
  44         Canvas helper implementation for the backend in question
  45
  46         @tpl Mutex
  47         Lock strategy to use. Defaults to using the
  48         BaseMutex-provided lock.  Every time one of the methods is
  49         entered, an object of type Mutex is created with m_aMutex as
  50         the sole parameter, and destroyed again when the method scope
  51         is left.
  52
  53         @tpl UnambiguousBase
  54         Optional unambiguous base class for XInterface of Base. It's
  55         sometimes necessary to specify this parameter, e.g. if Base
  56         derives from multiple UNO interface (were each provides its
  57         own version of XInterface, making the conversion ambiguous)
  58
  59         @see CanvasBase for further contractual requirements towards
  60         the CanvasHelper type, and some examples.
  61      */
  62     template< class Base,
  63               class CanvasHelper,
  64               class Mutex=::osl::MutexGuard,
  65               class UnambiguousBase=css::uno::XInterface > class BitmapCanvasBase :
  66         public CanvasBase< Base, CanvasHelper, Mutex, UnambiguousBase >
  67     {
  68     public:
  69         typedef CanvasBase< Base, CanvasHelper, Mutex, UnambiguousBase >    BaseType;
  70
  71         // XBitmap
  72         virtual css::geometry::IntegerSize2D SAL_CALL getSize(  ) override
  73         {
  74             typename BaseType::MutexType aGuard( BaseType::m_aMutex );
  75
  76             return BaseType::maCanvasHelper.getSize();
  77         }
  78
  79         virtual sal_Bool SAL_CALL hasAlpha(  ) override
  80         {
  81             return true;
  82         }
  83
  84         virtual css::uno::Reference< css::rendering::XBitmap > SAL_CALL getScaledBitmap( const css::geometry::RealSize2D& newSize,
  85                                                                                                                    sal_Bool                                      beFast ) override
  86         {
  87             typename BaseType::MutexType aGuard( BaseType::m_aMutex );
  88
  89             return BaseType::maCanvasHelper.getScaledBitmap( newSize, beFast );
  90         }
  91
  92     };
  93
  94     template< class Base,
  95               class CanvasHelper,
  96               class Mutex=::osl::MutexGuard,
  97               class UnambiguousBase = css::uno::XInterface > class BitmapCanvasBase2 :
  98         public BitmapCanvasBase< Base, CanvasHelper, Mutex, UnambiguousBase >
  99     {
 100         typedef BitmapCanvasBase< Base, CanvasHelper, Mutex, UnambiguousBase >
 101             BaseType;
 102
 103     public:
 104         // XBitmapCanvas
 105         virtual void SAL_CALL copyRect( const css::uno::Reference< css::rendering::XBitmapCanvas >&   sourceCanvas,
 106                                         const css::geometry::RealRectangle2D&                                      sourceRect,
 107                                         const css::rendering::ViewState&                                           sourceViewState,
 108                                         const css::rendering::RenderState&                                         sourceRenderState,
 109                                         const css::geometry::RealRectangle2D&                                      destRect,
 110                                         const css::rendering::ViewState&                                           destViewState,
 111                                         const css::rendering::RenderState&                                         destRenderState ) override
 112         {
 113             tools::verifyArgs(sourceCanvas, sourceRect, sourceViewState, sourceRenderState,
 114                               destRect, destViewState, destRenderState,
 115                               __func__,
 116                               static_cast< typename BaseType::UnambiguousBaseType* >(this));
 117
 118             typename BaseType::BaseType::MutexType aGuard( BaseType::m_aMutex );
 119
 120             BaseType::BaseType::mbSurfaceDirty = true;
 121         }
 122     };
 123 }
 124
 125 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */