framework/source/fwe/classes/actiontriggerseparatorpropertyset.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/actiontriggerseparatorpropertyset.hxx>
  21 #include <com/sun/star/beans/PropertyAttribute.hpp>
  22 #include <cppuhelper/proptypehlp.hxx>
  23 #include <cppuhelper/supportsservice.hxx>
  24 #include <cppuhelper/queryinterface.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 namespace {
  35
  36 // Handles for properties
  37 // (PLEASE SORT THIS FIELD, IF YOU ADD NEW PROPERTIES!)
  38 // We use an enum to define these handles, to use all numbers from 0 to nn and
  39 // if you add someone, you don't must control this!
  40 // But don't forget to change values of follow defines, if you do something with this enum!
  41 enum EPROPERTIES
  42 {
  43     HANDLE_TYPE,
  44     PROPERTYCOUNT
  45 };
  46
  47 }
  48
  49 namespace framework
  50 {
  51
  52 ActionTriggerSeparatorPropertySet::ActionTriggerSeparatorPropertySet()
  53         :   OBroadcastHelper        ( m_aMutex )
  54         ,   OPropertySetHelper      ( *static_cast< OBroadcastHelper * >(this) )
  55         ,   m_nSeparatorType( 0 )
  56 {
  57 }
  58
  59 ActionTriggerSeparatorPropertySet::~ActionTriggerSeparatorPropertySet()
  60 {
  61 }
  62
  63 // XInterface
  64 Any SAL_CALL ActionTriggerSeparatorPropertySet::queryInterface( const Type& aType )
  65 {
  66     Any a = ::cppu::queryInterface(
  67                 aType,
  68                 static_cast< XServiceInfo* >(this),
  69                 static_cast< XTypeProvider* >(this));
  70
  71     if( a.hasValue() )
  72         return a;
  73     else
  74     {
  75         a = OPropertySetHelper::queryInterface( aType );
  76
  77         if( a.hasValue() )
  78             return a;
  79     }
  80
  81     return OWeakObject::queryInterface( aType );
  82 }
  83
  84 void ActionTriggerSeparatorPropertySet::acquire() noexcept
  85 {
  86     OWeakObject::acquire();
  87 }
  88
  89 void ActionTriggerSeparatorPropertySet::release() noexcept
  90 {
  91     OWeakObject::release();
  92 }
  93
  94 // XServiceInfo
  95 OUString SAL_CALL ActionTriggerSeparatorPropertySet::getImplementationName()
  96 {
  97     return IMPLEMENTATIONNAME_ACTIONTRIGGERSEPARATOR;
  98 }
  99
 100 sal_Bool SAL_CALL ActionTriggerSeparatorPropertySet::supportsService( const OUString& ServiceName )
 101 {
 102     return cppu::supportsService(this, ServiceName);
 103 }
 104
 105 Sequence< OUString > SAL_CALL ActionTriggerSeparatorPropertySet::getSupportedServiceNames()
 106 {
 107     Sequence<OUString> seqServiceNames { SERVICENAME_ACTIONTRIGGERSEPARATOR };
 108     return seqServiceNames;
 109 }
 110
 111 // XTypeProvider
 112 Sequence< Type > SAL_CALL ActionTriggerSeparatorPropertySet::getTypes()
 113 {
 114     // Create a static typecollection ...
 115     static ::cppu::OTypeCollection ourTypeCollection(
 116                         cppu::UnoType<XPropertySet>::get(),
 117                         cppu::UnoType<XFastPropertySet>::get(),
 118                         cppu::UnoType<XMultiPropertySet>::get(),
 119                         cppu::UnoType<XServiceInfo>::get(),
 120                         cppu::UnoType<XTypeProvider>::get());
 121
 122     return ourTypeCollection.getTypes();
 123 }
 124
 125 Sequence< sal_Int8 > SAL_CALL ActionTriggerSeparatorPropertySet::getImplementationId()
 126 {
 127     return css::uno::Sequence<sal_Int8>();
 128 }
 129
 130 sal_Bool SAL_CALL ActionTriggerSeparatorPropertySet::convertFastPropertyValue(
 131     Any&        aConvertedValue,
 132     Any&        aOldValue,
 133     sal_Int32   nHandle,
 134     const Any&  aValue  )
 135 {
 136     //  Check, if value of property will changed in method "setFastPropertyValue_NoBroadcast()".
 137     //  Return sal_True, if changed - else return sal_False.
 138     //  Attention: Method "impl_tryToChangeProperty()" can throw the IllegalArgumentException !!!
 139     //  Initialize return value with sal_False !!!
 140     //  (Handle can be invalid)
 141     bool bReturn = false;
 142
 143     switch( nHandle )
 144     {
 145         case HANDLE_TYPE:
 146             bReturn = impl_tryToChangeProperty( m_nSeparatorType, aValue, aOldValue, aConvertedValue );
 147             break;
 148     }
 149
 150     // Return state of operation.
 151     return bReturn;
 152 }
 153
 154 void SAL_CALL ActionTriggerSeparatorPropertySet::setFastPropertyValue_NoBroadcast(
 155     sal_Int32 nHandle, const Any& aValue )
 156 {
 157     SolarMutexGuard aGuard;
 158
 159     // Search for right handle ... and try to set property value.
 160     switch( nHandle )
 161     {
 162         case HANDLE_TYPE:
 163             aValue >>= m_nSeparatorType;
 164             break;
 165     }
 166 }
 167
 168 void SAL_CALL ActionTriggerSeparatorPropertySet::getFastPropertyValue(
 169     Any& aValue, sal_Int32 nHandle ) const
 170 {
 171     SolarMutexGuard aGuard;
 172
 173     // Search for right handle ... and try to get property value.
 174     switch( nHandle )
 175     {
 176         case HANDLE_TYPE:
 177             aValue <<= m_nSeparatorType;
 178             break;
 179     }
 180 }
 181
 182 ::cppu::IPropertyArrayHelper& SAL_CALL ActionTriggerSeparatorPropertySet::getInfoHelper()
 183 {
 184     // Define static member to give structure of properties to baseclass "OPropertySetHelper".
 185     // "impl_getStaticPropertyDescriptor" is a non exported and static function, who will define a static propertytable.
 186     // "true" indicates: Table is sorted by name.
 187     static OPropertyArrayHelper ourInfoHelper( impl_getStaticPropertyDescriptor(), true );
 188
 189     return ourInfoHelper;
 190 }
 191
 192 Reference< XPropertySetInfo > SAL_CALL ActionTriggerSeparatorPropertySet::getPropertySetInfo()
 193 {
 194     // Create structure of propertysetinfo for baseclass "OPropertySetHelper".
 195     // (Use method "getInfoHelper()".)
 196     static Reference< XPropertySetInfo > xInfo( createPropertySetInfo( getInfoHelper() ) );
 197
 198     return xInfo;
 199 }
 200
 201 Sequence< Property > ActionTriggerSeparatorPropertySet::impl_getStaticPropertyDescriptor()
 202 {
 203     return
 204     {
 205         Property( "SeparatorType", HANDLE_TYPE, cppu::UnoType<sal_Int16>::get(), PropertyAttribute::TRANSIENT )
 206     };
 207 }
 208
 209 bool ActionTriggerSeparatorPropertySet::impl_tryToChangeProperty(
 210     sal_Int16           aCurrentValue   ,
 211     const   Any&        aNewValue       ,
 212     Any&                aOldValue       ,
 213     Any&                aConvertedValue )
 214 {
 215     // Set default return value if method failed.
 216     bool bReturn = false;
 217     // Get new value from any.
 218     // IllegalArgumentException() can be thrown!
 219     sal_Int16 aValue = 0;
 220     convertPropertyValue( aValue, aNewValue );
 221
 222     // If value change ...
 223     if( aValue != aCurrentValue )
 224     {
 225         // ... set information of change.
 226         aOldValue       <<= aCurrentValue;
 227         aConvertedValue <<= aValue;
 228         // Return OK - "value will be change ..."
 229         bReturn = true;
 230     }
 231     else
 232     {
 233         // ... clear information of return parameter!
 234         aOldValue.clear         ();
 235         aConvertedValue.clear   ();
 236         // Return NOTHING - "value will not be change ..."
 237         bReturn = false;
 238     }
 239
 240     return bReturn;
 241 }
 242
 243 }
 244
 245 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */