canvas/source/tools/propertysethelper.cxx

   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: propertysethelper.cxx,v $
  10  * $Revision: 1.5 $
  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
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_canvas.hxx"
  33
  34 #include <canvas/propertysethelper.hxx>
  35
  36 using namespace ::com::sun::star;
  37
  38 namespace canvas
  39 {
  40     namespace
  41     {
  42         void throwUnknown( const ::rtl::OUString& aPropertyName )
  43         {
  44             throw beans::UnknownPropertyException(
  45                 ::rtl::OUString::createFromAscii("PropertySetHelper: property ") +
  46                 aPropertyName +
  47                 ::rtl::OUString::createFromAscii(" not found."),
  48                 uno::Reference< uno::XInterface >()
  49                 );
  50         }
  51
  52         void throwVeto( const ::rtl::OUString& aPropertyName )
  53         {
  54             throw beans::PropertyVetoException(
  55                 ::rtl::OUString::createFromAscii("PropertySetHelper: property ") +
  56                 aPropertyName +
  57                 ::rtl::OUString::createFromAscii(" access was vetoed."),
  58                 uno::Reference< uno::XInterface >() );
  59         }
  60
  61         struct EntryComparator
  62         {
  63             bool operator()( const PropertySetHelper::MapType::MapEntry& rLHS,
  64                              const PropertySetHelper::MapType::MapEntry& rRHS )
  65             {
  66                 return strcmp( rLHS.maKey,
  67                                rRHS.maKey ) < 0;
  68             }
  69         };
  70     }
  71
  72     PropertySetHelper::PropertySetHelper() :
  73         mpMap(),
  74         maMapEntries()
  75     {
  76     }
  77
  78     PropertySetHelper::PropertySetHelper( const InputMap& rMap ) :
  79         mpMap(),
  80         maMapEntries()
  81     {
  82         initProperties(rMap);
  83     }
  84
  85     void PropertySetHelper::initProperties( const InputMap& rMap )
  86     {
  87         mpMap.reset();
  88         maMapEntries = rMap;
  89
  90         std::sort( maMapEntries.begin(),
  91                    maMapEntries.end(),
  92                    EntryComparator() );
  93
  94         if( !maMapEntries.empty() )
  95             mpMap.reset( new MapType(&maMapEntries[0],
  96                                      maMapEntries.size(),
  97                                      true) );
  98     }
  99
 100     void PropertySetHelper::addProperties( const InputMap& rMap )
 101     {
 102         InputMap aMerged( getPropertyMap() );
 103         aMerged.insert( aMerged.end(),
 104                         rMap.begin(),
 105                         rMap.end() );
 106
 107         initProperties( aMerged );
 108     }
 109
 110     bool PropertySetHelper::isPropertyName( const ::rtl::OUString& aPropertyName ) const
 111     {
 112         if( !mpMap.get() )
 113             return false;
 114
 115         Callbacks aDummy;
 116         return mpMap->lookup( aPropertyName,
 117                               aDummy );
 118     }
 119
 120     uno::Reference< beans::XPropertySetInfo > PropertySetHelper::getPropertySetInfo() const
 121     {
 122         // we're a stealth property set
 123         return uno::Reference< beans::XPropertySetInfo >();
 124     }
 125
 126     void PropertySetHelper::setPropertyValue( const ::rtl::OUString& aPropertyName,
 127                                               const uno::Any&        aValue )
 128     {
 129         Callbacks aCallbacks;
 130         if( !mpMap.get() ||
 131             !mpMap->lookup( aPropertyName,
 132                             aCallbacks ) )
 133         {
 134             throwUnknown( aPropertyName );
 135         }
 136
 137         if( aCallbacks.setter.empty() )
 138             throwVeto( aPropertyName );
 139
 140         aCallbacks.setter(aValue);
 141     }
 142
 143     uno::Any PropertySetHelper::getPropertyValue( const ::rtl::OUString& aPropertyName ) const
 144     {
 145         Callbacks aCallbacks;
 146         if( !mpMap.get() ||
 147             !mpMap->lookup( aPropertyName,
 148                             aCallbacks ) )
 149         {
 150             throwUnknown( aPropertyName );
 151         }
 152
 153         if( !aCallbacks.getter.empty() )
 154             return aCallbacks.getter();
 155
 156         // TODO(Q1): subtlety, empty getter method silently returns
 157         // the empty any
 158         return uno::Any();
 159     }
 160
 161     void PropertySetHelper::addPropertyChangeListener( const ::rtl::OUString&                                  aPropertyName,
 162                                                        const uno::Reference< beans::XPropertyChangeListener >& /*xListener*/ )
 163     {
 164         // check validity of property, but otherwise ignore the
 165         // request
 166         if( !isPropertyName( aPropertyName ) )
 167             throwUnknown( aPropertyName );
 168     }
 169
 170     void PropertySetHelper::removePropertyChangeListener( const ::rtl::OUString&                                  /*aPropertyName*/,
 171                                                           const uno::Reference< beans::XPropertyChangeListener >& /*xListener*/ )
 172     {
 173         // ignore request, no listener added in the first place
 174     }
 175
 176     void PropertySetHelper::addVetoableChangeListener( const ::rtl::OUString&                                  aPropertyName,
 177                                                        const uno::Reference< beans::XVetoableChangeListener >& /*xListener*/ )
 178     {
 179         // check validity of property, but otherwise ignore the
 180         // request
 181         if( !isPropertyName( aPropertyName ) )
 182             throwUnknown( aPropertyName );
 183     }
 184
 185     void PropertySetHelper::removeVetoableChangeListener( const ::rtl::OUString&                                  /*aPropertyName*/,
 186                                                           const uno::Reference< beans::XVetoableChangeListener >& /*xListener*/ )
 187     {
 188         // ignore request, no listener added in the first place
 189     }
 190 }