forms/source/component/refvaluecomponent.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 "refvaluecomponent.hxx"
  21 #include <property.hxx>
  22
  23 #include <comphelper/property.hxx>
  24 #include <tools/debug.hxx>
  25 #include <comphelper/diagnose_ex.hxx>
  26
  27 #include <com/sun/star/beans/PropertyAttribute.hpp>
  28
  29 #include <vector>
  30
  31
  32 namespace frm
  33 {
  34
  35
  36     using namespace ::com::sun::star::uno;
  37     using namespace ::com::sun::star::lang;
  38     using namespace ::com::sun::star::beans;
  39
  40
  41     //=
  42
  43
  44     OReferenceValueComponent::OReferenceValueComponent( const Reference< XComponentContext >& _rxFactory, const OUString& _rUnoControlModelTypeName, const OUString& _rDefault )
  45         :OBoundControlModel( _rxFactory, _rUnoControlModelTypeName, _rDefault, false, true, true )
  46         ,m_eDefaultChecked( TRISTATE_FALSE )
  47     {
  48     }
  49
  50
  51     OReferenceValueComponent::OReferenceValueComponent( const OReferenceValueComponent* _pOriginal, const Reference< XComponentContext>& _rxFactory )
  52         :OBoundControlModel( _pOriginal, _rxFactory )
  53     {
  54         m_sReferenceValue           = _pOriginal->m_sReferenceValue;
  55         m_sNoCheckReferenceValue    = _pOriginal->m_sNoCheckReferenceValue;
  56         m_eDefaultChecked           = _pOriginal->m_eDefaultChecked;
  57
  58         calculateExternalValueType();
  59     }
  60
  61
  62     OReferenceValueComponent::~OReferenceValueComponent()
  63     {
  64     }
  65
  66
  67     void OReferenceValueComponent::setReferenceValue( const OUString& _rRefValue )
  68     {
  69         m_sReferenceValue = _rRefValue;
  70         calculateExternalValueType();
  71     }
  72
  73
  74     void SAL_CALL OReferenceValueComponent::getFastPropertyValue( Any& _rValue, sal_Int32 _nHandle ) const
  75     {
  76         switch ( _nHandle )
  77         {
  78         case PROPERTY_ID_REFVALUE:          _rValue <<= m_sReferenceValue; break;
  79         case PROPERTY_ID_DEFAULT_STATE:    _rValue <<= static_cast<sal_Int16>(m_eDefaultChecked); break;
  80
  81         case PROPERTY_ID_UNCHECKED_REFVALUE:
  82             _rValue <<= m_sNoCheckReferenceValue;
  83             break;
  84
  85         default:
  86             OBoundControlModel::getFastPropertyValue( _rValue, _nHandle );
  87         }
  88     }
  89
  90
  91     void SAL_CALL OReferenceValueComponent::setFastPropertyValue_NoBroadcast( sal_Int32 _nHandle, const Any& _rValue )
  92     {
  93         switch ( _nHandle )
  94         {
  95         case PROPERTY_ID_REFVALUE :
  96             OSL_VERIFY( _rValue >>= m_sReferenceValue );
  97             calculateExternalValueType();
  98             break;
  99
 100         case PROPERTY_ID_UNCHECKED_REFVALUE:
 101             OSL_VERIFY( _rValue >>= m_sNoCheckReferenceValue );
 102             break;
 103
 104         case PROPERTY_ID_DEFAULT_STATE:
 105         {
 106             sal_Int16 nDefaultChecked;
 107             if (!(_rValue >>= nDefaultChecked) || nDefaultChecked < 0
 108                 || nDefaultChecked > 2)
 109             {
 110                 throw css::lang::IllegalArgumentException(
 111                     (u"DefaultState property value must be a SHORT in the range"
 112                      " 0--2"_ustr),
 113                     css::uno::Reference<css::uno::XInterface>(), -1);
 114             }
 115             m_eDefaultChecked = static_cast<ToggleState>(nDefaultChecked);
 116             resetNoBroadcast();
 117         }
 118         break;
 119
 120         default:
 121             OBoundControlModel::setFastPropertyValue_NoBroadcast( _nHandle, _rValue );
 122         }
 123     }
 124
 125
 126     sal_Bool SAL_CALL OReferenceValueComponent::convertFastPropertyValue( Any& _rConvertedValue, Any& _rOldValue, sal_Int32 _nHandle, const Any& _rValue )
 127     {
 128         bool bModified = false;
 129         switch ( _nHandle )
 130         {
 131         case PROPERTY_ID_REFVALUE:
 132             bModified = tryPropertyValue( _rConvertedValue, _rOldValue, _rValue, m_sReferenceValue );
 133             break;
 134
 135         case PROPERTY_ID_UNCHECKED_REFVALUE:
 136             bModified = tryPropertyValue( _rConvertedValue, _rOldValue, _rValue, m_sNoCheckReferenceValue );
 137             break;
 138
 139         case PROPERTY_ID_DEFAULT_STATE:
 140             bModified = tryPropertyValue( _rConvertedValue, _rOldValue, _rValue, static_cast<sal_Int16>(m_eDefaultChecked) );
 141             break;
 142
 143         default:
 144             bModified = OBoundControlModel::convertFastPropertyValue( _rConvertedValue, _rOldValue, _nHandle, _rValue );
 145             break;
 146         }
 147         return bModified;
 148     }
 149
 150
 151     Any OReferenceValueComponent::getDefaultForReset() const
 152     {
 153         return Any( static_cast<sal_Int16>(m_eDefaultChecked) );
 154     }
 155
 156
 157     void OReferenceValueComponent::describeFixedProperties( Sequence< Property >& _rProps ) const
 158     {
 159         OBoundControlModel::describeFixedProperties( _rProps );
 160         sal_Int32 nOldCount = _rProps.getLength();
 161         _rProps.realloc( nOldCount + 3);
 162         css::beans::Property* pProperties = _rProps.getArray() + nOldCount;
 163         *pProperties++ = css::beans::Property(PROPERTY_REFVALUE, PROPERTY_ID_REFVALUE, cppu::UnoType<OUString>::get(), css::beans::PropertyAttribute::BOUND);
 164         *pProperties++ = css::beans::Property(PROPERTY_DEFAULT_STATE, PROPERTY_ID_DEFAULT_STATE, cppu::UnoType<sal_Int16>::get(), css::beans::PropertyAttribute::BOUND);
 165         *pProperties++ = css::beans::Property(PROPERTY_UNCHECKED_REFVALUE, PROPERTY_ID_UNCHECKED_REFVALUE, cppu::UnoType<OUString>::get(), css::beans::PropertyAttribute::BOUND);
 166         DBG_ASSERT( pProperties == _rProps.getArray() + _rProps.getLength(), "<...>::describeFixedProperties/getInfoHelper: forgot to adjust the count ?");
 167     }
 168
 169
 170     Sequence< Type > OReferenceValueComponent::getSupportedBindingTypes()
 171     {
 172         ::std::vector< Type > aTypes;
 173
 174         if ( !m_sReferenceValue.isEmpty() )
 175             aTypes.push_back( cppu::UnoType<OUString>::get() );
 176
 177         aTypes.push_back( cppu::UnoType<sal_Bool>::get() );
 178
 179         return comphelper::containerToSequence(aTypes);
 180     }
 181
 182
 183     Any OReferenceValueComponent::translateExternalValueToControlValue( const Any& _rExternalValue ) const
 184     {
 185         sal_Int16 nState = TRISTATE_INDET;
 186
 187         bool bExternalState = false;
 188         OUString sExternalValue;
 189         if ( _rExternalValue >>= bExternalState )
 190         {
 191             nState = ::sal::static_int_cast< sal_Int16 >( bExternalState ? TRISTATE_TRUE : TRISTATE_FALSE );
 192         }
 193         else if ( _rExternalValue >>= sExternalValue )
 194         {
 195             if ( sExternalValue == m_sReferenceValue )
 196                 nState = TRISTATE_TRUE;
 197             else
 198             {
 199                 if ( sExternalValue == m_sNoCheckReferenceValue )
 200                     nState = TRISTATE_FALSE;
 201                 else
 202                     nState = TRISTATE_INDET;
 203             }
 204         }
 205         else if ( !_rExternalValue.hasValue() )
 206         {
 207             nState = TRISTATE_INDET;
 208         }
 209         else
 210         {
 211             OSL_FAIL( "OReferenceValueComponent::translateExternalValueToControlValue: unexpected value type!" );
 212         }
 213
 214         return Any( nState );
 215     }
 216
 217
 218     Any OReferenceValueComponent::translateControlValueToExternalValue( ) const
 219     {
 220         Any aExternalValue;
 221
 222         try
 223         {
 224             Any aControlValue( m_xAggregateSet->getPropertyValue( PROPERTY_STATE ) );
 225             sal_Int16 nControlValue = TRISTATE_INDET;
 226             aControlValue >>= nControlValue;
 227
 228             bool bBooleanExchange = getExternalValueType().getTypeClass() == TypeClass_BOOLEAN;
 229             bool bStringExchange = getExternalValueType().getTypeClass() == TypeClass_STRING;
 230             OSL_ENSURE( bBooleanExchange || bStringExchange,
 231                 "OReferenceValueComponent::translateControlValueToExternalValue: unexpected value exchange type!" );
 232
 233             switch( nControlValue )
 234             {
 235             case TRISTATE_TRUE:
 236                 if ( bBooleanExchange )
 237                 {
 238                     aExternalValue <<= true;
 239                 }
 240                 else if ( bStringExchange )
 241                 {
 242                     aExternalValue <<= m_sReferenceValue;
 243                 }
 244                 break;
 245
 246             case TRISTATE_FALSE:
 247                 if ( bBooleanExchange )
 248                 {
 249                     aExternalValue <<= false;
 250                 }
 251                 else if ( bStringExchange )
 252                 {
 253                     aExternalValue <<= m_sNoCheckReferenceValue;
 254                 }
 255                 break;
 256             }
 257         }
 258         catch( const Exception& )
 259         {
 260             TOOLS_WARN_EXCEPTION( "forms.component", "OReferenceValueComponent::translateControlValueToExternalValue" );
 261         }
 262
 263         return aExternalValue;
 264     }
 265
 266
 267     Any OReferenceValueComponent::translateControlValueToValidatableValue( ) const
 268     {
 269         if ( !m_xAggregateSet.is() )
 270             return Any();
 271
 272         Any aControlValue( m_xAggregateSet->getPropertyValue( PROPERTY_STATE ) );
 273         sal_Int16 nControlValue = TRISTATE_INDET;
 274         aControlValue >>= nControlValue;
 275
 276         Any aValidatableValue;
 277         switch ( nControlValue )
 278         {
 279         case TRISTATE_TRUE:
 280             aValidatableValue <<= true;
 281             break;
 282         case TRISTATE_FALSE:
 283             aValidatableValue <<= false;
 284             break;
 285         }
 286         return aValidatableValue;
 287     }
 288
 289
 290 } // namespace frm
 291
 292
 293 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */