toolkit/source/controls/formattedcontrol.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: formattedcontrol.cxx,v $
  10  * $Revision: 1.14 $
  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_toolkit.hxx"
  33 #include <toolkit/controls/formattedcontrol.hxx>
  34 #include <toolkit/helper/unopropertyarrayhelper.hxx>
  35 #include <toolkit/helper/property.hxx>
  36
  37 #include <com/sun/star/awt/XVclWindowPeer.hpp>
  38 #include <com/sun/star/util/XNumberFormatsSupplier.hpp>
  39
  40 #include <tools/diagnose_ex.h>
  41 #include <comphelper/processfactory.hxx>
  42 #include <osl/diagnose.h>
  43
  44 //........................................................................
  45 namespace toolkit
  46 {
  47 //........................................................................
  48
  49     using namespace ::com::sun::star::uno;
  50     using namespace ::com::sun::star::awt;
  51     using namespace ::com::sun::star::lang;
  52     using namespace ::com::sun::star::beans;
  53     using namespace ::com::sun::star::util;
  54
  55     // -------------------------------------------------------------------
  56     namespace
  57     {
  58         // ...............................................................
  59         ::osl::Mutex& getDefaultFormatsMutex()
  60         {
  61             static ::osl::Mutex s_aDefaultFormatsMutex;
  62             return s_aDefaultFormatsMutex;
  63         }
  64
  65         // ...............................................................
  66         Reference< XNumberFormatsSupplier >& lcl_getDefaultFormatsAccess_nothrow()
  67         {
  68             static Reference< XNumberFormatsSupplier > s_xDefaultFormats;
  69             return s_xDefaultFormats;
  70         }
  71
  72         // ...............................................................
  73         bool& lcl_getTriedCreation()
  74         {
  75             static bool s_bTriedCreation = false;
  76             return s_bTriedCreation;
  77         }
  78
  79         // ...............................................................
  80         const Reference< XNumberFormatsSupplier >& lcl_getDefaultFormats_throw()
  81         {
  82             ::osl::MutexGuard aGuard( getDefaultFormatsMutex() );
  83
  84             bool& rbTriedCreation = lcl_getTriedCreation();
  85             Reference< XNumberFormatsSupplier >& rDefaultFormats( lcl_getDefaultFormatsAccess_nothrow() );
  86             if ( !rDefaultFormats.is() && !rbTriedCreation )
  87             {
  88                 rbTriedCreation = true;
  89                 rDefaultFormats = Reference< XNumberFormatsSupplier >(
  90                     ::comphelper::createProcessComponent(
  91                         ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.util.NumberFormatsSupplier" ) ) ),
  92                     UNO_QUERY_THROW
  93                 );
  94             }
  95             if ( !rDefaultFormats.is() )
  96                 throw RuntimeException();
  97
  98             return rDefaultFormats;
  99         }
 100
 101         // ...............................................................
 102         static oslInterlockedCount  s_refCount(0);
 103
 104         // ...............................................................
 105         void    lcl_registerDefaultFormatsClient()
 106         {
 107             osl_incrementInterlockedCount( &s_refCount );
 108         }
 109
 110         // ...............................................................
 111         void    lcl_revokeDefaultFormatsClient()
 112         {
 113             ::osl::ClearableMutexGuard aGuard( getDefaultFormatsMutex() );
 114             if ( 0 == osl_decrementInterlockedCount( &s_refCount ) )
 115             {
 116                 Reference< XNumberFormatsSupplier >& rDefaultFormats( lcl_getDefaultFormatsAccess_nothrow() );
 117                 Reference< XNumberFormatsSupplier > xReleasePotentialLastReference( rDefaultFormats );
 118                 rDefaultFormats.clear();
 119                 lcl_getTriedCreation() = false;
 120
 121                 aGuard.clear();
 122                 xReleasePotentialLastReference.clear();
 123             }
 124         }
 125     }
 126
 127     // ===================================================================
 128     // = UnoControlFormattedFieldModel
 129     // ===================================================================
 130     // -------------------------------------------------------------------
 131     UnoControlFormattedFieldModel::UnoControlFormattedFieldModel()
 132         :m_bRevokedAsClient( false )
 133         ,m_bSettingValueAndText( false )
 134     {
 135         ImplRegisterProperty( BASEPROPERTY_ALIGN );
 136         ImplRegisterProperty( BASEPROPERTY_BACKGROUNDCOLOR );
 137         ImplRegisterProperty( BASEPROPERTY_BORDER );
 138         ImplRegisterProperty( BASEPROPERTY_BORDERCOLOR );
 139         ImplRegisterProperty( BASEPROPERTY_DEFAULTCONTROL );
 140         ImplRegisterProperty( BASEPROPERTY_EFFECTIVE_DEFAULT );
 141         ImplRegisterProperty( BASEPROPERTY_EFFECTIVE_VALUE );
 142         ImplRegisterProperty( BASEPROPERTY_EFFECTIVE_MAX );
 143         ImplRegisterProperty( BASEPROPERTY_EFFECTIVE_MIN );
 144         ImplRegisterProperty( BASEPROPERTY_ENABLED );
 145         ImplRegisterProperty( BASEPROPERTY_ENABLEVISIBLE );
 146         ImplRegisterProperty( BASEPROPERTY_FONTDESCRIPTOR );
 147         ImplRegisterProperty( BASEPROPERTY_FORMATKEY );
 148         ImplRegisterProperty( BASEPROPERTY_FORMATSSUPPLIER );
 149         ImplRegisterProperty( BASEPROPERTY_HELPTEXT );
 150         ImplRegisterProperty( BASEPROPERTY_HELPURL );
 151         ImplRegisterProperty( BASEPROPERTY_MAXTEXTLEN );
 152         ImplRegisterProperty( BASEPROPERTY_PRINTABLE );
 153         ImplRegisterProperty( BASEPROPERTY_REPEAT );
 154         ImplRegisterProperty( BASEPROPERTY_REPEAT_DELAY );
 155         ImplRegisterProperty( BASEPROPERTY_READONLY );
 156         ImplRegisterProperty( BASEPROPERTY_SPIN );
 157         ImplRegisterProperty( BASEPROPERTY_STRICTFORMAT );
 158         ImplRegisterProperty( BASEPROPERTY_TABSTOP );
 159         ImplRegisterProperty( BASEPROPERTY_TEXT );
 160         ImplRegisterProperty( BASEPROPERTY_TEXTCOLOR );
 161         ImplRegisterProperty( BASEPROPERTY_HIDEINACTIVESELECTION );
 162         ImplRegisterProperty( BASEPROPERTY_ENFORCE_FORMAT );
 163         ImplRegisterProperty( BASEPROPERTY_WRITING_MODE );
 164         ImplRegisterProperty( BASEPROPERTY_CONTEXT_WRITING_MODE );
 165         ImplRegisterProperty( BASEPROPERTY_MOUSE_WHEEL_BEHAVIOUR );
 166
 167         Any aTreatAsNumber;
 168         aTreatAsNumber <<= (sal_Bool) sal_True;
 169         ImplRegisterProperty( BASEPROPERTY_TREATASNUMBER, aTreatAsNumber );
 170
 171         lcl_registerDefaultFormatsClient();
 172     }
 173
 174     // -------------------------------------------------------------------
 175     UnoControlFormattedFieldModel::~UnoControlFormattedFieldModel()
 176     {
 177     }
 178
 179     // -------------------------------------------------------------------
 180     ::rtl::OUString UnoControlFormattedFieldModel::getServiceName() throw(RuntimeException)
 181     {
 182         return ::rtl::OUString::createFromAscii( szServiceName_UnoControlFormattedFieldModel );
 183     }
 184
 185     // -------------------------------------------------------------------
 186     void SAL_CALL UnoControlFormattedFieldModel::setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const Any& rValue ) throw (Exception)
 187     {
 188         UnoControlModel::setFastPropertyValue_NoBroadcast( nHandle, rValue );
 189
 190         switch ( nHandle )
 191         {
 192         case BASEPROPERTY_EFFECTIVE_VALUE:
 193             if ( !m_bSettingValueAndText )
 194                 impl_updateTextFromValue_nothrow();
 195             break;
 196         case BASEPROPERTY_FORMATSSUPPLIER:
 197             impl_updateCachedFormatter_nothrow();
 198             impl_updateTextFromValue_nothrow();
 199             break;
 200         case BASEPROPERTY_FORMATKEY:
 201             impl_updateCachedFormatKey_nothrow();
 202             impl_updateTextFromValue_nothrow();
 203             break;
 204         }
 205     }
 206
 207     // -------------------------------------------------------------------
 208     void UnoControlFormattedFieldModel::impl_updateTextFromValue_nothrow()
 209     {
 210         if ( !m_xCachedFormatter.is() )
 211             impl_updateCachedFormatter_nothrow();
 212         if ( !m_xCachedFormatter.is() )
 213             return;
 214
 215         try
 216         {
 217             Any aEffectiveValue;
 218             getFastPropertyValue( aEffectiveValue, BASEPROPERTY_EFFECTIVE_VALUE );
 219
 220             ::rtl::OUString sStringValue;
 221             if ( !( aEffectiveValue >>= sStringValue ) )
 222             {
 223                 double nDoubleValue(0);
 224                 if ( aEffectiveValue >>= nDoubleValue )
 225                 {
 226                     sal_Int32 nFormatKey( 0 );
 227                     if ( m_aCachedFormat.hasValue() )
 228                         m_aCachedFormat >>= nFormatKey;
 229                     sStringValue = m_xCachedFormatter->convertNumberToString( nFormatKey, nDoubleValue );
 230                 }
 231             }
 232
 233             Reference< XPropertySet > xThis( *this, UNO_QUERY );
 234             xThis->setPropertyValue( GetPropertyName( BASEPROPERTY_TEXT ), makeAny( sStringValue ) );
 235         }
 236         catch( const Exception& )
 237         {
 238             DBG_UNHANDLED_EXCEPTION();
 239         }
 240     }
 241
 242     // -------------------------------------------------------------------
 243     void UnoControlFormattedFieldModel::impl_updateCachedFormatter_nothrow()
 244     {
 245         Any aFormatsSupplier;
 246         getFastPropertyValue( aFormatsSupplier, BASEPROPERTY_FORMATSSUPPLIER );
 247         try
 248         {
 249             Reference< XNumberFormatsSupplier > xSupplier( aFormatsSupplier, UNO_QUERY );
 250             if ( !xSupplier.is() )
 251                 xSupplier = lcl_getDefaultFormats_throw();
 252
 253             if ( !m_xCachedFormatter.is() )
 254             {
 255                 m_xCachedFormatter = Reference< XNumberFormatter >(
 256                     ::comphelper::createProcessComponent( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.util.NumberFormatter" ) ) ),
 257                     UNO_QUERY_THROW
 258                 );
 259             }
 260             m_xCachedFormatter->attachNumberFormatsSupplier( xSupplier );
 261         }
 262         catch( const Exception& )
 263         {
 264             DBG_UNHANDLED_EXCEPTION();
 265         }
 266     }
 267
 268     // -------------------------------------------------------------------
 269     void UnoControlFormattedFieldModel::impl_updateCachedFormatKey_nothrow()
 270     {
 271         Any aFormatKey;
 272         getFastPropertyValue( aFormatKey, BASEPROPERTY_FORMATKEY );
 273         m_aCachedFormat = aFormatKey;
 274     }
 275
 276     // -------------------------------------------------------------------
 277     void UnoControlFormattedFieldModel::dispose(  ) throw(RuntimeException)
 278     {
 279         UnoControlModel::dispose();
 280
 281         ::osl::MutexGuard aGuard( GetMutex() );
 282         if ( !m_bRevokedAsClient )
 283         {
 284             lcl_revokeDefaultFormatsClient();
 285             m_bRevokedAsClient = true;
 286         }
 287     }
 288
 289     // -------------------------------------------------------------------
 290     void UnoControlFormattedFieldModel::ImplNormalizePropertySequence( const sal_Int32 _nCount, sal_Int32* _pHandles,
 291         Any* _pValues, sal_Int32* _pValidHandles ) const SAL_THROW(())
 292     {
 293         ImplEnsureHandleOrder( _nCount, _pHandles, _pValues, BASEPROPERTY_EFFECTIVE_VALUE, BASEPROPERTY_TEXT );
 294
 295         UnoControlModel::ImplNormalizePropertySequence( _nCount, _pHandles, _pValues, _pValidHandles );
 296     }
 297
 298     // -------------------------------------------------------------------
 299     namespace
 300     {
 301         class ResetFlagOnExit
 302         {
 303         private:
 304             bool&   m_rFlag;
 305
 306         public:
 307             ResetFlagOnExit( bool& _rFlag )
 308                 :m_rFlag( _rFlag )
 309             {
 310             }
 311             ~ResetFlagOnExit()
 312             {
 313                 m_rFlag = false;
 314             }
 315         };
 316     }
 317
 318     // -------------------------------------------------------------------
 319     void SAL_CALL UnoControlFormattedFieldModel::setPropertyValues( const Sequence< ::rtl::OUString >& _rPropertyNames, const Sequence< Any >& _rValues ) throw(PropertyVetoException, IllegalArgumentException, WrappedTargetException, RuntimeException)
 320     {
 321         bool bSettingValue = false;
 322         bool bSettingText = false;
 323         for (   const ::rtl::OUString* pPropertyNames = _rPropertyNames.getConstArray();
 324                 pPropertyNames != _rPropertyNames.getConstArray() + _rPropertyNames.getLength();
 325                 ++pPropertyNames
 326             )
 327         {
 328             if ( BASEPROPERTY_EFFECTIVE_VALUE == GetPropertyId( *pPropertyNames ) )
 329                 bSettingValue = true;
 330
 331             if ( BASEPROPERTY_TEXT == GetPropertyId( *pPropertyNames ) )
 332                 bSettingText = true;
 333         }
 334
 335         m_bSettingValueAndText = ( bSettingValue && bSettingText );
 336         ResetFlagOnExit aResetFlag( m_bSettingValueAndText );
 337         UnoControlModel::setPropertyValues( _rPropertyNames, _rValues );
 338     }
 339
 340     // -------------------------------------------------------------------
 341     sal_Bool UnoControlFormattedFieldModel::convertFastPropertyValue(
 342                 Any& rConvertedValue, Any& rOldValue, sal_Int32 nPropId,
 343                 const Any& rValue ) throw (IllegalArgumentException)
 344     {
 345         if ( BASEPROPERTY_EFFECTIVE_DEFAULT == nPropId && rValue.hasValue() )
 346         {
 347             double dVal = 0;
 348             sal_Int32  nVal = 0;
 349             ::rtl::OUString sVal;
 350             sal_Bool bStreamed = (rValue >>= dVal);
 351             if ( bStreamed )
 352             {
 353                 rConvertedValue <<= dVal;
 354             }
 355             else
 356             {
 357                 bStreamed = (rValue >>= nVal);
 358                 if ( bStreamed )
 359                 {
 360                     rConvertedValue <<= static_cast<double>(nVal);
 361                 }
 362                 else
 363                 {
 364                     bStreamed = (rValue >>= sVal);
 365                     if ( bStreamed )
 366                     {
 367                         rConvertedValue <<= sVal;
 368                     }
 369                 }
 370             }
 371
 372             if ( bStreamed )
 373             {
 374                 getFastPropertyValue( rOldValue, nPropId );
 375                 return !CompareProperties( rConvertedValue, rOldValue );
 376             }
 377
 378             throw IllegalArgumentException(
 379                         ( ::rtl::OUString::createFromAscii("Unable to convert the given value for the property ")
 380                     +=  GetPropertyName((sal_uInt16)nPropId) )
 381                     +=  ::rtl::OUString::createFromAscii(" (double, integer, or string expected)."),
 382                 static_cast< XPropertySet* >(this),
 383                 1);
 384         }
 385
 386         return UnoControlModel::convertFastPropertyValue( rConvertedValue, rOldValue, nPropId, rValue );
 387     }
 388
 389     // -------------------------------------------------------------------
 390     Any UnoControlFormattedFieldModel::ImplGetDefaultValue( sal_uInt16 nPropId ) const
 391     {
 392         Any aReturn;
 393         switch (nPropId)
 394         {
 395             case BASEPROPERTY_DEFAULTCONTROL: aReturn <<= ::rtl::OUString( ::rtl::OUString::createFromAscii( szServiceName_UnoControlFormattedField ) ); break;
 396
 397             case BASEPROPERTY_TREATASNUMBER: aReturn <<= (sal_Bool)sal_True; break;
 398
 399             case BASEPROPERTY_EFFECTIVE_DEFAULT:
 400             case BASEPROPERTY_EFFECTIVE_VALUE:
 401             case BASEPROPERTY_EFFECTIVE_MAX:
 402             case BASEPROPERTY_EFFECTIVE_MIN:
 403             case BASEPROPERTY_FORMATKEY:
 404             case BASEPROPERTY_FORMATSSUPPLIER:
 405                 // (void)
 406                 break;
 407
 408             default : aReturn = UnoControlModel::ImplGetDefaultValue( nPropId ); break;
 409         }
 410
 411         return aReturn;
 412     }
 413
 414     // -------------------------------------------------------------------
 415     ::cppu::IPropertyArrayHelper& UnoControlFormattedFieldModel::getInfoHelper()
 416     {
 417         static UnoPropertyArrayHelper* pHelper = NULL;
 418         if ( !pHelper )
 419         {
 420             Sequence<sal_Int32> aIDs = ImplGetPropertyIds();
 421             pHelper = new UnoPropertyArrayHelper( aIDs );
 422         }
 423         return *pHelper;
 424     }
 425
 426     // beans::XMultiPropertySet
 427     // -------------------------------------------------------------------
 428     Reference< XPropertySetInfo > UnoControlFormattedFieldModel::getPropertySetInfo(  ) throw(RuntimeException)
 429     {
 430         static Reference< XPropertySetInfo > xInfo( createPropertySetInfo( getInfoHelper() ) );
 431         return xInfo;
 432     }
 433
 434     // ===================================================================
 435     // = UnoFormattedFieldControl
 436     // ===================================================================
 437     // -------------------------------------------------------------------
 438     UnoFormattedFieldControl::UnoFormattedFieldControl()
 439     {
 440     }
 441
 442     // -------------------------------------------------------------------
 443     ::rtl::OUString UnoFormattedFieldControl::GetComponentServiceName()
 444     {
 445         return ::rtl::OUString::createFromAscii( "FormattedField" );
 446     }
 447
 448     // -------------------------------------------------------------------
 449     void UnoFormattedFieldControl::textChanged(const TextEvent& e) throw(RuntimeException)
 450     {
 451         Reference< XVclWindowPeer >  xPeer(getPeer(), UNO_QUERY);
 452         OSL_ENSURE(xPeer.is(), "UnoFormattedFieldControl::textChanged : what kind of peer do I have ?");
 453
 454         Sequence< ::rtl::OUString > aNames( 2 );
 455         aNames[0] = GetPropertyName( BASEPROPERTY_EFFECTIVE_VALUE );
 456         aNames[1] = GetPropertyName( BASEPROPERTY_TEXT );
 457
 458         Sequence< Any > aValues( 2 );
 459         aValues[0] = xPeer->getProperty( aNames[0] );
 460         aValues[1] = xPeer->getProperty( aNames[1] );
 461
 462         ImplSetPropertyValues( aNames, aValues, FALSE );
 463
 464         if ( GetTextListeners().getLength() )
 465             GetTextListeners().textChanged( e );
 466     }
 467
 468 //........................................................................
 469 }       // namespace toolkit
 470 //........................................................................