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