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 #pragma once
  21
  22 #include <sal/config.h>
  23
  24 #include <utility>
  25 #include <vector>
  26
  27 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  28
  29 #include "CustomAnimationEffect.hxx"
  30
  31 #include <unordered_map>
  32
  33 namespace sd {
  34
  35 typedef std::unordered_map< OUString, CustomAnimationEffectPtr > EffectsSubTypeMap;
  36 typedef std::unordered_map< OUString, OUString > UStringMap;
  37
  38 class CustomAnimationPreset
  39 {
  40     friend class CustomAnimationPresets;
  41
  42 public:
  43     CustomAnimationPreset( const CustomAnimationEffectPtr& pEffect );
  44
  45     void add( const CustomAnimationEffectPtr& pEffect );
  46
  47     SD_DLLPUBLIC css::uno::Reference< css::animations::XAnimationNode > create( const OUString& rstrSubType );
  48
  49     const OUString& getPresetId() const { return maPresetId; }
  50     const OUString& getLabel() const { return maLabel; }
  51     double getDuration() const { return mfDuration; }
  52
  53     std::vector<OUString> getSubTypes();
  54     std::vector<OUString> getProperties() const;
  55
  56     bool hasProperty( std::u16string_view rProperty ) const;
  57     bool isTextOnly() const { return mbIsTextOnly; }
  58
  59 private:
  60     OUString maPresetId;
  61     OUString maProperty;
  62     OUString maLabel;
  63     OUString maDefaultSubTyp;
  64     double mfDuration;
  65     bool mbIsTextOnly;
  66
  67     EffectsSubTypeMap maSubTypes;
  68 };
  69
  70 typedef std::shared_ptr< CustomAnimationPreset > CustomAnimationPresetPtr;
  71 typedef std::unordered_map<OUString, CustomAnimationPresetPtr> EffectDescriptorMap;
  72 typedef std::vector< CustomAnimationPresetPtr > EffectDescriptorList;
  73
  74 struct PresetCategory
  75 {
  76     OUString maLabel;
  77     EffectDescriptorList maEffects;
  78
  79     PresetCategory( OUString aLabel, EffectDescriptorList&& rEffects )
  80         : maLabel(std::move( aLabel )), maEffects( std::move(rEffects) ) {}
  81 };
  82 typedef std::shared_ptr< PresetCategory > PresetCategoryPtr;
  83 typedef std::vector< PresetCategoryPtr > PresetCategoryList;
  84
  85 class SD_DLLPUBLIC CustomAnimationPresets final
  86 {
  87 public:
  88     SAL_DLLPRIVATE CustomAnimationPresets();
  89     SAL_DLLPRIVATE ~CustomAnimationPresets();
  90
  91     /** This method gets presets instance, which is localized
  92      * for the current user's locale.
  93     */
  94     static const CustomAnimationPresets& getCustomAnimationPresets();
  95
  96     SAL_DLLPRIVATE css::uno::Reference< css::animations::XAnimationNode > getRandomPreset( sal_Int16 nPresetClass ) const;
  97
  98     CustomAnimationPresetPtr getEffectDescriptor( const OUString& rPresetId ) const;
  99
 100     SAL_DLLPRIVATE const OUString& getUINameForPresetId( const OUString& rPresetId ) const;
 101     SAL_DLLPRIVATE const OUString& getUINameForProperty( const OUString& rProperty ) const;
 102
 103     SAL_DLLPRIVATE const PresetCategoryList& getEntrancePresets() const { return maEntrancePresets; }
 104     SAL_DLLPRIVATE const PresetCategoryList& getEmphasisPresets() const { return maEmphasisPresets; }
 105     SAL_DLLPRIVATE const PresetCategoryList& getExitPresets() const { return maExitPresets; }
 106     SAL_DLLPRIVATE const PresetCategoryList& getMotionPathsPresets() const { return maMotionPathsPresets; }
 107     SAL_DLLPRIVATE const PresetCategoryList& getMiscPresets() const { return maMiscPresets; }
 108
 109     SAL_DLLPRIVATE void changePresetSubType( const CustomAnimationEffectPtr& pEffect, const OUString& rPresetSubType ) const;
 110
 111 private:
 112     SAL_DLLPRIVATE void importEffects();
 113     SAL_DLLPRIVATE void importResources();
 114
 115     SAL_DLLPRIVATE void importPresets( const css::uno::Reference< css::lang::XMultiServiceFactory >& xConfigProvider, const OUString& rNodePath, PresetCategoryList& rPresetMap  );
 116
 117     SAL_DLLPRIVATE static const OUString& translateName( const OUString& rId, const UStringMap& rNameMap );
 118
 119 private:
 120     css::uno::Reference< css::animations::XAnimationNode > mxRootNode;
 121     EffectDescriptorMap maEffectDescriptorMap;
 122     UStringMap maEffectNameMap;
 123     UStringMap maPropertyNameMap;
 124
 125     PresetCategoryList maEntrancePresets;
 126     PresetCategoryList maEmphasisPresets;
 127     PresetCategoryList maExitPresets;
 128     PresetCategoryList maMotionPathsPresets;
 129     PresetCategoryList maMiscPresets;
 130
 131     //! Maps per-language the animation presets.
 132     SAL_DLLPRIVATE static std::map<OUString, CustomAnimationPresets>  mPresetsMap;
 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 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */