toolkit/source/controls/tkspinbutton.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: tkspinbutton.cxx,v $
  10  * $Revision: 1.6 $
  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_toolkit.hxx"
  33 #include "toolkit/controls/tkspinbutton.hxx"
  34 #include "toolkit/helper/property.hxx"
  35 #include "toolkit/helper/unopropertyarrayhelper.hxx"
  36 #include <com/sun/star/awt/ScrollBarOrientation.hpp>
  37
  38
  39 #include <cppuhelper/typeprovider.hxx>
  40 #include <tools/debug.hxx>
  41
  42 //........................................................................
  43 namespace toolkit
  44 {
  45 //........................................................................
  46
  47     using namespace ::com::sun::star::uno;
  48     using namespace ::com::sun::star::awt;
  49     using namespace ::com::sun::star::lang;
  50     using namespace ::com::sun::star::beans;
  51
  52     //====================================================================
  53     //= UnoSpinButtonModel
  54     //====================================================================
  55     //--------------------------------------------------------------------
  56     UnoSpinButtonModel::UnoSpinButtonModel()
  57     {
  58         ImplRegisterProperty( BASEPROPERTY_BACKGROUNDCOLOR );
  59         ImplRegisterProperty( BASEPROPERTY_BORDER );
  60         ImplRegisterProperty( BASEPROPERTY_BORDERCOLOR );
  61         ImplRegisterProperty( BASEPROPERTY_DEFAULTCONTROL );
  62         ImplRegisterProperty( BASEPROPERTY_ENABLED );
  63         ImplRegisterProperty( BASEPROPERTY_ENABLEVISIBLE );
  64         ImplRegisterProperty( BASEPROPERTY_HELPTEXT );
  65         ImplRegisterProperty( BASEPROPERTY_HELPURL );
  66         ImplRegisterProperty( BASEPROPERTY_ORIENTATION );
  67         ImplRegisterProperty( BASEPROPERTY_PRINTABLE );
  68         ImplRegisterProperty( BASEPROPERTY_REPEAT );
  69         ImplRegisterProperty( BASEPROPERTY_REPEAT_DELAY );
  70         ImplRegisterProperty( BASEPROPERTY_SYMBOL_COLOR );
  71         ImplRegisterProperty( BASEPROPERTY_SPINVALUE );
  72         ImplRegisterProperty( BASEPROPERTY_SPINVALUE_MIN );
  73         ImplRegisterProperty( BASEPROPERTY_SPINVALUE_MAX );
  74         ImplRegisterProperty( BASEPROPERTY_SPININCREMENT );
  75         ImplRegisterProperty( BASEPROPERTY_TABSTOP );
  76         ImplRegisterProperty( BASEPROPERTY_WRITING_MODE );
  77         ImplRegisterProperty( BASEPROPERTY_CONTEXT_WRITING_MODE );
  78     }
  79
  80     //--------------------------------------------------------------------
  81     ::rtl::OUString UnoSpinButtonModel::getServiceName( ) throw (RuntimeException)
  82     {
  83         return ::rtl::OUString::createFromAscii( szServiceName_UnoSpinButtonModel );
  84     }
  85
  86     //--------------------------------------------------------------------
  87     Any UnoSpinButtonModel::ImplGetDefaultValue( sal_uInt16 nPropId ) const
  88     {
  89         switch ( nPropId )
  90         {
  91         case BASEPROPERTY_DEFAULTCONTROL:
  92             return makeAny( ::rtl::OUString::createFromAscii( szServiceName_UnoSpinButtonControl ) );
  93
  94         case BASEPROPERTY_BORDER:
  95             return makeAny( (sal_Int16) 0 );
  96
  97         case BASEPROPERTY_REPEAT:
  98             return makeAny( (sal_Bool)sal_True );
  99
 100         default:
 101             return UnoControlModel::ImplGetDefaultValue( nPropId );
 102         }
 103     }
 104
 105     //--------------------------------------------------------------------
 106     ::cppu::IPropertyArrayHelper& UnoSpinButtonModel::getInfoHelper()
 107     {
 108         static UnoPropertyArrayHelper* pHelper = NULL;
 109         if ( !pHelper )
 110         {
 111             Sequence<sal_Int32> aIDs = ImplGetPropertyIds();
 112             pHelper = new UnoPropertyArrayHelper( aIDs );
 113         }
 114         return *pHelper;
 115     }
 116
 117     //--------------------------------------------------------------------
 118     Reference< XPropertySetInfo > UnoSpinButtonModel::getPropertySetInfo(  ) throw(RuntimeException)
 119     {
 120         static Reference< XPropertySetInfo > xInfo( createPropertySetInfo( getInfoHelper() ) );
 121         return xInfo;
 122     }
 123
 124     //--------------------------------------------------------------------
 125     ::rtl::OUString SAL_CALL UnoSpinButtonModel::getImplementationName(  ) throw(RuntimeException)
 126     {
 127         return ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.comp.toolkit.UnoSpinButtonModel" ) );
 128     }
 129
 130     //--------------------------------------------------------------------
 131     Sequence< ::rtl::OUString > SAL_CALL UnoSpinButtonModel::getSupportedServiceNames() throw(RuntimeException)
 132     {
 133         Sequence< ::rtl::OUString > aServices( UnoControlModel::getSupportedServiceNames() );
 134         aServices.realloc( aServices.getLength() + 1 );
 135         aServices[ aServices.getLength() - 1 ] = ::rtl::OUString::createFromAscii( szServiceName_UnoSpinButtonModel );
 136         return aServices;
 137     }
 138
 139     //====================================================================
 140     //= UnoSpinButtonControl
 141     //====================================================================
 142     //--------------------------------------------------------------------
 143     UnoSpinButtonControl::UnoSpinButtonControl()
 144         :maAdjustmentListeners( *this )
 145     {
 146     }
 147
 148     //--------------------------------------------------------------------
 149     ::rtl::OUString UnoSpinButtonControl::GetComponentServiceName()
 150     {
 151         return ::rtl::OUString::createFromAscii( "SpinButton" );
 152     }
 153
 154     //--------------------------------------------------------------------
 155     Any UnoSpinButtonControl::queryAggregation( const Type & rType ) throw(RuntimeException)
 156     {
 157         Any aRet = UnoControlBase::queryAggregation( rType );
 158         if ( !aRet.hasValue() )
 159             aRet = UnoSpinButtonControl_Base::queryInterface( rType );
 160         return aRet;
 161     }
 162
 163     //--------------------------------------------------------------------
 164     IMPLEMENT_FORWARD_XTYPEPROVIDER2( UnoSpinButtonControl, UnoControlBase, UnoSpinButtonControl_Base )
 165
 166     //--------------------------------------------------------------------
 167     void UnoSpinButtonControl::dispose() throw(RuntimeException)
 168     {
 169         ::osl::ClearableMutexGuard aGuard( GetMutex() );
 170         if ( maAdjustmentListeners.getLength() )
 171         {
 172             Reference< XSpinValue > xSpinnable( getPeer(), UNO_QUERY );
 173             if ( xSpinnable.is() )
 174                 xSpinnable->removeAdjustmentListener( this );
 175
 176             EventObject aDisposeEvent;
 177             aDisposeEvent.Source = *this;
 178
 179             aGuard.clear();
 180             maAdjustmentListeners.disposeAndClear( aDisposeEvent );
 181         }
 182
 183         UnoControl::dispose();
 184     }
 185
 186     //--------------------------------------------------------------------
 187     ::rtl::OUString SAL_CALL UnoSpinButtonControl::getImplementationName(  ) throw(RuntimeException)
 188     {
 189         return ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.comp.toolkit.UnoSpinButtonControl" ) );
 190     }
 191
 192     //--------------------------------------------------------------------
 193     Sequence< ::rtl::OUString > SAL_CALL UnoSpinButtonControl::getSupportedServiceNames() throw(RuntimeException)
 194     {
 195         Sequence< ::rtl::OUString > aServices( UnoControlBase::getSupportedServiceNames() );
 196         aServices.realloc( aServices.getLength() + 1 );
 197         aServices[ aServices.getLength() - 1 ] = ::rtl::OUString::createFromAscii( szServiceName_UnoSpinButtonControl );
 198         return aServices;
 199     }
 200
 201     //--------------------------------------------------------------------
 202     void UnoSpinButtonControl::createPeer( const Reference< XToolkit > & rxToolkit, const Reference< XWindowPeer >  & rParentPeer ) throw(RuntimeException)
 203     {
 204         UnoControl::createPeer( rxToolkit, rParentPeer );
 205
 206         Reference < XSpinValue > xSpinnable( getPeer(), UNO_QUERY );
 207         if ( xSpinnable.is() )
 208             xSpinnable->addAdjustmentListener( this );
 209     }
 210
 211     //--------------------------------------------------------------------
 212     void UnoSpinButtonControl::adjustmentValueChanged( const AdjustmentEvent& rEvent ) throw(RuntimeException)
 213     {
 214         switch ( rEvent.Type )
 215         {
 216             case AdjustmentType_ADJUST_LINE:
 217             case AdjustmentType_ADJUST_PAGE:
 218             case AdjustmentType_ADJUST_ABS:
 219                 ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPINVALUE ), makeAny( rEvent.Value ), sal_False );
 220                 break;
 221             default:
 222                 DBG_ERROR( "UnoSpinButtonControl::adjustmentValueChanged - unknown Type" );
 223         }
 224
 225         if ( maAdjustmentListeners.getLength() )
 226         {
 227             AdjustmentEvent aEvent( rEvent );
 228             aEvent.Source = *this;
 229             maAdjustmentListeners.adjustmentValueChanged( aEvent );
 230         }
 231     }
 232
 233     //--------------------------------------------------------------------
 234     void UnoSpinButtonControl::addAdjustmentListener( const Reference< XAdjustmentListener > & listener ) throw(RuntimeException)
 235     {
 236         ::osl::MutexGuard aGuard( GetMutex() );
 237         maAdjustmentListeners.addInterface( listener );
 238     }
 239
 240     //--------------------------------------------------------------------
 241     void UnoSpinButtonControl::removeAdjustmentListener( const Reference< XAdjustmentListener > & listener ) throw(RuntimeException)
 242     {
 243         ::osl::MutexGuard aGuard( GetMutex() );
 244         maAdjustmentListeners.removeInterface( listener );
 245     }
 246
 247     //--------------------------------------------------------------------
 248     void SAL_CALL UnoSpinButtonControl::setValue( sal_Int32 value ) throw (RuntimeException)
 249     {
 250         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPINVALUE ), makeAny( value ), sal_True );
 251     }
 252
 253     //--------------------------------------------------------------------
 254     void SAL_CALL UnoSpinButtonControl::setValues( sal_Int32 minValue, sal_Int32 maxValue, sal_Int32 currentValue ) throw (RuntimeException)
 255     {
 256         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPINVALUE_MIN ), makeAny( minValue ), sal_True );
 257         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPINVALUE_MAX ), makeAny( maxValue ), sal_True );
 258         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPINVALUE ), makeAny( currentValue ), sal_True );
 259     }
 260
 261     //--------------------------------------------------------------------
 262     sal_Int32 SAL_CALL UnoSpinButtonControl::getValue(  ) throw (RuntimeException)
 263     {
 264         ::osl::MutexGuard aGuard( GetMutex() );
 265         sal_Int32 nValue = 0;
 266
 267         Reference< XSpinValue > xSpinnable( getPeer(), UNO_QUERY );
 268         if ( xSpinnable.is() )
 269             nValue = xSpinnable->getValue();
 270
 271         return nValue;
 272     }
 273
 274     //--------------------------------------------------------------------
 275     void SAL_CALL UnoSpinButtonControl::setMinimum( sal_Int32 minValue ) throw (RuntimeException)
 276     {
 277         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPINVALUE_MIN ), makeAny( minValue ), sal_True );
 278     }
 279
 280     //--------------------------------------------------------------------
 281     void SAL_CALL UnoSpinButtonControl::setMaximum( sal_Int32 maxValue ) throw (RuntimeException)
 282     {
 283         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPINVALUE_MAX ), makeAny( maxValue ), sal_True );
 284     }
 285
 286     //--------------------------------------------------------------------
 287     sal_Int32 SAL_CALL UnoSpinButtonControl::getMinimum(  ) throw (RuntimeException)
 288     {
 289         ::osl::MutexGuard aGuard( GetMutex() );
 290         sal_Int32 nMin = 0;
 291
 292         Reference< XSpinValue > xSpinnable( getPeer(), UNO_QUERY );
 293         if ( xSpinnable.is() )
 294             nMin = xSpinnable->getMinimum();
 295
 296         return nMin;
 297     }
 298
 299     //--------------------------------------------------------------------
 300     sal_Int32 SAL_CALL UnoSpinButtonControl::getMaximum(  ) throw (RuntimeException)
 301     {
 302         ::osl::MutexGuard aGuard( GetMutex() );
 303         sal_Int32 nMax = 0;
 304
 305         Reference< XSpinValue > xSpinnable( getPeer(), UNO_QUERY );
 306         if ( xSpinnable.is() )
 307             nMax = xSpinnable->getMaximum();
 308
 309         return nMax;
 310     }
 311
 312     //--------------------------------------------------------------------
 313     void SAL_CALL UnoSpinButtonControl::setSpinIncrement( sal_Int32 spinIncrement ) throw (RuntimeException)
 314     {
 315         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_SPININCREMENT ), makeAny( spinIncrement ), sal_True );
 316     }
 317
 318     //--------------------------------------------------------------------
 319     sal_Int32 SAL_CALL UnoSpinButtonControl::getSpinIncrement(  ) throw (RuntimeException)
 320     {
 321         ::osl::MutexGuard aGuard( GetMutex() );
 322         sal_Int32 nIncrement = 0;
 323
 324         Reference< XSpinValue > xSpinnable( getPeer(), UNO_QUERY );
 325         if ( xSpinnable.is() )
 326             nIncrement = xSpinnable->getSpinIncrement();
 327
 328         return nIncrement;
 329     }
 330
 331     //--------------------------------------------------------------------
 332     void SAL_CALL UnoSpinButtonControl::setOrientation( sal_Int32 orientation ) throw (NoSupportException, RuntimeException)
 333     {
 334         ImplSetPropertyValue( GetPropertyName( BASEPROPERTY_ORIENTATION ), makeAny( orientation ), sal_True );
 335     }
 336
 337     //--------------------------------------------------------------------
 338     sal_Int32 SAL_CALL UnoSpinButtonControl::getOrientation(  ) throw (RuntimeException)
 339     {
 340         ::osl::MutexGuard aGuard( GetMutex() );
 341         sal_Int32 nOrientation = ScrollBarOrientation::HORIZONTAL;
 342
 343         Reference< XSpinValue > xSpinnable( getPeer(), UNO_QUERY );
 344         if ( xSpinnable.is() )
 345             nOrientation = xSpinnable->getOrientation();
 346
 347         return nOrientation;
 348     }
 349
 350 //........................................................................
 351 }  // namespace toolkit
 352 //........................................................................
 353