xmloff/source/forms/gridcolumnproptranslator.cxx

   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 #include "gridcolumnproptranslator.hxx"
  21
  22 #include <com/sun/star/beans/XPropertySetInfo.hpp>
  23 #include <com/sun/star/awt/TextAlign.hpp>
  24 #include <com/sun/star/style/ParagraphAdjust.hpp>
  25 #include <osl/diagnose.h>
  26 #include <cppuhelper/implbase1.hxx>
  27
  28 #include <algorithm>
  29
  30 //........................................................................
  31 namespace xmloff
  32 {
  33 //........................................................................
  34
  35     using namespace ::com::sun::star::uno;
  36     using namespace ::com::sun::star::awt;
  37     using namespace ::com::sun::star;
  38     using namespace ::com::sun::star::lang;
  39     using namespace ::com::sun::star::beans;
  40     using namespace ::com::sun::star::style;
  41
  42     namespace
  43     {
  44         //----------------------------------------------------------------
  45         OUString getParaAlignProperty()
  46         {
  47             return OUString( "ParaAdjust" );
  48         }
  49
  50         //----------------------------------------------------------------
  51         OUString getAlignProperty()
  52         {
  53             return OUString( "Align" );
  54         }
  55
  56         //----------------------------------------------------------------
  57         sal_Int32 findStringElement( const Sequence< OUString >& _rNames, const OUString& _rName )
  58         {
  59             const OUString* pStart = _rNames.getConstArray();
  60             const OUString* pEnd = _rNames.getConstArray() + _rNames.getLength();
  61             const OUString* pPos = ::std::find( pStart, pEnd, _rName );
  62             if ( pPos != pEnd )
  63                 return pPos - pStart;
  64             return -1;
  65         }
  66
  67         //----------------------------------------------------------------
  68         struct AlignmentTranslationEntry
  69         {
  70             ParagraphAdjust nParagraphValue;
  71             sal_Int16       nControlValue;
  72         }
  73         AlignmentTranslations[] =
  74         {
  75             // note that order matters:
  76             // valueAlignToParaAdjust and valueParaAdjustToAlign search this map from the _beginning_
  77             // and use the first matching entry
  78             { ParagraphAdjust_LEFT,             awt::TextAlign::LEFT     },
  79             { ParagraphAdjust_CENTER,           awt::TextAlign::CENTER   },
  80             { ParagraphAdjust_RIGHT,            awt::TextAlign::RIGHT    },
  81             { ParagraphAdjust_BLOCK,            awt::TextAlign::RIGHT    },
  82             { ParagraphAdjust_STRETCH,          awt::TextAlign::LEFT     },
  83             { ParagraphAdjust_MAKE_FIXED_SIZE,  awt::TextAlign::LEFT     },
  84             { ParagraphAdjust_MAKE_FIXED_SIZE,  -1 }
  85         };
  86
  87         //----------------------------------------------------------------
  88         void valueAlignToParaAdjust(Any& rValue)
  89         {
  90             sal_Int16 nValue = 0;
  91             rValue >>= nValue;
  92             const AlignmentTranslationEntry* pTranslation = AlignmentTranslations;
  93             while (-1 != pTranslation->nControlValue)
  94             {
  95                 if ( nValue == pTranslation->nControlValue )
  96                 {
  97                     rValue <<= pTranslation->nParagraphValue;
  98                     return;
  99                 }
 100                 ++pTranslation;
 101             }
 102             OSL_FAIL( "valueAlignToParaAdjust: unreachable!" );
 103         }
 104
 105         //----------------------------------------------------------------
 106         void valueParaAdjustToAlign(Any& rValue)
 107         {
 108             sal_Int32 nValue = 0;
 109             rValue >>= nValue;
 110             const AlignmentTranslationEntry* pTranslation = AlignmentTranslations;
 111             while ( ParagraphAdjust_MAKE_FIXED_SIZE != pTranslation->nParagraphValue)
 112             {
 113                 if ( nValue == pTranslation->nParagraphValue)
 114                 {
 115                     rValue <<= pTranslation->nControlValue;
 116                     return;
 117                 }
 118                 ++pTranslation;
 119             }
 120             OSL_FAIL( "valueParaAdjustToAlign: unreachable!" );
 121         }
 122
 123         //====================================================================
 124         //= OMergedPropertySetInfo
 125         //====================================================================
 126         typedef ::cppu::WeakAggImplHelper1  <   XPropertySetInfo
 127                                             >   OMergedPropertySetInfo_Base;
 128         class OMergedPropertySetInfo : public OMergedPropertySetInfo_Base
 129         {
 130         private:
 131             Reference< XPropertySetInfo >   m_xMasterInfo;
 132
 133         public:
 134             OMergedPropertySetInfo( const Reference< XPropertySetInfo >& _rxMasterInfo );
 135
 136         protected:
 137             virtual ~OMergedPropertySetInfo();
 138
 139             // XPropertySetInfo
 140             virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > SAL_CALL getProperties(  ) throw (::com::sun::star::uno::RuntimeException);
 141             virtual ::com::sun::star::beans::Property SAL_CALL getPropertyByName( const OUString& aName ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
 142             virtual ::sal_Bool SAL_CALL hasPropertyByName( const OUString& Name ) throw (::com::sun::star::uno::RuntimeException);
 143         };
 144
 145         //----------------------------------------------------------------
 146         OMergedPropertySetInfo::OMergedPropertySetInfo( const Reference< XPropertySetInfo >& _rxMasterInfo )
 147             :m_xMasterInfo( _rxMasterInfo )
 148         {
 149             OSL_ENSURE( m_xMasterInfo.is(), "OMergedPropertySetInfo::OMergedPropertySetInfo: hmm?" );
 150         }
 151
 152         //----------------------------------------------------------------
 153         OMergedPropertySetInfo::~OMergedPropertySetInfo()
 154         {
 155         }
 156
 157         //----------------------------------------------------------------
 158         Sequence< Property > SAL_CALL OMergedPropertySetInfo::getProperties(  ) throw (RuntimeException)
 159         {
 160             // add a "ParaAdjust" property to the master properties
 161             Sequence< Property > aProperties;
 162             if ( m_xMasterInfo.is() )
 163                 aProperties = m_xMasterInfo->getProperties();
 164
 165             sal_Int32 nOldLength = aProperties.getLength();
 166             aProperties.realloc( nOldLength + 1 );
 167             aProperties[ nOldLength ] = getPropertyByName( getParaAlignProperty() );
 168
 169             return aProperties;
 170         }
 171
 172         //----------------------------------------------------------------
 173         Property SAL_CALL OMergedPropertySetInfo::getPropertyByName( const OUString& aName ) throw (UnknownPropertyException, RuntimeException)
 174         {
 175             if ( aName == getParaAlignProperty() )
 176                 return Property( getParaAlignProperty(), -1,
 177                     ::getCppuType( static_cast< const ParagraphAdjust* >( NULL ) ), 0 );
 178
 179             if ( !m_xMasterInfo.is() )
 180                 return Property();
 181
 182             return m_xMasterInfo->getPropertyByName( aName );
 183         }
 184
 185         //----------------------------------------------------------------
 186         ::sal_Bool SAL_CALL OMergedPropertySetInfo::hasPropertyByName( const OUString& Name ) throw (RuntimeException)
 187         {
 188             if ( Name == getParaAlignProperty() )
 189                 return sal_True;
 190
 191             if ( !m_xMasterInfo.is() )
 192                 return sal_False;
 193
 194             return m_xMasterInfo->hasPropertyByName( Name );
 195         }
 196     }
 197
 198
 199     //====================================================================
 200     //= OGridColumnPropertyTranslator
 201     //====================================================================
 202     //--------------------------------------------------------------------
 203     OGridColumnPropertyTranslator::OGridColumnPropertyTranslator( const Reference< XMultiPropertySet >& _rxGridColumn )
 204         :m_xGridColumn( _rxGridColumn )
 205     {
 206         OSL_ENSURE( m_xGridColumn.is(), "OGridColumnPropertyTranslator: invalid grid column!" );
 207     }
 208
 209     //--------------------------------------------------------------------
 210     OGridColumnPropertyTranslator::~OGridColumnPropertyTranslator()
 211     {
 212     }
 213
 214     //--------------------------------------------------------------------
 215     Reference< XPropertySetInfo > SAL_CALL OGridColumnPropertyTranslator::getPropertySetInfo(  ) throw (RuntimeException)
 216     {
 217         Reference< XPropertySetInfo > xColumnPropInfo;
 218         if ( m_xGridColumn.is() )
 219             xColumnPropInfo = m_xGridColumn->getPropertySetInfo();
 220         return new OMergedPropertySetInfo( xColumnPropInfo );
 221     }
 222
 223     //--------------------------------------------------------------------
 224     void SAL_CALL OGridColumnPropertyTranslator::setPropertyValue( const OUString& _rPropertyName, const Any& aValue ) throw (UnknownPropertyException, PropertyVetoException, IllegalArgumentException, WrappedTargetException, RuntimeException)
 225     {
 226         // we implement this by delegating it to setPropertyValues, which is to ignore unknown properties. On the other hand, our
 227         // contract requires us to throw a UnknownPropertyException for unknown properties, so check this first.
 228
 229         if ( !getPropertySetInfo()->hasPropertyByName( _rPropertyName ) )
 230             throw UnknownPropertyException( _rPropertyName, *this );
 231
 232         Sequence< OUString > aNames( &_rPropertyName, 1 );
 233         Sequence< Any >             aValues( &aValue, 1 );
 234         setPropertyValues( aNames, aValues );
 235     }
 236
 237     //--------------------------------------------------------------------
 238     Any SAL_CALL OGridColumnPropertyTranslator::getPropertyValue( const OUString& PropertyName ) throw (UnknownPropertyException, WrappedTargetException, RuntimeException)
 239     {
 240         Sequence< OUString > aNames( &PropertyName, 1 );
 241         Sequence< Any > aValues = getPropertyValues( aNames );
 242         OSL_ENSURE( aValues.getLength() == 1, "OGridColumnPropertyTranslator::getPropertyValue: nonsense!" );
 243         if ( aValues.getLength() == 1 )
 244             return aValues[0];
 245         return Any();
 246     }
 247
 248     //--------------------------------------------------------------------
 249     void SAL_CALL OGridColumnPropertyTranslator::addPropertyChangeListener( const OUString&, const Reference< XPropertyChangeListener >& ) throw (UnknownPropertyException, WrappedTargetException, RuntimeException)
 250     {
 251         OSL_FAIL( "OGridColumnPropertyTranslator::addPropertyChangeListener: not implemented - this should not be needed!" );
 252     }
 253
 254     //--------------------------------------------------------------------
 255     void SAL_CALL OGridColumnPropertyTranslator::removePropertyChangeListener( const OUString&, const Reference< XPropertyChangeListener >& ) throw (UnknownPropertyException, WrappedTargetException, RuntimeException)
 256     {
 257         OSL_FAIL( "OGridColumnPropertyTranslator::removePropertyChangeListener: not implemented - this should not be needed!" );
 258     }
 259
 260     //--------------------------------------------------------------------
 261     void SAL_CALL OGridColumnPropertyTranslator::addVetoableChangeListener( const OUString&, const Reference< XVetoableChangeListener >& ) throw (UnknownPropertyException, WrappedTargetException, RuntimeException)
 262     {
 263         OSL_FAIL( "OGridColumnPropertyTranslator::addVetoableChangeListener: not implemented - this should not be needed!" );
 264     }
 265
 266     //--------------------------------------------------------------------
 267     void SAL_CALL OGridColumnPropertyTranslator::removeVetoableChangeListener( const OUString&, const Reference< XVetoableChangeListener >& ) throw (UnknownPropertyException, WrappedTargetException, RuntimeException)
 268     {
 269         OSL_FAIL( "OGridColumnPropertyTranslator::removeVetoableChangeListener: not implemented - this should not be needed!" );
 270     }
 271
 272     //--------------------------------------------------------------------
 273     void SAL_CALL OGridColumnPropertyTranslator::setPropertyValues( const Sequence< OUString >& aPropertyNames, const Sequence< Any >& aValues ) throw (PropertyVetoException, IllegalArgumentException, WrappedTargetException, RuntimeException)
 274     {
 275         if ( !m_xGridColumn.is() )
 276             return;
 277
 278         // if there's ever the need for more than one property being translated, then we should
 279         // certainly have a more clever implementation than this ...
 280
 281         Sequence< OUString > aTranslatedNames( aPropertyNames );
 282         Sequence< Any >             aTranslatedValues( aValues );
 283
 284         sal_Int32 nParaAlignPos = findStringElement( aTranslatedNames, getParaAlignProperty() );
 285         if ( nParaAlignPos != -1 )
 286         {
 287             aTranslatedNames[ nParaAlignPos ] = getAlignProperty();
 288             valueParaAdjustToAlign( aTranslatedValues[ nParaAlignPos ] );
 289         }
 290
 291         m_xGridColumn->setPropertyValues( aTranslatedNames, aTranslatedValues );
 292     }
 293
 294     //--------------------------------------------------------------------
 295     Sequence< Any > SAL_CALL OGridColumnPropertyTranslator::getPropertyValues( const Sequence< OUString >& aPropertyNames ) throw (RuntimeException)
 296     {
 297         Sequence< Any > aValues( aPropertyNames.getLength() );
 298         if ( !m_xGridColumn.is() )
 299             return aValues;
 300
 301         Sequence< OUString > aTranslatedNames( aPropertyNames );
 302         sal_Int32 nAlignPos = findStringElement( aTranslatedNames, getParaAlignProperty() );
 303         if ( nAlignPos != -1 )
 304             aTranslatedNames[ nAlignPos ] = getAlignProperty();
 305
 306         aValues = m_xGridColumn->getPropertyValues( aPropertyNames );
 307         if ( nAlignPos != -1 )
 308             valueAlignToParaAdjust( aValues[ nAlignPos ] );
 309
 310         return aValues;
 311     }
 312
 313     //--------------------------------------------------------------------
 314     void SAL_CALL OGridColumnPropertyTranslator::addPropertiesChangeListener( const Sequence< OUString >&, const Reference< XPropertiesChangeListener >& ) throw (RuntimeException)
 315     {
 316         OSL_FAIL( "OGridColumnPropertyTranslator::addPropertiesChangeListener: not implemented - this should not be needed!" );
 317     }
 318
 319     //--------------------------------------------------------------------
 320     void SAL_CALL OGridColumnPropertyTranslator::removePropertiesChangeListener( const Reference< XPropertiesChangeListener >& ) throw (RuntimeException)
 321     {
 322         OSL_FAIL( "OGridColumnPropertyTranslator::removePropertiesChangeListener: not implemented - this should not be needed!" );
 323     }
 324
 325     //--------------------------------------------------------------------
 326     void SAL_CALL OGridColumnPropertyTranslator::firePropertiesChangeEvent( const Sequence< OUString >&, const Reference< XPropertiesChangeListener >& ) throw (RuntimeException)
 327     {
 328         OSL_FAIL( "OGridColumnPropertyTranslator::firePropertiesChangeEvent: not implemented - this should not be needed!" );
 329     }
 330
 331 //........................................................................
 332 } // namespace xmloff
 333 //........................................................................
 334
 335 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */