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