framework/source/fwe/classes/actiontriggerpropertyset.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 <classes/actiontriggerpropertyset.hxx>
  21 #include <com/sun/star/beans/PropertyAttribute.hpp>
  22 #include <cppuhelper/proptypehlp.hxx>
  23 #include <cppuhelper/queryinterface.hxx>
  24 #include <cppuhelper/supportsservice.hxx>
  25 #include <cppuhelper/typeprovider.hxx>
  26 #include <vcl/svapp.hxx>
  27
  28 using namespace cppu;
  29 using namespace com::sun::star::uno;
  30 using namespace com::sun::star::beans;
  31 using namespace com::sun::star::lang;
  32 using namespace com::sun::star::awt;
  33
  34 //struct SAL_DLLPUBLIC_IMPORT ::cppu::OBroadcastHelperVar< OMultiTypeInterfaceContainerHelper, OMultiTypeInterfaceContainerHelper::keyType >;
  35
  36 namespace {
  37
  38 // Handles for properties
  39 // (PLEASE SORT THIS FIELD, IF YOU ADD NEW PROPERTIES!)
  40 // We use an enum to define these handles, to use all numbers from 0 to nn and
  41 // if you add someone, you don't must control this!
  42 // But don't forget to change values of follow defines, if you do something with this enum!
  43 enum EPROPERTIES
  44 {
  45     HANDLE_COMMANDURL,
  46     HANDLE_HELPURL,
  47     HANDLE_IMAGE,
  48     HANDLE_SUBCONTAINER,
  49     HANDLE_TEXT,
  50     PROPERTYCOUNT
  51 };
  52
  53 }
  54
  55 namespace framework
  56 {
  57
  58 ActionTriggerPropertySet::ActionTriggerPropertySet()
  59     : OBroadcastHelper         ( m_aMutex )
  60     , OPropertySetHelper       ( *static_cast< OBroadcastHelper * >(this) )
  61 {
  62 }
  63
  64 ActionTriggerPropertySet::~ActionTriggerPropertySet()
  65 {
  66 }
  67
  68 // XInterface
  69 Any SAL_CALL ActionTriggerPropertySet::queryInterface( const Type& aType )
  70 {
  71     Any a = ::cppu::queryInterface(
  72                 aType,
  73                 static_cast< XServiceInfo* >(this),
  74                 static_cast< XTypeProvider* >(this));
  75
  76     if( a.hasValue() )
  77         return a;
  78     else
  79     {
  80         a = OPropertySetHelper::queryInterface( aType );
  81
  82         if( a.hasValue() )
  83             return a;
  84     }
  85
  86     return OWeakObject::queryInterface( aType );
  87 }
  88
  89 void SAL_CALL ActionTriggerPropertySet::acquire() noexcept
  90 {
  91     OWeakObject::acquire();
  92 }
  93
  94 void SAL_CALL ActionTriggerPropertySet::release() noexcept
  95 {
  96     OWeakObject::release();
  97 }
  98
  99 // XServiceInfo
 100 OUString SAL_CALL ActionTriggerPropertySet::getImplementationName()
 101 {
 102     return IMPLEMENTATIONNAME_ACTIONTRIGGER;
 103 }
 104
 105 sal_Bool SAL_CALL ActionTriggerPropertySet::supportsService( const OUString& ServiceName )
 106 {
 107     return cppu::supportsService(this, ServiceName);
 108 }
 109
 110 Sequence< OUString > SAL_CALL ActionTriggerPropertySet::getSupportedServiceNames()
 111 {
 112     Sequence<OUString> seqServiceNames { SERVICENAME_ACTIONTRIGGER };
 113     return seqServiceNames;
 114 }
 115
 116 // XTypeProvider
 117 Sequence< Type > SAL_CALL ActionTriggerPropertySet::getTypes()
 118 {
 119     // Create a static typecollection ...
 120     static ::cppu::OTypeCollection ourTypeCollection(
 121                         cppu::UnoType<XPropertySet>::get(),
 122                         cppu::UnoType<XFastPropertySet>::get(),
 123                         cppu::UnoType<XMultiPropertySet>::get(),
 124                         cppu::UnoType<XServiceInfo>::get(),
 125                         cppu::UnoType<XTypeProvider>::get());
 126
 127
 128     return ourTypeCollection.getTypes();
 129 }
 130
 131 Sequence< sal_Int8 > SAL_CALL ActionTriggerPropertySet::getImplementationId()
 132 {
 133     return css::uno::Sequence<sal_Int8>();
 134 }
 135
 136 sal_Bool SAL_CALL ActionTriggerPropertySet::convertFastPropertyValue(
 137     Any&        aConvertedValue,
 138     Any&        aOldValue,
 139     sal_Int32   nHandle,
 140     const Any&  aValue  )
 141 {
 142     //  Check, if value of property will changed in method "setFastPropertyValue_NoBroadcast()".
 143     //  Return sal_True, if changed - else return sal_False.
 144     //  Attention: Method "impl_tryToChangeProperty()" can throw the IllegalArgumentException !!!
 145     //  Initialize return value with sal_False !!!
 146     //  (Handle can be invalid)
 147     bool bReturn = false;
 148
 149     switch( nHandle )
 150     {
 151         case HANDLE_COMMANDURL:
 152             bReturn = impl_tryToChangeProperty( m_aCommandURL, aValue, aOldValue, aConvertedValue );
 153             break;
 154
 155         case HANDLE_HELPURL:
 156             bReturn = impl_tryToChangeProperty( m_aHelpURL, aValue, aOldValue, aConvertedValue );
 157             break;
 158
 159         case HANDLE_IMAGE:
 160             bReturn = impl_tryToChangeProperty( m_xBitmap, aValue, aOldValue, aConvertedValue );
 161             break;
 162
 163         case HANDLE_SUBCONTAINER:
 164             bReturn = impl_tryToChangeProperty( m_xActionTriggerContainer, aValue, aOldValue, aConvertedValue );
 165             break;
 166
 167         case HANDLE_TEXT:
 168             bReturn = impl_tryToChangeProperty( m_aText, aValue, aOldValue, aConvertedValue );
 169             break;
 170     }
 171
 172     // Return state of operation.
 173     return bReturn;
 174 }
 175
 176 void SAL_CALL ActionTriggerPropertySet::setFastPropertyValue_NoBroadcast(
 177     sal_Int32 nHandle, const Any& aValue )
 178 {
 179     SolarMutexGuard aGuard;
 180
 181     // Search for right handle ... and try to set property value.
 182     switch( nHandle )
 183     {
 184         case HANDLE_COMMANDURL:
 185             aValue >>= m_aCommandURL;
 186             break;
 187
 188         case HANDLE_HELPURL:
 189             aValue >>= m_aHelpURL;
 190             break;
 191
 192         case HANDLE_IMAGE:
 193             aValue >>= m_xBitmap;
 194             break;
 195
 196         case HANDLE_SUBCONTAINER:
 197             aValue >>= m_xActionTriggerContainer;
 198             break;
 199
 200         case HANDLE_TEXT:
 201             aValue >>= m_aText;
 202             break;
 203     }
 204 }
 205
 206 void SAL_CALL ActionTriggerPropertySet::getFastPropertyValue(
 207     Any& aValue, sal_Int32 nHandle ) const
 208 {
 209     SolarMutexGuard aGuard;
 210
 211     // Search for right handle ... and try to get property value.
 212     switch( nHandle )
 213     {
 214         case HANDLE_COMMANDURL:
 215             aValue <<= m_aCommandURL;
 216             break;
 217
 218         case HANDLE_HELPURL:
 219             aValue <<= m_aHelpURL;
 220             break;
 221
 222         case HANDLE_IMAGE:
 223             aValue <<= m_xBitmap;
 224             break;
 225
 226         case HANDLE_SUBCONTAINER:
 227             aValue <<= m_xActionTriggerContainer;
 228             break;
 229
 230         case HANDLE_TEXT:
 231             aValue <<= m_aText;
 232             break;
 233     }
 234 }
 235
 236 ::cppu::IPropertyArrayHelper& SAL_CALL ActionTriggerPropertySet::getInfoHelper()
 237 {
 238     // Define static member to give structure of properties to baseclass "OPropertySetHelper".
 239     // "impl_getStaticPropertyDescriptor" is a non exported and static function, who will define a static propertytable.
 240     // "true" say: Table is sorted by name.
 241     static OPropertyArrayHelper ourInfoHelper( impl_getStaticPropertyDescriptor(), true );
 242
 243     return ourInfoHelper;
 244 }
 245
 246 Reference< XPropertySetInfo > SAL_CALL ActionTriggerPropertySet::getPropertySetInfo()
 247 {
 248     // Create structure of propertysetinfo for baseclass "OPropertySetHelper".
 249     // (Use method "getInfoHelper()".)
 250     static Reference< XPropertySetInfo > xInfo( createPropertySetInfo( getInfoHelper() ) );
 251
 252     return xInfo;
 253 }
 254
 255 Sequence< Property > ActionTriggerPropertySet::impl_getStaticPropertyDescriptor()
 256 {
 257     return
 258     {
 259         Property( u"CommandURL"_ustr   , HANDLE_COMMANDURL   , cppu::UnoType<OUString>::get(), PropertyAttribute::TRANSIENT  ),
 260         Property( u"HelpURL"_ustr      , HANDLE_HELPURL      , cppu::UnoType<OUString>::get(), PropertyAttribute::TRANSIENT  ),
 261         Property( u"Image"_ustr        , HANDLE_IMAGE        , cppu::UnoType<XBitmap>::get(), PropertyAttribute::TRANSIENT  ),
 262         Property( u"SubContainer"_ustr , HANDLE_SUBCONTAINER , cppu::UnoType<OUString>::get(), PropertyAttribute::TRANSIENT  ),
 263         Property( u"Text"_ustr         , HANDLE_TEXT         , cppu::UnoType<XInterface>::get(), PropertyAttribute::TRANSIENT  )
 264     };
 265 }
 266
 267 // static
 268 bool ActionTriggerPropertySet::impl_tryToChangeProperty(
 269     const   OUString&    sCurrentValue   ,
 270     const   Any&        aNewValue       ,
 271     Any&        aOldValue       ,
 272     Any&        aConvertedValue )
 273 {
 274     // Set default return value if method failed.
 275     bool bReturn = false;
 276     // Get new value from any.
 277     // IllegalArgumentException() can be thrown!
 278     OUString sValue;
 279     convertPropertyValue( sValue, aNewValue );
 280
 281     // If value change ...
 282     if( sValue != sCurrentValue )
 283     {
 284         // ... set information of change.
 285         aOldValue       <<= sCurrentValue;
 286         aConvertedValue <<= sValue;
 287         // Return OK - "value will be change ..."
 288         bReturn = true;
 289     }
 290     else
 291     {
 292         // ... clear information of return parameter!
 293         aOldValue.clear         ();
 294         aConvertedValue.clear   ();
 295         // Return NOTHING - "value will not be change ..."
 296         bReturn = false;
 297     }
 298
 299     return bReturn;
 300 }
 301
 302 // static
 303 bool ActionTriggerPropertySet::impl_tryToChangeProperty(
 304     const Reference< XBitmap >&  aCurrentValue   ,
 305     const Any&                  aNewValue       ,
 306     Any&                        aOldValue       ,
 307     Any&                        aConvertedValue )
 308 {
 309     // Set default return value if method failed.
 310     bool bReturn = false;
 311     // Get new value from any.
 312     // IllegalArgumentException() can be thrown!
 313     Reference< XBitmap > aValue;
 314     convertPropertyValue( aValue, aNewValue );
 315
 316     // If value change ...
 317     if( aValue != aCurrentValue )
 318     {
 319         // ... set information of change.
 320         aOldValue       <<= aCurrentValue;
 321         aConvertedValue <<= aValue;
 322         // Return OK - "value will be change ..."
 323         bReturn = true;
 324     }
 325     else
 326     {
 327         // ... clear information of return parameter!
 328         aOldValue.clear         ();
 329         aConvertedValue.clear   ();
 330         // Return NOTHING - "value will not be change ..."
 331         bReturn = false;
 332     }
 333
 334     return bReturn;
 335 }
 336
 337 // static
 338 bool ActionTriggerPropertySet::impl_tryToChangeProperty(
 339     const Reference< XInterface >&   aCurrentValue   ,
 340     const Any&                      aNewValue       ,
 341     Any&                            aOldValue       ,
 342     Any&                            aConvertedValue )
 343 {
 344     // Set default return value if method failed.
 345     bool bReturn = false;
 346     // Get new value from any.
 347     // IllegalArgumentException() can be thrown!
 348     Reference< XInterface > aValue;
 349     convertPropertyValue( aValue, aNewValue );
 350
 351     // If value change ...
 352     if( aValue != aCurrentValue )
 353     {
 354         // ... set information of change.
 355         aOldValue       <<= aCurrentValue;
 356         aConvertedValue <<= aValue;
 357         // Return OK - "value will be change ..."
 358         bReturn = true;
 359     }
 360     else
 361     {
 362         // ... clear information of return parameter!
 363         aOldValue.clear         ();
 364         aConvertedValue.clear   ();
 365         // Return NOTHING - "value will not be change ..."
 366         bReturn = false;
 367     }
 368
 369     return bReturn;
 370 }
 371
 372 }
 373
 374 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */