toolkit/source/controls/tkspinbutton.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 <com/sun/star/awt/ScrollBarOrientation.hpp>
  21 #include <com/sun/star/awt/XSpinValue.hpp>
  22 #include <com/sun/star/awt/XAdjustmentListener.hpp>
  23 #include <com/sun/star/uno/XComponentContext.hpp>
  24
  25 #include <comphelper/uno3.hxx>
  26 #include <cppuhelper/implbase2.hxx>
  27 #include <cppuhelper/typeprovider.hxx>
  28 #include <toolkit/controls/unocontrolmodel.hxx>
  29 #include <toolkit/controls/unocontrolbase.hxx>
  30 #include <toolkit/helper/macros.hxx>
  31 #include <toolkit/helper/property.hxx>
  32
  33 #include "helper/unopropertyarrayhelper.hxx"
  34
  35 using namespace ::com::sun::star::uno;
  36 using namespace ::com::sun::star::awt;
  37 using namespace ::com::sun::star::lang;
  38 using namespace ::com::sun::star::beans;
  39
  40 namespace {
  41
  42 class UnoSpinButtonModel : public UnoControlModel
  43 {
  44 protected:
  45     css::uno::Any      ImplGetDefaultValue( sal_uInt16 nPropId ) const override;
  46     ::cppu::IPropertyArrayHelper&   SAL_CALL getInfoHelper() override;
  47
  48 public:
  49     explicit UnoSpinButtonModel( const css::uno::Reference< css::uno::XComponentContext >& i_factory );
  50     UnoSpinButtonModel( const UnoSpinButtonModel& rModel ) : UnoControlModel( rModel ) {}
  51
  52     UnoControlModel*    Clone() const override { return new UnoSpinButtonModel( *this ); }
  53
  54     // XMultiPropertySet
  55     css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) override;
  56
  57     // XPersistObject
  58     OUString SAL_CALL getServiceName() override;
  59
  60     // XServiceInfo
  61     OUString SAL_CALL getImplementationName(  ) override;
  62     css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
  63 };
  64
  65
  66 //= UnoSpinButtonControl
  67
  68
  69 typedef ::cppu::ImplHelper2 <   css::awt::XAdjustmentListener
  70                             ,   css::awt::XSpinValue
  71                             >   UnoSpinButtonControl_Base;
  72
  73 class UnoSpinButtonControl :public UnoControlBase
  74                            ,public UnoSpinButtonControl_Base
  75 {
  76 private:
  77     AdjustmentListenerMultiplexer maAdjustmentListeners;
  78
  79 public:
  80                                 UnoSpinButtonControl();
  81     OUString             GetComponentServiceName() override;
  82
  83     DECLARE_UNO3_AGG_DEFAULTS( UnoSpinButtonControl, UnoControlBase )
  84     css::uno::Any  SAL_CALL queryAggregation( const css::uno::Type & rType ) override;
  85
  86     void SAL_CALL createPeer( const css::uno::Reference< css::awt::XToolkit >& Toolkit, const css::uno::Reference< css::awt::XWindowPeer >& Parent ) override;
  87     void SAL_CALL disposing( const css::lang::EventObject& Source ) override { UnoControlBase::disposing( Source ); }
  88     void SAL_CALL dispose(  ) override;
  89
  90     // XTypeProvider
  91     DECLARE_XTYPEPROVIDER()
  92
  93     // XAdjustmentListener
  94     void SAL_CALL adjustmentValueChanged( const css::awt::AdjustmentEvent& rEvent ) override;
  95
  96     // XSpinValue
  97     virtual void SAL_CALL addAdjustmentListener( const css::uno::Reference< css::awt::XAdjustmentListener >& listener ) override;
  98     virtual void SAL_CALL removeAdjustmentListener( const css::uno::Reference< css::awt::XAdjustmentListener >& listener ) override;
  99     virtual void SAL_CALL setValue( sal_Int32 value ) override;
 100     virtual void SAL_CALL setValues( sal_Int32 minValue, sal_Int32 maxValue, sal_Int32 currentValue ) override;
 101     virtual sal_Int32 SAL_CALL getValue(  ) override;
 102     virtual void SAL_CALL setMinimum( sal_Int32 minValue ) override;
 103     virtual void SAL_CALL setMaximum( sal_Int32 maxValue ) override;
 104     virtual sal_Int32 SAL_CALL getMinimum(  ) override;
 105     virtual sal_Int32 SAL_CALL getMaximum(  ) override;
 106     virtual void SAL_CALL setSpinIncrement( sal_Int32 spinIncrement ) override;
 107     virtual sal_Int32 SAL_CALL getSpinIncrement(  ) override;
 108     virtual void SAL_CALL setOrientation( sal_Int32 orientation ) override;
 109     virtual sal_Int32 SAL_CALL getOrientation(  ) override;
 110
 111     // XServiceInfo
 112     OUString SAL_CALL getImplementationName(  ) override;
 113     css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 114 };
 115
 116
 117     //= UnoSpinButtonModel
 118
 119
 120     UnoSpinButtonModel::UnoSpinButtonModel( const css::uno::Reference< css::uno::XComponentContext >& i_factory )
 121         :UnoControlModel( i_factory )
 122     {
 123         ImplRegisterProperty( BASEPROPERTY_BACKGROUNDCOLOR );
 124         ImplRegisterProperty( BASEPROPERTY_BORDER );
 125         ImplRegisterProperty( BASEPROPERTY_BORDERCOLOR );
 126         ImplRegisterProperty( BASEPROPERTY_DEFAULTCONTROL );
 127         ImplRegisterProperty( BASEPROPERTY_ENABLED );
 128         ImplRegisterProperty( BASEPROPERTY_ENABLEVISIBLE );
 129         ImplRegisterProperty( BASEPROPERTY_HELPTEXT );
 130         ImplRegisterProperty( BASEPROPERTY_HELPURL );
 131         ImplRegisterProperty( BASEPROPERTY_ORIENTATION );
 132         ImplRegisterProperty( BASEPROPERTY_PRINTABLE );
 133         ImplRegisterProperty( BASEPROPERTY_REPEAT );
 134         ImplRegisterProperty( BASEPROPERTY_REPEAT_DELAY );
 135         ImplRegisterProperty( BASEPROPERTY_SYMBOL_COLOR );
 136         ImplRegisterProperty( BASEPROPERTY_SPINVALUE );
 137         ImplRegisterProperty( BASEPROPERTY_SPINVALUE_MIN );
 138         ImplRegisterProperty( BASEPROPERTY_SPINVALUE_MAX );
 139         ImplRegisterProperty( BASEPROPERTY_SPININCREMENT );
 140         ImplRegisterProperty( BASEPROPERTY_TABSTOP );
 141         ImplRegisterProperty( BASEPROPERTY_WRITING_MODE );
 142         ImplRegisterProperty( BASEPROPERTY_CONTEXT_WRITING_MODE );
 143     }
 144
 145
 146     OUString UnoSpinButtonModel::getServiceName( )
 147     {
 148         return OUString("com.sun.star.awt.UnoControlSpinButtonModel");
 149     }
 150
 151
 152     Any UnoSpinButtonModel::ImplGetDefaultValue( sal_uInt16 nPropId ) const
 153     {
 154         switch ( nPropId )
 155         {
 156         case BASEPROPERTY_DEFAULTCONTROL:
 157             return makeAny( OUString("com.sun.star.awt.UnoControlSpinButton") );
 158
 159         case BASEPROPERTY_BORDER:
 160             return makeAny( (sal_Int16) 0 );
 161
 162         case BASEPROPERTY_REPEAT:
 163             return makeAny( true );
 164
 165         default:
 166             return UnoControlModel::ImplGetDefaultValue( nPropId );
 167         }
 168     }
 169
 170
 171     ::cppu::IPropertyArrayHelper& UnoSpinButtonModel::getInfoHelper()
 172     {
 173         static UnoPropertyArrayHelper* pHelper = nullptr;
 174         if ( !pHelper )
 175         {
 176             Sequence<sal_Int32> aIDs = ImplGetPropertyIds();
 177             pHelper = new UnoPropertyArrayHelper( aIDs );
 178         }
 179         return *pHelper;
 180     }
 181
 182
 183     Reference< XPropertySetInfo > UnoSpinButtonModel::getPropertySetInfo(  )
 184     {
 185         static Reference< XPropertySetInfo > xInfo( createPropertySetInfo( getInfoHelper() ) );
 186         return xInfo;
 187     }
 188
 189
 190     OUString SAL_CALL UnoSpinButtonModel::getImplementationName(  )
 191     {
 192         return OUString( "stardiv.Toolkit.UnoSpinButtonModel" );
 193     }
 194
 195
 196     Sequence< OUString > SAL_CALL UnoSpinButtonModel::getSupportedServiceNames()
 197     {
 198         Sequence< OUString > aServices( UnoControlModel::getSupportedServiceNames() );
 199         aServices.realloc( aServices.getLength() + 1 );
 200         aServices[ aServices.getLength() - 1 ] = "com.sun.star.awt.UnoControlSpinButtonModel";
 201         return aServices;
 202     }
 203
 204
 205     //= UnoSpinButtonControl
 206
 207
 208     UnoSpinButtonControl::UnoSpinButtonControl()
 209         :UnoControlBase()
 210         ,maAdjustmentListeners( *this )
 211     {
 212     }
 213
 214
 215     OUString UnoSpinButtonControl::GetComponentServiceName()
 216     {
 217         return OUString("SpinButton");
 218     }
 219
 220
 221     Any UnoSpinButtonControl::queryAggregation( const Type & rType )
 222     {
 223         Any aRet = UnoControlBase::queryAggregation( rType );
 224         if ( !aRet.hasValue() )
 225             aRet = UnoSpinButtonControl_Base::queryInterface( rType );
 226         return aRet;
 227     }
 228
 229
 230     IMPLEMENT_FORWARD_XTYPEPROVIDER2( UnoSpinButtonControl, UnoControlBase, UnoSpinButtonControl_Base )
 231
 232
 233     void UnoSpinButtonControl::dispose()
 234     {
 235         ::osl::ClearableMutexGuard aGuard( GetMutex() );
 236         if ( maAdjustmentListeners.getLength() )
 237         {
 238             Reference< XSpinValue > xSpinnable( getPeer(), UNO_QUERY );
 239             if ( xSpinnable.is() )
 240                 xSpinnable->removeAdjustmentListener( this );
 241
 242             EventObject aDisposeEvent;
 243             aDisposeEvent.Source = *this;
 244
 245             aGuard.clear();
 246             maAdjustmentListeners.disposeAndClear( aDisposeEvent );
 247         }
 248
 249         UnoControl::dispose();
 250     }
 251
 252
 253     OUString SAL_CALL UnoSpinButtonControl::getImplementationName(  )
 254     {
 255         return OUString( "stardiv.Toolkit.UnoSpinButtonControl" );
 256     }
 257
 258
 259     Sequence< OUString > SAL_CALL UnoSpinButtonControl::getSupportedServiceNames()
 260     {
 261         Sequence< OUString > aServices( UnoControlBase::getSupportedServiceNames() );
 262         aServices.realloc( aServices.getLength() + 1 );
 263         aServices[ aServices.getLength() - 1 ] = "com.sun.star.awt.UnoControlSpinButton";
 264         return aServices;
 265     }
 266
 267
 268     void UnoSpinButtonControl::createPeer( const Reference< XToolkit > & rxToolkit, const Reference< XWindowPeer >  & rParentPeer )
 269     {
 270         UnoControl::createPeer( rxToolkit, rParentPeer );
 271
 272         Reference < XSpinValue > xSpinnable( getPeer(), UNO_QUERY );
 273         if ( xSpinnable.is() )
 274             xSpinnable->addAdjustmentListener( this );
 275     }
 276
 277
 278     void UnoSpinButtonControl::adjustmentValueChanged( const AdjustmentEvent& rEvent )
 279     {
 280         switch ( rEvent.Type )
 281         {
 282             case AdjustmentType_ADJUST_LINE:
 283             case AdjustmentType_ADJUST_PAGE:
 284             case AdjustmentType_ADJUST_ABS:
 285                 ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPINVALUE ), makeAny( rEvent.Value ), false );
 286                 break;
 287             default:
 288                 OSL_FAIL( "UnoSpinButtonControl::adjustmentValueChanged - unknown Type" );
 289         }
 290
 291         if ( maAdjustmentListeners.getLength() )
 292         {
 293             AdjustmentEvent aEvent( rEvent );
 294             aEvent.Source = *this;
 295             maAdjustmentListeners.adjustmentValueChanged( aEvent );
 296         }
 297     }
 298
 299
 300     void UnoSpinButtonControl::addAdjustmentListener( const Reference< XAdjustmentListener > & listener )
 301     {
 302         ::osl::MutexGuard aGuard( GetMutex() );
 303         maAdjustmentListeners.addInterface( listener );
 304     }
 305
 306
 307     void UnoSpinButtonControl::removeAdjustmentListener( const Reference< XAdjustmentListener > & listener )
 308     {
 309         ::osl::MutexGuard aGuard( GetMutex() );
 310         maAdjustmentListeners.removeInterface( listener );
 311     }
 312
 313
 314     void SAL_CALL UnoSpinButtonControl::setValue( sal_Int32 value )
 315     {
 316         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPINVALUE ), makeAny( value ), true );
 317     }
 318
 319
 320     void SAL_CALL UnoSpinButtonControl::setValues( sal_Int32 minValue, sal_Int32 maxValue, sal_Int32 currentValue )
 321     {
 322         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPINVALUE_MIN ), makeAny( minValue ), true );
 323         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPINVALUE_MAX ), makeAny( maxValue ), true );
 324         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPINVALUE ), makeAny( currentValue ), true );
 325     }
 326
 327
 328     sal_Int32 SAL_CALL UnoSpinButtonControl::getValue(  )
 329     {
 330         ::osl::MutexGuard aGuard( GetMutex() );
 331         sal_Int32 nValue = 0;
 332
 333         Reference< XSpinValue > xSpinnable( getPeer(), UNO_QUERY );
 334         if ( xSpinnable.is() )
 335             nValue = xSpinnable->getValue();
 336
 337         return nValue;
 338     }
 339
 340
 341     void SAL_CALL UnoSpinButtonControl::setMinimum( sal_Int32 minValue )
 342     {
 343         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPINVALUE_MIN ), makeAny( minValue ), true );
 344     }
 345
 346
 347     void SAL_CALL UnoSpinButtonControl::setMaximum( sal_Int32 maxValue )
 348     {
 349         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPINVALUE_MAX ), makeAny( maxValue ), true );
 350     }
 351
 352
 353     sal_Int32 SAL_CALL UnoSpinButtonControl::getMinimum(  )
 354     {
 355         ::osl::MutexGuard aGuard( GetMutex() );
 356         sal_Int32 nMin = 0;
 357
 358         Reference< XSpinValue > xSpinnable( getPeer(), UNO_QUERY );
 359         if ( xSpinnable.is() )
 360             nMin = xSpinnable->getMinimum();
 361
 362         return nMin;
 363     }
 364
 365
 366     sal_Int32 SAL_CALL UnoSpinButtonControl::getMaximum(  )
 367     {
 368         ::osl::MutexGuard aGuard( GetMutex() );
 369         sal_Int32 nMax = 0;
 370
 371         Reference< XSpinValue > xSpinnable( getPeer(), UNO_QUERY );
 372         if ( xSpinnable.is() )
 373             nMax = xSpinnable->getMaximum();
 374
 375         return nMax;
 376     }
 377
 378
 379     void SAL_CALL UnoSpinButtonControl::setSpinIncrement( sal_Int32 spinIncrement )
 380     {
 381         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPININCREMENT ), makeAny( spinIncrement ), true );
 382     }
 383
 384
 385     sal_Int32 SAL_CALL UnoSpinButtonControl::getSpinIncrement(  )
 386     {
 387         ::osl::MutexGuard aGuard( GetMutex() );
 388         sal_Int32 nIncrement = 0;
 389
 390         Reference< XSpinValue > xSpinnable( getPeer(), UNO_QUERY );
 391         if ( xSpinnable.is() )
 392             nIncrement = xSpinnable->getSpinIncrement();
 393
 394         return nIncrement;
 395     }
 396
 397
 398     void SAL_CALL UnoSpinButtonControl::setOrientation( sal_Int32 orientation )
 399     {
 400         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_ORIENTATION ), makeAny( orientation ), true );
 401     }
 402
 403
 404     sal_Int32 SAL_CALL UnoSpinButtonControl::getOrientation(  )
 405     {
 406         ::osl::MutexGuard aGuard( GetMutex() );
 407         sal_Int32 nOrientation = ScrollBarOrientation::HORIZONTAL;
 408
 409         Reference< XSpinValue > xSpinnable( getPeer(), UNO_QUERY );
 410         if ( xSpinnable.is() )
 411             nOrientation = xSpinnable->getOrientation();
 412
 413         return nOrientation;
 414     }
 415
 416 }
 417
 418 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface * SAL_CALL
 419 stardiv_Toolkit_UnoSpinButtonModel_get_implementation(
 420     css::uno::XComponentContext *context,
 421     css::uno::Sequence<css::uno::Any> const &)
 422 {
 423     return cppu::acquire(new UnoSpinButtonModel(context));
 424 }
 425
 426 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface * SAL_CALL
 427 stardiv_Toolkit_UnoSpinButtonControl_get_implementation(
 428     css::uno::XComponentContext *,
 429     css::uno::Sequence<css::uno::Any> const &)
 430 {
 431     return cppu::acquire(new UnoSpinButtonControl());
 432 }
 433
 434 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */