chart2/source/inc/PropertyHelper.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: PropertyHelper.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef CHART_PROPERTYHELPER_HXX
  31 #define CHART_PROPERTYHELPER_HXX
  32
  33 #include <com/sun/star/beans/XPropertySet.hpp>
  34 #include <com/sun/star/beans/Property.hpp>
  35 #include <com/sun/star/beans/PropertyValue.hpp>
  36 #include <com/sun/star/uno/Any.hxx>
  37 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  38 #include <comphelper/property.hxx>
  39 #include <map>
  40 #include "charttoolsdllapi.hxx"
  41
  42 namespace chart
  43 {
  44
  45 typedef int tPropertyValueMapKey;
  46
  47 typedef ::std::map< tPropertyValueMapKey, ::com::sun::star::uno::Any >
  48     tPropertyValueMap;
  49
  50 namespace PropertyHelper
  51 {
  52
  53 /** adds a line dash with a unique name to the gradient obtained by the given
  54     factory.
  55
  56     @return The name used for storing this element in the table
  57 */
  58 OOO_DLLPUBLIC_CHARTTOOLS ::rtl::OUString addLineDashUniqueNameToTable(
  59     const ::com::sun::star::uno::Any & rValue,
  60     const ::com::sun::star::uno::Reference<
  61         ::com::sun::star::lang::XMultiServiceFactory > & xFact,
  62     const ::rtl::OUString & rPreferredName );
  63
  64 /** adds a gradient with a unique name to the gradient obtained by the given
  65     factory.
  66
  67     @return The name used for storing this element in the table
  68 */
  69 OOO_DLLPUBLIC_CHARTTOOLS ::rtl::OUString addGradientUniqueNameToTable(
  70     const ::com::sun::star::uno::Any & rValue,
  71     const ::com::sun::star::uno::Reference<
  72         ::com::sun::star::lang::XMultiServiceFactory > & xFact,
  73     const ::rtl::OUString & rPreferredName );
  74
  75 /** adds a transparency gradient with a unique name to the gradient obtained
  76     by the given factory.
  77
  78     @return The name used for storing this element in the table
  79 */
  80 OOO_DLLPUBLIC_CHARTTOOLS
  81 ::rtl::OUString addTransparencyGradientUniqueNameToTable(
  82     const ::com::sun::star::uno::Any & rValue,
  83     const ::com::sun::star::uno::Reference<
  84         ::com::sun::star::lang::XMultiServiceFactory > & xFact,
  85     const ::rtl::OUString & rPreferredName );
  86
  87 /** adds a hatch with a unique name to the gradient obtained by the given
  88     factory.
  89
  90     @return The name used for storing this element in the table
  91 */
  92 OOO_DLLPUBLIC_CHARTTOOLS ::rtl::OUString addHatchUniqueNameToTable(
  93     const ::com::sun::star::uno::Any & rValue,
  94     const ::com::sun::star::uno::Reference<
  95         ::com::sun::star::lang::XMultiServiceFactory > & xFact,
  96     const ::rtl::OUString & rPreferredName );
  97
  98 /** adds a bitmap with a unique name to the gradient obtained by the given
  99     factory.
 100
 101     @return The name used for storing this element in the table
 102 */
 103 OOO_DLLPUBLIC_CHARTTOOLS ::rtl::OUString addBitmapUniqueNameToTable(
 104     const ::com::sun::star::uno::Any & rValue,
 105     const ::com::sun::star::uno::Reference<
 106         ::com::sun::star::lang::XMultiServiceFactory > & xFact,
 107     const ::rtl::OUString & rPreferredName );
 108
 109 // --------------------------------------------------------------------------------
 110
 111 /** Set a property to a certain value in the given map.  This works for
 112     properties that are already set, and those which are not yet in the map.
 113
 114     @param any is the value encapsulated in the variant type Any
 115  */
 116 OOO_DLLPUBLIC_CHARTTOOLS
 117 void setPropertyValueAny( tPropertyValueMap & rOutMap, tPropertyValueMapKey key,
 118                           const ::com::sun::star::uno::Any & rAny );
 119
 120 /** Set a property to a certain value in the given map.  This works for
 121     properties that are already set, and those which are not yet in the map.
 122
 123     @param value is the value of type Value that will be put into a variant type
 124         Any before set in the property map.
 125  */
 126 template< typename Value >
 127     void setPropertyValue( tPropertyValueMap & rOutMap, tPropertyValueMapKey key, const Value & value )
 128 {
 129     setPropertyValueAny( rOutMap, key, ::com::sun::star::uno::makeAny( value ));
 130 }
 131
 132 template<>
 133     void setPropertyValue< ::com::sun::star::uno::Any >( tPropertyValueMap & rOutMap, tPropertyValueMapKey key, const ::com::sun::star::uno::Any & rAny );
 134
 135 OOO_DLLPUBLIC_CHARTTOOLS void setPropertyValueDefaultAny( tPropertyValueMap & rOutMap, tPropertyValueMapKey key, const ::com::sun::star::uno::Any & rAny );
 136
 137 /** Calls setPropertyValue() but asserts that the given property hasn't been set
 138     before.
 139  */
 140 template< typename Value >
 141     void setPropertyValueDefault( tPropertyValueMap & rOutMap, tPropertyValueMapKey key, const Value & value )
 142 {
 143     setPropertyValueDefaultAny( rOutMap, key, ::com::sun::star::uno::makeAny( value ));
 144 }
 145
 146 /** Calls setPropertyValue() but asserts that the given property hasn't been set
 147     before.
 148  */
 149 template<>
 150     void setPropertyValueDefault< ::com::sun::star::uno::Any >( tPropertyValueMap & rOutMap, tPropertyValueMapKey key, const ::com::sun::star::uno::Any & rAny );
 151
 152 /** Calls setPropertyValueDefault() with an empty Any as value
 153  */
 154 OOO_DLLPUBLIC_CHARTTOOLS void setEmptyPropertyValueDefault( tPropertyValueMap & rOutMap, tPropertyValueMapKey key );
 155
 156
 157 } // namespace PropertyHelper
 158
 159 // ================================================================================
 160
 161 struct OOO_DLLPUBLIC_CHARTTOOLS PropertyNameLess
 162 {
 163     inline bool operator() ( const ::com::sun::star::beans::Property & first,
 164                              const ::com::sun::star::beans::Property & second )
 165     {
 166         return ( first.Name.compareTo( second.Name ) < 0 );
 167     }
 168 };
 169
 170 struct OOO_DLLPUBLIC_CHARTTOOLS PropertyLess : public ::std::binary_function<
 171         ::com::sun::star::beans::Property,
 172         ::com::sun::star::beans::Property,
 173         bool >
 174 {
 175     bool operator() ( const ::com::sun::star::beans::Property & rFirst,
 176                       const ::com::sun::star::beans::Property & rSecond )
 177     {
 178         return ( rFirst.Name.compareTo( rSecond.Name ) < 0 );
 179     }
 180 };
 181
 182 struct OOO_DLLPUBLIC_CHARTTOOLS PropertyValueNameEquals : public ::std::unary_function< ::com::sun::star::beans::PropertyValue, bool >
 183 {
 184     explicit PropertyValueNameEquals( const ::rtl::OUString & rName ) :
 185             m_aName( rName )
 186     {}
 187
 188     bool operator() ( const ::com::sun::star::beans::PropertyValue & rPropValue )
 189     {
 190         return rPropValue.Name.equals( m_aName );
 191     }
 192
 193 private:
 194     ::rtl::OUString m_aName;
 195 };
 196
 197 } //  namespace chart
 198
 199 // CHART_PROPERTYHELPER_HXX
 200 #endif