chart2/source/inc/PropertyHelper.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 #pragma once
  20
  21 #include <com/sun/star/beans/Property.hpp>
  22 #include <com/sun/star/uno/Any.hxx>
  23 #include "charttoolsdllapi.hxx"
  24
  25 #include <unordered_map>
  26
  27 namespace com::sun::star::lang { class XMultiServiceFactory; }
  28
  29 namespace chart
  30 {
  31
  32 typedef int tPropertyValueMapKey;
  33
  34 typedef std::unordered_map<tPropertyValueMapKey, css::uno::Any> tPropertyValueMap;
  35
  36 namespace PropertyHelper
  37 {
  38
  39 /** adds a line dash with a unique name to the gradient obtained by the given
  40     factory.
  41
  42     @return The name used for storing this element in the table
  43 */
  44 OOO_DLLPUBLIC_CHARTTOOLS OUString addLineDashUniqueNameToTable(
  45     const css::uno::Any & rValue,
  46     const css::uno::Reference< css::lang::XMultiServiceFactory > & xFact,
  47     const OUString & rPreferredName );
  48
  49 /** adds a gradient with a unique name to the gradient obtained by the given
  50     factory.
  51
  52     @return The name used for storing this element in the table
  53 */
  54 OOO_DLLPUBLIC_CHARTTOOLS OUString addGradientUniqueNameToTable(
  55     const css::uno::Any & rValue,
  56     const css::uno::Reference< css::lang::XMultiServiceFactory > & xFact,
  57     const OUString & rPreferredName );
  58
  59 /** adds a transparency gradient with a unique name to the gradient obtained
  60     by the given factory.
  61
  62     @return The name used for storing this element in the table
  63 */
  64 OOO_DLLPUBLIC_CHARTTOOLS
  65 OUString addTransparencyGradientUniqueNameToTable(
  66     const css::uno::Any & rValue,
  67     const css::uno::Reference< css::lang::XMultiServiceFactory > & xFact,
  68     const OUString & rPreferredName );
  69
  70 /** adds a hatch with a unique name to the gradient obtained by the given
  71     factory.
  72
  73     @return The name used for storing this element in the table
  74 */
  75 OOO_DLLPUBLIC_CHARTTOOLS OUString addHatchUniqueNameToTable(
  76     const css::uno::Any & rValue,
  77     const css::uno::Reference< css::lang::XMultiServiceFactory > & xFact,
  78     const OUString & rPreferredName );
  79
  80 /** adds a bitmap with a unique name to the gradient obtained by the given
  81     factory.
  82
  83     @return The name used for storing this element in the table
  84 */
  85 OOO_DLLPUBLIC_CHARTTOOLS OUString addBitmapUniqueNameToTable(
  86     const css::uno::Any & rValue,
  87     const css::uno::Reference< css::lang::XMultiServiceFactory > & xFact,
  88     const OUString & rPreferredName );
  89
  90 /** Set a property to a certain value in the given map.  This works for
  91     properties that are already set, and those which are not yet in the map.
  92
  93     @param any is the value encapsulated in the variant type Any
  94  */
  95 OOO_DLLPUBLIC_CHARTTOOLS
  96 void setPropertyValueAny( tPropertyValueMap & rOutMap, tPropertyValueMapKey key,
  97                           const css::uno::Any & rAny );
  98
  99 /** Set a property to a certain value in the given map.  This works for
 100     properties that are already set, and those which are not yet in the map.
 101
 102     @param value is the value of type Value that will be put into a variant type
 103         Any before set in the property map.
 104  */
 105 template< typename Value >
 106     void setPropertyValue( tPropertyValueMap & rOutMap, tPropertyValueMapKey key, const Value & value )
 107 {
 108     setPropertyValueAny( rOutMap, key, css::uno::Any( value ));
 109 }
 110
 111 template<>
 112     void setPropertyValue< css::uno::Any >( tPropertyValueMap & rOutMap, tPropertyValueMapKey key, const css::uno::Any & rAny );
 113
 114 OOO_DLLPUBLIC_CHARTTOOLS void setPropertyValueDefaultAny( tPropertyValueMap & rOutMap, tPropertyValueMapKey key, const css::uno::Any & rAny );
 115
 116 /** Calls setPropertyValue() but asserts that the given property hasn't been set
 117     before.
 118  */
 119 template< typename Value >
 120     void setPropertyValueDefault( tPropertyValueMap & rOutMap, tPropertyValueMapKey key, const Value & value )
 121 {
 122     setPropertyValueDefaultAny( rOutMap, key, css::uno::Any( value ));
 123 }
 124
 125 /** Calls setPropertyValue() but asserts that the given property hasn't been set
 126     before.
 127  */
 128 template<>
 129     void setPropertyValueDefault< css::uno::Any >( tPropertyValueMap & rOutMap, tPropertyValueMapKey key, const css::uno::Any & rAny );
 130
 131 /** Calls setPropertyValueDefault() with an empty Any as value
 132  */
 133 OOO_DLLPUBLIC_CHARTTOOLS void setEmptyPropertyValueDefault( tPropertyValueMap & rOutMap, tPropertyValueMapKey key );
 134
 135 } // namespace PropertyHelper
 136
 137 struct OOO_DLLPUBLIC_CHARTTOOLS PropertyNameLess
 138 {
 139     bool operator() ( const css::beans::Property & first,
 140                              const css::beans::Property & second )
 141     {
 142         return ( first.Name.compareTo( second.Name ) < 0 );
 143     }
 144 };
 145
 146 } //  namespace chart
 147
 148 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */