Branch data     Line data    Source code

       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 _CPPCANVAS_BITMAP_HXX
      21                 :            : #define _CPPCANVAS_BITMAP_HXX
      22                 :            : 
      23                 :            : #include <com/sun/star/uno/Reference.hxx>
      24                 :            : 
      25                 :            : #include <boost/shared_ptr.hpp>
      26                 :            : #include <cppcanvas/canvasgraphic.hxx>
      27                 :            : #include <cppcanvas/bitmapcanvas.hxx>
      28                 :            : 
      29                 :            : namespace com { namespace sun { namespace star { namespace rendering
      30                 :            : {
      31                 :            :     class  XBitmap;
      32                 :            : } } } }
      33                 :            : 
      34                 :            : 
      35                 :            : /* Definition of Bitmap interface */
      36                 :            : 
      37                 :            : namespace cppcanvas
      38                 :            : {
      39                 :            : 
      40                 :            :     /** This interface defines a Bitmap canvas object
      41                 :            : 
      42                 :            :         Consider this object part of the view, and not of the model
      43                 :            :         data, as this bitmap can only be painted on its parent canvas
      44                 :            :      */
      45 [ #  # ][ #  # ]:          0 :     class Bitmap : public virtual CanvasGraphic
         [ #  # ][ #  # ]
      46                 :            :     {
      47                 :            :     public:
      48                 :            :         /** Render to parent canvas, with global alpha.
      49                 :            : 
      50                 :            :             This method renders the content to the parent canvas,
      51                 :            :             i.e. the canvas this object was constructed for.
      52                 :            : 
      53                 :            :             @param nAlphaModulation
      54                 :            :             Global alpha value, with which each pixel alpha value gets
      55                 :            :             multiplied. For a normal, opaque bitmap, this will make
      56                 :            :             the bitmap appear transparent with the given alpha value
      57                 :            :             (value must be in the range [0,1]).
      58                 :            : 
      59                 :            :             @return whether the rendering finished successfully.
      60                 :            :          */
      61                 :            :         virtual bool                        drawAlphaModulated( double nAlphaModulation ) const = 0;
      62                 :            : 
      63                 :            :         virtual BitmapCanvasSharedPtr       getBitmapCanvas() const = 0;
      64                 :            : 
      65                 :            :         virtual ::com::sun::star::uno::Reference<
      66                 :            :             ::com::sun::star::rendering::XBitmap >  getUNOBitmap() const = 0;
      67                 :            :     };
      68                 :            : 
      69                 :            :     typedef ::boost::shared_ptr< ::cppcanvas::Bitmap > BitmapSharedPtr;
      70                 :            : }
      71                 :            : 
      72                 :            : #endif /* _CPPCANVAS_BITMAP_HXX */
      73                 :            : 
      74                 :            : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */