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