forms/source/component/scrollbar.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: scrollbar.cxx,v $
  10  * $Revision: 1.11 $
  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_forms.hxx"
  33 #include "scrollbar.hxx"
  34 #include <comphelper/streamsection.hxx>
  35 #include <comphelper/basicio.hxx>
  36 #include <rtl/math.hxx>
  37
  38 //--------------------------------------------------------------------------
  39 extern "C" void SAL_CALL createRegistryInfo_OScrollBarModel()
  40 {
  41     static ::frm::OMultiInstanceAutoRegistration< ::frm::OScrollBarModel >   aRegisterModel;
  42 }
  43
  44 //........................................................................
  45 namespace frm
  46 {
  47 //........................................................................
  48
  49     using namespace ::com::sun::star::uno;
  50     using namespace ::com::sun::star::beans;
  51     using namespace ::com::sun::star::form;
  52     using namespace ::com::sun::star::awt;
  53     using namespace ::com::sun::star::lang;
  54     using namespace ::com::sun::star::util;
  55     using namespace ::com::sun::star::io;
  56     using namespace ::com::sun::star::form::binding;
  57
  58     //====================================================================
  59     //= helper
  60     //====================================================================
  61     //--------------------------------------------------------------------
  62     Any translateExternalDoubleToControlIntValue(
  63         const Any& _rExternalValue, const Reference< XPropertySet >& _rxProperties,
  64         const ::rtl::OUString& _rMinValueName, const ::rtl::OUString& _rMaxValueName )
  65     {
  66         OSL_ENSURE( _rxProperties.is(), "translateExternalDoubleToControlIntValue: no aggregate!?" );
  67
  68         sal_Int32 nControlValue( 0 );
  69         double nExternalValue = 0;
  70         if ( _rExternalValue >>= nExternalValue )
  71         {
  72             if ( ::rtl::math::isInf( nExternalValue ) )
  73             {
  74                 // set the minimum or maximum of the scroll values
  75                 ::rtl::OUString sLimitPropertyName = ::rtl::math::isSignBitSet( nExternalValue )
  76                     ? _rMinValueName : _rMaxValueName;
  77                 if ( _rxProperties.is() )
  78                     _rxProperties->getPropertyValue( sLimitPropertyName ) >>= nControlValue;
  79             }
  80             else
  81             {
  82                 nControlValue = (sal_Int32)::rtl::math::round( nExternalValue );
  83             }
  84         }
  85         else
  86         {
  87             if ( _rxProperties.is() )
  88                 _rxProperties->getPropertyValue( _rMinValueName ) >>= nControlValue;
  89         }
  90
  91         return makeAny( nControlValue );
  92     }
  93
  94     //--------------------------------------------------------------------
  95     Any translateControlIntToExternalDoubleValue( const Any& _rControlIntValue )
  96     {
  97         Any aExternalDoubleValue;
  98         sal_Int32 nScrollValue = 0;
  99         if ( _rControlIntValue >>= nScrollValue )
 100             aExternalDoubleValue <<= (double)nScrollValue;
 101         else
 102         {
 103             OSL_ENSURE( sal_False, "translateControlIntToExternalDoubleValue: no integer scroll value!" );
 104             // aExternalDoubleValue is void here, which is okay for this purpose ...
 105         }
 106
 107         return aExternalDoubleValue;
 108     }
 109
 110     //====================================================================
 111     //= OScrollBarModel
 112     //====================================================================
 113     //--------------------------------------------------------------------
 114     DBG_NAME( OScrollBarModel )
 115     //--------------------------------------------------------------------
 116     OScrollBarModel::OScrollBarModel( const Reference<XMultiServiceFactory>& _rxFactory )
 117         :OBoundControlModel( _rxFactory, VCL_CONTROLMODEL_SCROLLBAR, VCL_CONTROL_SCROLLBAR, sal_True, sal_True, sal_False )
 118         ,m_nDefaultScrollValue( 0 )
 119     {
 120         DBG_CTOR( OScrollBarModel, NULL );
 121
 122         m_nClassId = FormComponentType::SCROLLBAR;
 123         initValueProperty( PROPERTY_SCROLL_VALUE, PROPERTY_ID_SCROLL_VALUE );
 124     }
 125
 126     //--------------------------------------------------------------------
 127     OScrollBarModel::OScrollBarModel( const OScrollBarModel* _pOriginal, const Reference< XMultiServiceFactory >& _rxFactory )
 128         :OBoundControlModel( _pOriginal, _rxFactory )
 129     {
 130         DBG_CTOR( OScrollBarModel, NULL );
 131         m_nDefaultScrollValue = _pOriginal->m_nDefaultScrollValue;
 132     }
 133
 134     //--------------------------------------------------------------------
 135     OScrollBarModel::~OScrollBarModel( )
 136     {
 137         DBG_DTOR( OScrollBarModel, NULL );
 138     }
 139
 140     //--------------------------------------------------------------------
 141     IMPLEMENT_SERVICE_REGISTRATION_2( OScrollBarModel, OControlModel, FRM_SUN_COMPONENT_SCROLLBAR, BINDABLE_INTEGER_VALUE_RANGE )
 142         // note that we're passing OControlModel as "base class". This is because
 143         // OBoundControlModel, our real base class, claims to support the DataAwareControlModel
 144         // service, which isn't really true for us. We only derive from this class
 145         // to benefit from the functionality for binding to spreadsheet cells
 146
 147     //------------------------------------------------------------------------------
 148     IMPLEMENT_DEFAULT_CLONING( OScrollBarModel )
 149
 150     //------------------------------------------------------------------------------
 151     void SAL_CALL OScrollBarModel::disposing()
 152     {
 153         OBoundControlModel::disposing();
 154     }
 155
 156     //--------------------------------------------------------------------
 157     void OScrollBarModel::describeFixedProperties( Sequence< Property >& _rProps ) const
 158     {
 159         BEGIN_DESCRIBE_PROPERTIES( 3, OControlModel )
 160             DECL_PROP1( DEFAULT_SCROLL_VALUE, sal_Int32,       BOUND );
 161             DECL_PROP1( TABINDEX,             sal_Int16,       BOUND );
 162             DECL_PROP2( CONTROLSOURCEPROPERTY,::rtl::OUString, READONLY, TRANSIENT );
 163         END_DESCRIBE_PROPERTIES();
 164     }
 165
 166     //------------------------------------------------------------------------------
 167     void OScrollBarModel::getFastPropertyValue( Any& _rValue, sal_Int32 _nHandle ) const
 168     {
 169         switch ( _nHandle )
 170         {
 171             case PROPERTY_ID_DEFAULT_SCROLL_VALUE:
 172                 _rValue <<= m_nDefaultScrollValue;
 173                 break;
 174
 175             default:
 176                 OBoundControlModel::getFastPropertyValue( _rValue, _nHandle );
 177         }
 178     }
 179
 180     //------------------------------------------------------------------------------
 181     void OScrollBarModel::setFastPropertyValue_NoBroadcast( sal_Int32 _nHandle, const Any& _rValue ) throw ( Exception )
 182     {
 183         switch ( _nHandle )
 184         {
 185             case PROPERTY_ID_DEFAULT_SCROLL_VALUE:
 186                 OSL_VERIFY( _rValue >>= m_nDefaultScrollValue );
 187                 resetNoBroadcast();
 188                 break;
 189
 190             default:
 191                 OBoundControlModel::setFastPropertyValue_NoBroadcast( _nHandle, _rValue );
 192         }
 193     }
 194
 195     //------------------------------------------------------------------------------
 196     sal_Bool OScrollBarModel::convertFastPropertyValue(
 197                 Any& _rConvertedValue, Any& _rOldValue, sal_Int32 _nHandle, const Any& _rValue )
 198                 throw ( IllegalArgumentException )
 199     {
 200         sal_Bool bModified( sal_False );
 201         switch ( _nHandle )
 202         {
 203             case PROPERTY_ID_DEFAULT_SCROLL_VALUE:
 204                 bModified = tryPropertyValue( _rConvertedValue, _rOldValue, _rValue, m_nDefaultScrollValue );
 205                 break;
 206
 207             default:
 208                 bModified = OBoundControlModel::convertFastPropertyValue( _rConvertedValue, _rOldValue, _nHandle, _rValue );
 209                 break;
 210         }
 211         return bModified;
 212     }
 213
 214     //--------------------------------------------------------------------
 215     Any OScrollBarModel::getPropertyDefaultByHandle( sal_Int32 _nHandle ) const
 216     {
 217         Any aReturn;
 218
 219         switch ( _nHandle )
 220         {
 221         case PROPERTY_ID_DEFAULT_SCROLL_VALUE:
 222             aReturn <<= (sal_Int32)0;
 223             break;
 224
 225         default:
 226             aReturn = OBoundControlModel::getPropertyDefaultByHandle( _nHandle );
 227             break;
 228         }
 229
 230         return aReturn;
 231     }
 232
 233     //------------------------------------------------------------------------------
 234     Any OScrollBarModel::translateDbColumnToControlValue( )
 235     {
 236         OSL_ENSURE( sal_False, "OScrollBarModel::commitControlValueToDbColumn: never to be called (we're not bound)!" );
 237         return Any();
 238     }
 239
 240     //------------------------------------------------------------------------------
 241     sal_Bool OScrollBarModel::commitControlValueToDbColumn( bool /*_bPostReset*/ )
 242     {
 243         OSL_ENSURE( sal_False, "OScrollBarModel::commitControlValueToDbColumn: never to be called (we're not bound)!" );
 244         return sal_True;
 245     }
 246
 247     //------------------------------------------------------------------------------
 248     Any OScrollBarModel::getDefaultForReset() const
 249     {
 250         return makeAny( (sal_Int32)m_nDefaultScrollValue );
 251     }
 252
 253     //--------------------------------------------------------------------
 254     ::rtl::OUString SAL_CALL OScrollBarModel::getServiceName() throw( RuntimeException )
 255     {
 256         return FRM_SUN_COMPONENT_SCROLLBAR;
 257     }
 258
 259     //--------------------------------------------------------------------
 260     void SAL_CALL OScrollBarModel::write( const Reference< XObjectOutputStream >& _rxOutStream )
 261         throw( IOException, RuntimeException )
 262     {
 263         OBoundControlModel::write( _rxOutStream );
 264         ::osl::MutexGuard aGuard( m_aMutex );
 265
 266         OStreamSection aSection( Reference< XDataOutputStream >( _rxOutStream, UNO_QUERY ) );
 267
 268         // version
 269         _rxOutStream->writeShort( 0x0001 );
 270
 271         // properties
 272         _rxOutStream << m_nDefaultScrollValue;
 273         writeHelpTextCompatibly( _rxOutStream );
 274     }
 275
 276     //--------------------------------------------------------------------
 277     void SAL_CALL OScrollBarModel::read( const Reference< XObjectInputStream>& _rxInStream ) throw( IOException, RuntimeException )
 278     {
 279         OBoundControlModel::read( _rxInStream );
 280         ::osl::MutexGuard aGuard( m_aMutex );
 281
 282         // version
 283         {
 284             OStreamSection aSection( Reference< XDataInputStream >( _rxInStream, UNO_QUERY ) );
 285
 286             sal_uInt16 nVersion = _rxInStream->readShort();
 287             if ( nVersion == 0x0001 )
 288             {
 289                 _rxInStream >> m_nDefaultScrollValue;
 290                 readHelpTextCompatibly( _rxInStream );
 291             }
 292             else
 293                 defaultCommonProperties();
 294
 295             // here, everything in the stream section which is left will be skipped
 296         }
 297     }
 298
 299     //--------------------------------------------------------------------
 300     Any OScrollBarModel::translateExternalValueToControlValue( const Any& _rExternalValue ) const
 301     {
 302         return translateExternalDoubleToControlIntValue( _rExternalValue, m_xAggregateSet,
 303             ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "ScrollValueMin" ) ),
 304             ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "ScrollValueMax" ) ) );
 305     }
 306
 307     //--------------------------------------------------------------------
 308     Any OScrollBarModel::translateControlValueToExternalValue( ) const
 309     {
 310         // by definition, the base class simply obtains the property value
 311         return translateControlIntToExternalDoubleValue( OBoundControlModel::translateControlValueToExternalValue() );
 312     }
 313
 314     //--------------------------------------------------------------------
 315     Sequence< Type > OScrollBarModel::getSupportedBindingTypes()
 316     {
 317         return Sequence< Type >( &::getCppuType( static_cast< double* >( NULL ) ), 1 );
 318     }
 319
 320 //........................................................................
 321 }   // namespace frm
 322 //........................................................................