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