framework/source/classes/actiontriggerseparatorpropertyset.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: actiontriggerseparatorpropertyset.cxx,v $
  10  * $Revision: 1.6 $
  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_framework.hxx"
  33
  34 #include <classes/actiontriggerseparatorpropertyset.hxx>
  35 #include <com/sun/star/beans/PropertyAttribute.hpp>
  36 #include <cppuhelper/proptypehlp.hxx>
  37 #include <cppuhelper/typeprovider.hxx>
  38 #include <vcl/svapp.hxx>
  39
  40
  41 using namespace cppu;
  42 using namespace com::sun::star::uno;
  43 using namespace com::sun::star::beans;
  44 using namespace com::sun::star::lang;
  45 using namespace com::sun::star::awt;
  46
  47 // Handles for properties
  48 // (PLEASE SORT THIS FIELD, IF YOU ADD NEW PROPERTIES!)
  49 // We use an enum to define these handles, to use all numbers from 0 to nn and
  50 // if you add someone, you don't must control this!
  51 // But don't forget to change values of follow defines, if you do something with this enum!
  52 enum EPROPERTIES
  53 {
  54     HANDLE_TYPE,
  55     PROPERTYCOUNT
  56 };
  57
  58 namespace framework
  59 {
  60
  61 ActionTriggerSeparatorPropertySet::ActionTriggerSeparatorPropertySet( const Reference< XMultiServiceFactory >& /*ServiceManager*/ )
  62         :   ThreadHelpBase          ( &Application::GetSolarMutex()                     )
  63         ,   OBroadcastHelper        ( m_aLock.getShareableOslMutex()                    )
  64         ,       OPropertySetHelper              ( *SAL_STATIC_CAST( OBroadcastHelper *, this )          )
  65         ,       OWeakObject                             (                                                                                                       )
  66         ,       m_nSeparatorType( 0 )
  67 {
  68 }
  69
  70 ActionTriggerSeparatorPropertySet::~ActionTriggerSeparatorPropertySet()
  71 {
  72 }
  73
  74 // XInterface
  75 Any SAL_CALL ActionTriggerSeparatorPropertySet::queryInterface( const Type& aType )
  76 throw ( RuntimeException )
  77 {
  78     Any a = ::cppu::queryInterface(
  79                 aType ,
  80                 SAL_STATIC_CAST( XServiceInfo*, this ));
  81
  82     if( a.hasValue() )
  83         return a;
  84     else
  85     {
  86         a = OPropertySetHelper::queryInterface( aType );
  87
  88         if( a.hasValue() )
  89             return a;
  90     }
  91
  92     return OWeakObject::queryInterface( aType );
  93 }
  94
  95 void ActionTriggerSeparatorPropertySet::acquire() throw()
  96 {
  97     OWeakObject::acquire();
  98 }
  99
 100 void ActionTriggerSeparatorPropertySet::release() throw()
 101 {
 102     OWeakObject::release();
 103 }
 104
 105 // XServiceInfo
 106 ::rtl::OUString SAL_CALL ActionTriggerSeparatorPropertySet::getImplementationName()
 107 throw ( RuntimeException )
 108 {
 109     return ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( IMPLEMENTATIONNAME_ACTIONTRIGGERSEPARATOR ));
 110 }
 111
 112 sal_Bool SAL_CALL ActionTriggerSeparatorPropertySet::supportsService( const ::rtl::OUString& ServiceName )
 113 throw ( RuntimeException )
 114 {
 115     if ( ServiceName.equalsAscii( SERVICENAME_ACTIONTRIGGERSEPARATOR ))
 116         return sal_True;
 117
 118     return sal_False;
 119 }
 120
 121 Sequence< ::rtl::OUString > SAL_CALL ActionTriggerSeparatorPropertySet::getSupportedServiceNames()
 122 throw ( RuntimeException )
 123 {
 124     Sequence< ::rtl::OUString > seqServiceNames( 1 );
 125     seqServiceNames[0] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( SERVICENAME_ACTIONTRIGGERSEPARATOR ));
 126     return seqServiceNames;
 127 }
 128
 129 // XTypeProvider
 130 Sequence< Type > SAL_CALL ActionTriggerSeparatorPropertySet::getTypes() throw ( RuntimeException )
 131 {
 132     // Optimize this method !
 133     // We initialize a static variable only one time. And we don't must use a mutex at every call!
 134     // For the first call; pTypeCollection is NULL - for the second call pTypeCollection is different from NULL!
 135     static ::cppu::OTypeCollection* pTypeCollection = NULL ;
 136
 137     if ( pTypeCollection == NULL )
 138     {
 139         // Ready for multithreading; get global mutex for first call of this method only! see before
 140         osl::MutexGuard aGuard( osl::Mutex::getGlobalMutex() ) ;
 141
 142         // Control these pointer again ... it can be, that another instance will be faster then these!
 143         if ( pTypeCollection == NULL )
 144         {
 145             // Create a static typecollection ...
 146             static ::cppu::OTypeCollection aTypeCollection(
 147                         ::getCppuType(( const Reference< XPropertySet                   >*)NULL ) ,
 148                         ::getCppuType(( const Reference< XFastPropertySet               >*)NULL ) ,
 149                         ::getCppuType(( const Reference< XMultiPropertySet              >*)NULL ) ,
 150                         ::getCppuType(( const Reference< XServiceInfo                   >*)NULL ) ,
 151                         ::getCppuType(( const Reference< XTypeProvider                  >*)NULL ) ) ;
 152
 153             // ... and set his address to static pointer!
 154             pTypeCollection = &aTypeCollection ;
 155         }
 156     }
 157
 158     return pTypeCollection->getTypes() ;
 159 }
 160
 161 Sequence< sal_Int8 > SAL_CALL ActionTriggerSeparatorPropertySet::getImplementationId() throw ( RuntimeException )
 162 {
 163     // Create one Id for all instances of this class.
 164     // Use ethernet address to do this! (sal_True)
 165
 166     // Optimize this method
 167     // We initialize a static variable only one time. And we don't must use a mutex at every call!
 168     // For the first call; pID is NULL - for the second call pID is different from NULL!
 169     static ::cppu::OImplementationId* pID = NULL ;
 170
 171     if ( pID == NULL )
 172     {
 173         // Ready for multithreading; get global mutex for first call of this method only! see before
 174         osl::MutexGuard aGuard( osl::Mutex::getGlobalMutex() ) ;
 175
 176         // Control these pointer again ... it can be, that another instance will be faster then these!
 177         if ( pID == NULL )
 178         {
 179             // Create a new static ID ...
 180             static ::cppu::OImplementationId aID( sal_False ) ;
 181             // ... and set his address to static pointer!
 182             pID = &aID ;
 183         }
 184     }
 185
 186     return pID->getImplementationId() ;
 187 }
 188
 189 //---------------------------------------------------------------------------------------------------------
 190 //      OPropertySetHelper implementation
 191 //---------------------------------------------------------------------------------------------------------
 192
 193 sal_Bool SAL_CALL ActionTriggerSeparatorPropertySet::convertFastPropertyValue(
 194     Any&                aConvertedValue,
 195     Any&                aOldValue,
 196     sal_Int32   nHandle,
 197     const Any&  aValue  )
 198 throw( IllegalArgumentException )
 199 {
 200     //  Check, if value of property will changed in method "setFastPropertyValue_NoBroadcast()".
 201     //  Return TRUE, if changed - else return FALSE.
 202     //  Attention: Method "impl_tryToChangeProperty()" can throw the IllegalArgumentException !!!
 203     //  Initialize return value with FALSE !!!
 204     //  (Handle can be invalid)
 205     sal_Bool bReturn = sal_False;
 206
 207     switch( nHandle )
 208     {
 209         case HANDLE_TYPE:
 210             bReturn = impl_tryToChangeProperty( m_nSeparatorType, aValue, aOldValue, aConvertedValue );
 211             break;
 212     }
 213
 214     // Return state of operation.
 215     return bReturn;
 216 }
 217
 218
 219 void SAL_CALL ActionTriggerSeparatorPropertySet::setFastPropertyValue_NoBroadcast(
 220     sal_Int32 nHandle, const Any& aValue )
 221 throw( Exception )
 222 {
 223     ::osl::MutexGuard aGuard( LockHelper::getGlobalLock().getShareableOslMutex() );
 224
 225     // Search for right handle ... and try to set property value.
 226     switch( nHandle )
 227     {
 228         case HANDLE_TYPE:
 229             aValue >>= m_nSeparatorType;
 230             break;
 231     }
 232 }
 233
 234 void SAL_CALL ActionTriggerSeparatorPropertySet::getFastPropertyValue(
 235     Any& aValue, sal_Int32 nHandle ) const
 236 {
 237     ::osl::MutexGuard aGuard( LockHelper::getGlobalLock().getShareableOslMutex() );
 238
 239     // Search for right handle ... and try to get property value.
 240     switch( nHandle )
 241     {
 242         case HANDLE_TYPE:
 243             aValue <<= m_nSeparatorType;
 244             break;
 245     }
 246 }
 247
 248 ::cppu::IPropertyArrayHelper& SAL_CALL ActionTriggerSeparatorPropertySet::getInfoHelper()
 249 {
 250     // Optimize this method !
 251     // We initialize a static variable only one time. And we don't must use a mutex at every call!
 252     // For the first call; pInfoHelper is NULL - for the second call pInfoHelper is different from NULL!
 253     static OPropertyArrayHelper* pInfoHelper = NULL;
 254
 255     if( pInfoHelper == NULL )
 256     {
 257         // Ready for multithreading
 258         ::osl::MutexGuard aGuard( LockHelper::getGlobalLock().getShareableOslMutex() );
 259         // Control this pointer again, another instance can be faster then these!
 260         if( pInfoHelper == NULL )
 261         {
 262             // Define static member to give structure of properties to baseclass "OPropertySetHelper".
 263             // "impl_getStaticPropertyDescriptor" is a non exported and static funtion, who will define a static propertytable.
 264             // "sal_True" say: Table is sorted by name.
 265             static OPropertyArrayHelper aInfoHelper( impl_getStaticPropertyDescriptor(), sal_True );
 266             pInfoHelper = &aInfoHelper;
 267         }
 268     }
 269
 270     return (*pInfoHelper);
 271 }
 272
 273 Reference< XPropertySetInfo > SAL_CALL ActionTriggerSeparatorPropertySet::getPropertySetInfo()
 274 throw ( RuntimeException )
 275 {
 276     // Optimize this method !
 277     // We initialize a static variable only one time. And we don't must use a mutex at every call!
 278     // For the first call; pInfo is NULL - for the second call pInfo is different from NULL!
 279     static Reference< XPropertySetInfo >* pInfo = NULL ;
 280
 281     if( pInfo == NULL )
 282     {
 283         // Ready for multithreading
 284         ::osl::MutexGuard aGuard( LockHelper::getGlobalLock().getShareableOslMutex() );
 285         // Control this pointer again, another instance can be faster then these!
 286         if( pInfo == NULL )
 287         {
 288             // Create structure of propertysetinfo for baseclass "OPropertySetHelper".
 289             // (Use method "getInfoHelper()".)
 290             static Reference< XPropertySetInfo > xInfo( createPropertySetInfo( getInfoHelper() ) );
 291             pInfo = &xInfo;
 292         }
 293     }
 294
 295     return (*pInfo);
 296 }
 297
 298 const Sequence< Property > ActionTriggerSeparatorPropertySet::impl_getStaticPropertyDescriptor()
 299 {
 300     static const Property pActionTriggerPropertys[] =
 301     {
 302         Property( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "SeparatorType" )), HANDLE_TYPE, ::getCppuType((sal_Int16*)0), PropertyAttribute::TRANSIENT )
 303     };
 304
 305     // Use it to initialize sequence!
 306     static const Sequence< Property > seqActionTriggerPropertyDescriptor( pActionTriggerPropertys, PROPERTYCOUNT );
 307
 308     // Return static "PropertyDescriptor"
 309     return seqActionTriggerPropertyDescriptor ;
 310 }
 311
 312
 313 //******************************************************************************************************************************
 314 //      private method
 315 //******************************************************************************************************************************
 316 sal_Bool ActionTriggerSeparatorPropertySet::impl_tryToChangeProperty(
 317     sal_Int16                   aCurrentValue   ,
 318     const       Any&            aNewValue               ,
 319     Any&                                aOldValue               ,
 320     Any&                                aConvertedValue )
 321 throw( IllegalArgumentException )
 322 {
 323     // Set default return value if method failed.
 324     sal_Bool bReturn = sal_False;
 325     // Get new value from any.
 326     // IllegalArgumentException() can be thrown!
 327     sal_Int16 aValue = 0;
 328     convertPropertyValue( aValue, aNewValue );
 329
 330     // If value change ...
 331     if( aValue != aCurrentValue )
 332     {
 333         // ... set information of change.
 334         aOldValue               <<= aCurrentValue       ;
 335         aConvertedValue <<= aValue                      ;
 336         // Return OK - "value will be change ..."
 337         bReturn = sal_True;
 338     }
 339     else
 340     {
 341         // ... clear information of return parameter!
 342         aOldValue.clear                 () ;
 343         aConvertedValue.clear   () ;
 344         // Return NOTHING - "value will not be change ..."
 345         bReturn = sal_False;
 346     }
 347
 348     return bReturn;
 349 }
 350
 351 }
 352