sd/inc/CustomAnimationPreset.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_SD_INC_CUSTOMANIMATIONPRESET_HXX
  21 #define INCLUDED_SD_INC_CUSTOMANIMATIONPRESET_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <memory>
  26 #include <vector>
  27
  28 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  29 #include <com/sun/star/animations/AnimationNodeType.hpp>
  30
  31 #include <CustomAnimationEffect.hxx>
  32
  33 #include <unordered_map>
  34
  35 namespace sd {
  36
  37 typedef std::unordered_map< OUString, CustomAnimationEffectPtr, OUStringHash > EffectsSubTypeMap;
  38 typedef std::unordered_map< OUString, OUString, OUStringHash > UStringMap;
  39 typedef std::vector< OUString > UStringList;
  40
  41 class CustomAnimationPreset
  42 {
  43     friend class CustomAnimationPresets;
  44
  45 public:
  46     CustomAnimationPreset( CustomAnimationEffectPtr pEffect );
  47
  48     void add( const CustomAnimationEffectPtr& pEffect );
  49
  50     SD_DLLPUBLIC css::uno::Reference< css::animations::XAnimationNode > create( const OUString& rstrSubType );
  51
  52     const OUString& getPresetId() const { return maPresetId; }
  53     const OUString& getLabel() const { return maLabel; }
  54     double getDuration() const { return mfDuration; }
  55
  56     UStringList getSubTypes();
  57     UStringList getProperties() const;
  58
  59     bool hasProperty( const OUString& rProperty ) const;
  60     bool isTextOnly() const { return mbIsTextOnly; }
  61
  62 private:
  63     OUString maPresetId;
  64     OUString maProperty;
  65     sal_Int16 mnPresetClass;
  66     OUString maLabel;
  67     OUString maDefaultSubTyp;
  68     double mfDuration;
  69     bool mbIsTextOnly;
  70
  71     EffectsSubTypeMap maSubTypes;
  72 };
  73
  74 typedef std::shared_ptr< CustomAnimationPreset > CustomAnimationPresetPtr;
  75 typedef std::unordered_map<OUString, CustomAnimationPresetPtr, OUStringHash> EffectDescriptorMap;
  76 typedef std::vector< CustomAnimationPresetPtr > EffectDescriptorList;
  77
  78 struct PresetCategory
  79 {
  80     OUString maLabel;
  81     EffectDescriptorList maEffects;
  82
  83     PresetCategory( const OUString& rLabel, const EffectDescriptorList& rEffects )
  84         : maLabel( rLabel ), maEffects( rEffects ) {}
  85 };
  86 typedef std::shared_ptr< PresetCategory > PresetCategoryPtr;
  87 typedef std::vector< PresetCategoryPtr > PresetCategoryList;
  88
  89 class SD_DLLPUBLIC CustomAnimationPresets final
  90 {
  91 public:
  92     SAL_DLLPRIVATE CustomAnimationPresets();
  93     SAL_DLLPRIVATE ~CustomAnimationPresets();
  94
  95     static const CustomAnimationPresets& getCustomAnimationPresets();
  96
  97     SAL_DLLPRIVATE css::uno::Reference< css::animations::XAnimationNode > getRandomPreset( sal_Int16 nPresetClass ) const;
  98
  99     CustomAnimationPresetPtr getEffectDescriptor( const OUString& rPresetId ) const;
 100
 101     SAL_DLLPRIVATE const OUString& getUINameForPresetId( const OUString& rPresetId ) const;
 102     SAL_DLLPRIVATE const OUString& getUINameForProperty( const OUString& rProperty ) const;
 103
 104     SAL_DLLPRIVATE const PresetCategoryList& getEntrancePresets() const { return maEntrancePresets; }
 105     SAL_DLLPRIVATE const PresetCategoryList& getEmphasisPresets() const { return maEmphasisPresets; }
 106     SAL_DLLPRIVATE const PresetCategoryList& getExitPresets() const { return maExitPresets; }
 107     SAL_DLLPRIVATE const PresetCategoryList& getMotionPathsPresets() const { return maMotionPathsPresets; }
 108     SAL_DLLPRIVATE const PresetCategoryList& getMiscPresets() const { return maMiscPresets; }
 109
 110     SAL_DLLPRIVATE void changePresetSubType( const CustomAnimationEffectPtr& pEffect, const OUString& rPresetSubType ) const;
 111
 112 private:
 113     SAL_DLLPRIVATE void importEffects();
 114     SAL_DLLPRIVATE void importResources();
 115
 116     SAL_DLLPRIVATE void importPresets( const css::uno::Reference< css::lang::XMultiServiceFactory >& xConfigProvider, const OUString& rNodePath, PresetCategoryList& rPresetMap  );
 117
 118     SAL_DLLPRIVATE static const OUString& translateName( const OUString& rId, const UStringMap& rNameMap );
 119
 120 private:
 121     css::uno::Reference< css::animations::XAnimationNode > mxRootNode;
 122     EffectDescriptorMap maEffectDiscriptorMap;
 123     UStringMap maEffectNameMap;
 124     UStringMap maPropertyNameMap;
 125
 126     PresetCategoryList maEntrancePresets;
 127     PresetCategoryList maEmphasisPresets;
 128     PresetCategoryList maExitPresets;
 129     PresetCategoryList maMotionPathsPresets;
 130     PresetCategoryList maMiscPresets;
 131
 132     SAL_DLLPRIVATE static CustomAnimationPresets*  mpCustomAnimationPresets;
 133 };
 134
 135
 136 css::uno::Reference< css::animations::XAnimationNode > implImportEffects( const css::uno::Reference< css::lang::XMultiServiceFactory >& xServiceFactory, const OUString& rPath );
 137
 138 void implImportLabels( const css::uno::Reference< css::lang::XMultiServiceFactory >& xConfigProvider, const OUString& rNodePath, UStringMap& rStringMap );
 139
 140 }
 141
 142
 143 #endif // _SD_CUSTOMANIMATIONEFFECTS_HXX
 144
 145 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */