slideshow/source/engine/shapes/gdimtftools.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 INCLUDED_SLIDESHOW_SOURCE_ENGINE_SHAPES_GDIMTFTOOLS_HXX
  21 #define INCLUDED_SLIDESHOW_SOURCE_ENGINE_SHAPES_GDIMTFTOOLS_HXX
  22
  23 #include <com/sun/star/uno/Reference.hxx>
  24 #include <com/sun/star/uno/XComponentContext.hpp>
  25 #include <com/sun/star/lang/XComponent.hpp>
  26 #include <com/sun/star/drawing/XDrawPage.hpp>
  27
  28 #include <basegfx/range/b2drectangle.hxx>
  29
  30 #include <tools.hxx>
  31
  32 #include <utility>
  33 #include <vector>
  34
  35 class MetaAction;
  36 class GDIMetaFile;
  37 class Graphic;
  38
  39
  40 namespace slideshow::internal
  41     {
  42         /// meta file loading specialities:
  43         enum mtf_load_flags {
  44             /// no flags
  45             MTF_LOAD_NONE = 0,
  46             /// the source of the metafile might be a foreign
  47             /// application. The metafile is checked against unsupported
  48             /// content, and, if necessary, returned as a pre-rendered
  49             /// bitmap.
  50             MTF_LOAD_FOREIGN_SOURCE = 2,
  51             /// retrieve a meta file for the page background only
  52             MTF_LOAD_BACKGROUND_ONLY = 4,
  53             /// retrieve the drawing layer scroll text metafile
  54             MTF_LOAD_SCROLL_TEXT_MTF = 8
  55         };
  56
  57         // Animation info
  58         // ==============
  59
  60         struct MtfAnimationFrame
  61         {
  62             MtfAnimationFrame( GDIMetaFileSharedPtr        xMtf,
  63                                double                      nDuration ) :
  64                 mpMtf(std::move( xMtf )),
  65                 mnDuration( nDuration )
  66             {
  67             }
  68
  69             /// Enables STL algos to be used for duration extraction
  70             double getDuration() const
  71             {
  72                 return mnDuration;
  73             }
  74
  75             GDIMetaFileSharedPtr    mpMtf;
  76             double                  mnDuration;
  77         };
  78
  79         typedef ::std::vector< MtfAnimationFrame > VectorOfMtfAnimationFrames;
  80
  81
  82         /** Retrieve a meta file for the given shape
  83
  84             @param xShape
  85             XShape to retrieve a metafile for.
  86
  87             @param xContainingPage
  88             The page that contains this shape. Needed for proper
  89             import (currently, the UnoGraphicExporter needs this
  90             information).
  91
  92         */
  93         GDIMetaFileSharedPtr getMetaFile( const css::uno::Reference< css::lang::XComponent >&        xSource,
  94                                           const css::uno::Reference< css::drawing::XDrawPage >&      xContainingPage,
  95                                           int                                                        mtfLoadFlags,
  96                                           const css::uno::Reference< css::uno::XComponentContext >&  rxContext );
  97
  98         /** Gets the next action offset for iterating meta actions which is most
  99             often returns 1.
 100         */
 101         sal_Int32 getNextActionOffset( MetaAction * pCurrAct );
 102
 103         /** Extract a vector of animation frames from given Graphic.
 104
 105             @param o_rFrames
 106             Resulting vector of animated metafiles
 107
 108             @param o_rLoopCount
 109             Number of times the bitmap animation shall be repeated
 110
 111             @param rGraphic
 112             Input graphic object, to extract animations from
 113          */
 114         bool getAnimationFromGraphic(VectorOfMtfAnimationFrames& o_rFrames,
 115                                      sal_uInt32&                 o_rLoopCount,
 116                                      const Graphic&              rGraphic);
 117
 118         /** Retrieve scroll text animation rectangles from given metafile
 119
 120             @return true, if both rectangles have been found, false
 121             otherwise.
 122          */
 123         bool getRectanglesFromScrollMtf( ::basegfx::B2DRectangle&       o_rScrollRect,
 124                                          ::basegfx::B2DRectangle&       o_rPaintRect,
 125                                          const GDIMetaFileSharedPtr&    rMtf );
 126 }
 127
 128 #endif // INCLUDED_SLIDESHOW_SOURCE_ENGINE_SHAPES_GDIMTFTOOLS_HXX
 129
 130 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */