toolkit/source/controls/roadmapcontrol.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
  21 #include <toolkit/controls/roadmapcontrol.hxx>
  22 #include <toolkit/helper/unopropertyarrayhelper.hxx>
  23 #include <toolkit/helper/property.hxx>
  24 #include <com/sun/star/awt/XVclWindowPeer.hpp>
  25 #include <comphelper/processfactory.hxx>
  26 #include <osl/diagnose.h>
  27
  28 //........................................................................
  29 namespace toolkit
  30 {
  31 //........................................................................
  32
  33     using namespace ::com::sun::star::uno;
  34     using namespace ::com::sun::star::awt;
  35     using namespace ::com::sun::star::lang;
  36     using namespace ::com::sun::star::beans;
  37     using namespace ::com::sun::star::container;
  38
  39 //  ----------------------------------------------------
  40 //  helper
  41 //  ----------------------------------------------------
  42
  43 static void lcl_throwIllegalArgumentException( )
  44 {   // throwing is expensive (in terms of code size), thus we hope the compiler does not inline this ....
  45     throw IllegalArgumentException();
  46 }
  47
  48 static void lcl_throwIndexOutOfBoundsException( )
  49 {   // throwing is expensive (in terms of code size), thus we hope the compiler does not inline this ....
  50     throw IndexOutOfBoundsException();
  51 }
  52
  53     // ===================================================================
  54     // = UnoControlRoadmapModel
  55     // ===================================================================
  56     // -------------------------------------------------------------------
  57     UnoControlRoadmapModel::UnoControlRoadmapModel( const Reference< XMultiServiceFactory >& i_factory )
  58         :UnoControlRoadmapModel_Base( i_factory )
  59         ,maContainerListeners( *this )
  60     {
  61         ImplRegisterProperty( BASEPROPERTY_BACKGROUNDCOLOR );
  62         ImplRegisterProperty( BASEPROPERTY_BORDER );
  63         ImplRegisterProperty( BASEPROPERTY_BORDERCOLOR );
  64         ImplRegisterProperty( BASEPROPERTY_DEFAULTCONTROL );
  65         ImplRegisterProperty( BASEPROPERTY_FONTDESCRIPTOR );
  66         ImplRegisterProperty( BASEPROPERTY_HELPTEXT );
  67         ImplRegisterProperty( BASEPROPERTY_HELPURL );
  68         ImplRegisterProperty( BASEPROPERTY_IMAGEURL );
  69         ImplRegisterProperty( BASEPROPERTY_GRAPHIC );
  70         ImplRegisterProperty( BASEPROPERTY_PRINTABLE );
  71         ImplRegisterProperty( BASEPROPERTY_COMPLETE );
  72         ImplRegisterProperty( BASEPROPERTY_ACTIVATED );
  73         ImplRegisterProperty( BASEPROPERTY_CURRENTITEMID );
  74         ImplRegisterProperty( BASEPROPERTY_TABSTOP );
  75         ImplRegisterProperty( BASEPROPERTY_TEXT );
  76     }
  77
  78     // -------------------------------------------------------------------
  79     ::rtl::OUString UnoControlRoadmapModel::getServiceName() throw(RuntimeException)
  80     {
  81         return ::rtl::OUString::createFromAscii( szServiceName_UnoControlRoadmapModel );
  82     }
  83
  84
  85     // -------------------------------------------------------------------
  86     Any UnoControlRoadmapModel::ImplGetDefaultValue( sal_uInt16 nPropId ) const
  87     {
  88         Any aReturn;
  89         switch (nPropId)
  90         {
  91                 case BASEPROPERTY_COMPLETE:
  92                     aReturn <<= (sal_Bool) sal_True;
  93                     break;
  94                 case BASEPROPERTY_ACTIVATED:
  95                     aReturn <<= (sal_Bool) sal_True;
  96                     break;
  97                 case BASEPROPERTY_CURRENTITEMID:
  98                     aReturn <<= (sal_Int16) -1;
  99                     break;
 100                 case BASEPROPERTY_TEXT:
 101                    break;
 102                 case BASEPROPERTY_BORDER:
 103                     aReturn <<= (sal_Int16) 2;              // No Border
 104                     break;
 105                 case BASEPROPERTY_DEFAULTCONTROL:
 106                     aReturn <<= ::rtl::OUString( ::rtl::OUString::createFromAscii( szServiceName_UnoControlRoadmap ) );
 107                     break;
 108             default : aReturn = UnoControlRoadmapModel_Base::ImplGetDefaultValue( nPropId ); break;
 109         }
 110
 111         return aReturn;
 112     }
 113
 114
 115     Reference< XInterface > SAL_CALL UnoControlRoadmapModel::createInstance(  ) throw (Exception, ::com::sun::star::uno::RuntimeException)
 116     {
 117         ORoadmapEntry* pRoadmapItem = new ORoadmapEntry();
 118         Reference< XInterface > xNewRoadmapItem = (::cppu::OWeakObject*)pRoadmapItem;
 119         return xNewRoadmapItem;
 120     }
 121
 122
 123     Reference< XInterface > SAL_CALL UnoControlRoadmapModel::createInstanceWithArguments( const Sequence< Any >& /*aArguments*/ ) throw (Exception, RuntimeException)
 124     {
 125         // Todo: implementation of the arguments handling
 126         ORoadmapEntry* pRoadmapItem = new ORoadmapEntry();
 127         Reference< XInterface > xNewRoadmapItem = (::cppu::OWeakObject*)pRoadmapItem;
 128         return xNewRoadmapItem;
 129     }
 130
 131
 132  IMPLEMENT_FORWARD_XTYPEPROVIDER2( UnoControlRoadmapModel, UnoControlRoadmapModel_Base, UnoControlRoadmapModel_IBase )
 133
 134
 135     // -------------------------------------------------------------------
 136     ::com::sun::star::uno::Any  SAL_CALL UnoControlRoadmapModel::queryAggregation( const ::com::sun::star::uno::Type & rType ) throw(::com::sun::star::uno::RuntimeException)
 137     {
 138         Any aRet = UnoControlRoadmapModel_Base::queryAggregation( rType );
 139         if ( !aRet.hasValue() )
 140             aRet = UnoControlRoadmapModel_IBase::queryInterface( rType );
 141          return aRet;
 142     }
 143
 144
 145     // -------------------------------------------------------------------
 146     ::cppu::IPropertyArrayHelper& UnoControlRoadmapModel::getInfoHelper()
 147     {
 148         static UnoPropertyArrayHelper* pHelper = NULL;
 149         if ( !pHelper )
 150         {
 151             Sequence<sal_Int32> aIDs = ImplGetPropertyIds();
 152             pHelper = new UnoPropertyArrayHelper( aIDs );
 153         }
 154         return *pHelper;
 155     }
 156
 157
 158     // beans::XMultiPropertySet
 159     // -------------------------------------------------------------------
 160     Reference< XPropertySetInfo > UnoControlRoadmapModel::getPropertySetInfo(  ) throw(RuntimeException)
 161     {
 162         static Reference< XPropertySetInfo > xInfo( createPropertySetInfo( getInfoHelper() ) );
 163         return xInfo;
 164     }
 165
 166
 167     sal_Int32 SAL_CALL UnoControlRoadmapModel::getCount() throw(RuntimeException)
 168     {
 169         return maRoadmapItems.size();
 170     }
 171
 172     Any SAL_CALL UnoControlRoadmapModel::getByIndex( sal_Int32 Index ) throw (IndexOutOfBoundsException, WrappedTargetException, RuntimeException )
 173     {
 174         if (( Index >= (sal_Int32)maRoadmapItems.size()) || (Index < 0))
 175             lcl_throwIndexOutOfBoundsException( );
 176         Any aAny;
 177         aAny = makeAny( maRoadmapItems.at( Index ));
 178         return aAny;
 179     }
 180
 181
 182
 183     void UnoControlRoadmapModel::MakeRMItemValidation( sal_Int32 Index, Reference< XInterface > xRoadmapItem )
 184     {
 185         if ((Index > (sal_Int32)maRoadmapItems.size()) || ( Index < 0 ) )
 186             lcl_throwIndexOutOfBoundsException( );
 187         if ( !xRoadmapItem.is() )
 188             lcl_throwIllegalArgumentException();
 189         Reference< XServiceInfo > xServiceInfo( xRoadmapItem, UNO_QUERY );
 190         sal_Bool bIsRoadmapItem = xServiceInfo->supportsService( ::rtl::OUString("com.sun.star.awt.RoadmapItem") );
 191         if ( !bIsRoadmapItem )
 192             lcl_throwIllegalArgumentException();
 193     }
 194
 195
 196     void UnoControlRoadmapModel::SetRMItemDefaultProperties( const sal_Int32 , Reference< XInterface > xRoadmapItem)
 197     {
 198         Any aAny;
 199         Reference< XPropertySet > xPropertySet( xRoadmapItem, UNO_QUERY );
 200         Reference< XPropertySet > xProps( xRoadmapItem, UNO_QUERY );
 201         if ( xProps.is() )
 202         {
 203             sal_Int32 LocID = 0;
 204             Any aValue = xPropertySet->getPropertyValue( ::rtl::OUString("ID") );
 205             aValue >>= LocID;
 206             if (LocID < 0)              // index may not be smaller than zero
 207             {
 208                 aAny <<= GetUniqueID();
 209                 xPropertySet->setPropertyValue( ::rtl::OUString("ID"), aAny );
 210             }
 211         }
 212     }
 213
 214
 215 // The performance of this method could certainly be improved.
 216 // As long as only vectors with up to 10 elements are
 217 // involved it should be sufficient
 218        sal_Int32 UnoControlRoadmapModel::GetUniqueID()
 219       {
 220           Any aAny;
 221           sal_Bool bIncrement = sal_True;
 222           sal_Int32 CurID = 0;
 223           sal_Int32 n_CurItemID = 0;
 224           Reference< XInterface > CurRoadmapItem;
 225           while ( bIncrement )
 226           {
 227               bIncrement = sal_False;
 228               for ( RoadmapItemHolderList::iterator i = maRoadmapItems.begin(); i < maRoadmapItems.end(); ++i )
 229               {
 230                 CurRoadmapItem = *i;
 231                 Reference< XPropertySet > xPropertySet( CurRoadmapItem, UNO_QUERY );
 232                 aAny = xPropertySet->getPropertyValue( ::rtl::OUString("ID") );
 233                 aAny >>= n_CurItemID;
 234                 if (n_CurItemID == CurID)
 235                 {
 236                     bIncrement = sal_True;
 237                     CurID++;
 238                     break;
 239                 }
 240             }
 241         }
 242         return CurID;
 243     }
 244
 245
 246     ContainerEvent UnoControlRoadmapModel::GetContainerEvent(sal_Int32 Index, Reference< XInterface > xRoadmapItem)
 247     {
 248         ContainerEvent aEvent;
 249         aEvent.Source = *this;
 250         aEvent.Element <<= xRoadmapItem;
 251         aEvent.Accessor = makeAny(Index);
 252         return aEvent;
 253     }
 254
 255
 256     sal_Int16 UnoControlRoadmapModel::GetCurrentItemID( Reference< XPropertySet > xPropertySet )
 257     {
 258         Any aAny = xPropertySet->getPropertyValue( GetPropertyName( BASEPROPERTY_CURRENTITEMID ) );
 259         sal_Int16 n_CurrentItemID = 0;
 260         aAny >>= n_CurrentItemID;
 261         return n_CurrentItemID;
 262     }
 263
 264
 265     void SAL_CALL UnoControlRoadmapModel::insertByIndex( const sal_Int32 Index, const Any& _Element)
 266                                     throw (IllegalArgumentException, IndexOutOfBoundsException, WrappedTargetException, RuntimeException )
 267     {
 268         if ( ( Index >= ( (sal_Int32)maRoadmapItems.size() + 1 ) ) || (Index < 0))
 269             lcl_throwIndexOutOfBoundsException( );
 270         Reference< XInterface > xRoadmapItem;
 271         _Element >>= xRoadmapItem;
 272         MakeRMItemValidation( Index, xRoadmapItem);
 273         SetRMItemDefaultProperties( Index, xRoadmapItem );
 274         maRoadmapItems.insert( maRoadmapItems.begin() + Index, xRoadmapItem);
 275         ContainerEvent aEvent = GetContainerEvent(Index, xRoadmapItem);
 276         maContainerListeners.elementInserted( aEvent );
 277         Reference< XPropertySet > xPropertySet( (XAggregation*) (::cppu::OWeakAggObject*)this, UNO_QUERY );
 278         sal_Int16 n_CurrentItemID = GetCurrentItemID( xPropertySet );
 279         if ( Index <= n_CurrentItemID )
 280         {
 281             Any aAny;
 282             aAny <<= ( sal_Int16 ) ( n_CurrentItemID + 1 );
 283             xPropertySet->setPropertyValue( GetPropertyName( BASEPROPERTY_CURRENTITEMID ), aAny );
 284         }
 285     }
 286
 287
 288
 289     void SAL_CALL UnoControlRoadmapModel::removeByIndex( sal_Int32 Index)
 290                                                 throw    (IndexOutOfBoundsException, WrappedTargetException, RuntimeException )
 291     {
 292         if (( Index > (sal_Int32)maRoadmapItems.size()) || (Index < 0))
 293             lcl_throwIndexOutOfBoundsException( );
 294         Reference< XInterface > xRoadmapItem;
 295         maRoadmapItems.erase( maRoadmapItems.begin() + Index );
 296         ContainerEvent aEvent = GetContainerEvent(Index, xRoadmapItem);
 297         maContainerListeners.elementRemoved( aEvent );
 298         Reference< XPropertySet > xPropertySet( (XAggregation*) (::cppu::OWeakAggObject*)this, UNO_QUERY );
 299         sal_Int16 n_CurrentItemID = GetCurrentItemID( xPropertySet );
 300         Any aAny;
 301         if ( Index <= n_CurrentItemID )
 302         {
 303             if ( n_CurrentItemID >= (sal_Int32)maRoadmapItems.size() )
 304             {
 305                 n_CurrentItemID = sal::static_int_cast< sal_Int16 >(
 306                     maRoadmapItems.size()-1);
 307                 if ( n_CurrentItemID < 0 )
 308                     return;
 309                 aAny <<= n_CurrentItemID;
 310             }
 311             else if (Index == n_CurrentItemID)
 312                 aAny <<= ( sal_Int16 ) -1;
 313             else if( Index < n_CurrentItemID)
 314                 aAny <<= ( sal_Int16 ) ( n_CurrentItemID - 1 );
 315             xPropertySet->setPropertyValue( GetPropertyName( BASEPROPERTY_CURRENTITEMID ), aAny );
 316         }
 317     }
 318
 319
 320     void SAL_CALL UnoControlRoadmapModel::replaceByIndex( const sal_Int32 Index, const Any& _Element)
 321                                 throw (IllegalArgumentException, IndexOutOfBoundsException, WrappedTargetException, RuntimeException )
 322     {
 323         Reference< XInterface > xRoadmapItem;
 324         _Element >>= xRoadmapItem;
 325         MakeRMItemValidation( Index, xRoadmapItem);
 326         SetRMItemDefaultProperties( Index, xRoadmapItem );
 327         maRoadmapItems.erase( maRoadmapItems.begin() + Index );
 328         maRoadmapItems.insert( maRoadmapItems.begin() + Index, xRoadmapItem);        //push_back( xRoadmapItem );
 329         ContainerEvent aEvent = GetContainerEvent(Index, xRoadmapItem);
 330         maContainerListeners.elementReplaced( aEvent );
 331     }
 332
 333
 334     Type SAL_CALL UnoControlRoadmapModel::getElementType() throw(RuntimeException)
 335     {
 336         Type aType = getCppuType( ( Reference< XPropertySet>* ) NULL );
 337         return aType;
 338     }
 339
 340
 341     sal_Bool SAL_CALL UnoControlRoadmapModel::hasElements() throw(RuntimeException)
 342     {
 343         return !maRoadmapItems.empty();
 344     }
 345
 346
 347     void SAL_CALL UnoControlRoadmapModel::addContainerListener( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XContainerListener >& xListener ) throw (::com::sun::star::uno::RuntimeException)
 348     {
 349         maContainerListeners.addInterface( xListener );
 350     }
 351
 352     void SAL_CALL UnoControlRoadmapModel::removeContainerListener( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XContainerListener >& xListener ) throw (::com::sun::star::uno::RuntimeException)
 353     {
 354         maContainerListeners.removeInterface( xListener );
 355     }
 356
 357     // ===================================================================
 358     // = UnoRoadmapControl
 359     // ===================================================================
 360     // -------------------------------------------------------------------
 361     UnoRoadmapControl::UnoRoadmapControl( const Reference< XMultiServiceFactory >& i_factory )
 362         :UnoControlRoadmap_Base( i_factory )
 363         ,maItemListeners( *this )
 364     {
 365     }
 366
 367 IMPLEMENT_FORWARD_XTYPEPROVIDER2( UnoRoadmapControl, UnoControlRoadmap_Base, UnoControlRoadmap_IBase )
 368 IMPLEMENT_FORWARD_XINTERFACE2( UnoRoadmapControl, UnoControlRoadmap_Base, UnoControlRoadmap_IBase )
 369
 370
 371 sal_Bool SAL_CALL UnoRoadmapControl::setModel(const Reference< XControlModel >& _rModel) throw ( RuntimeException )
 372     {
 373
 374
 375            Reference< XContainer > xC( getModel(), UNO_QUERY );
 376         if ( xC.is() )
 377             xC->removeContainerListener( this );
 378
 379         sal_Bool bReturn = UnoControlBase::setModel( _rModel );
 380
 381         xC = xC.query( getModel());
 382         if ( xC.is() )
 383             xC->addContainerListener( this );
 384
 385         return bReturn;
 386     }
 387
 388
 389     // -------------------------------------------------------------------
 390     ::rtl::OUString UnoRoadmapControl::GetComponentServiceName()
 391     {
 392         return ::rtl::OUString("Roadmap");
 393     }
 394
 395
 396
 397     void UnoRoadmapControl::dispose() throw(RuntimeException)
 398     {
 399         EventObject aEvt;
 400         aEvt.Source = (::cppu::OWeakObject*)this;
 401         maItemListeners.disposeAndClear( aEvt );
 402         UnoControl::dispose();
 403     }
 404
 405
 406
 407 void UnoRoadmapControl::elementInserted( const ContainerEvent& rEvent )throw(RuntimeException)
 408 {
 409     Reference< XInterface > xRoadmapItem;
 410     rEvent.Element >>= xRoadmapItem;
 411     Reference< XPropertySet > xRoadmapPropertySet( xRoadmapItem, UNO_QUERY );
 412     if ( xRoadmapPropertySet.is() )
 413         xRoadmapPropertySet->addPropertyChangeListener( rtl::OUString(), this );
 414
 415     Reference< XContainerListener >  xPeer(getPeer(), UNO_QUERY);
 416     if ( xPeer.is() )
 417     {
 418         xPeer->elementInserted( rEvent );
 419         Reference < XPropertySet > xPropertySet( xPeer, UNO_QUERY );
 420         if ( xPropertySet.is() )
 421             xPropertySet->addPropertyChangeListener( rtl::OUString(), this );
 422     }
 423 }
 424
 425
 426 void UnoRoadmapControl::elementRemoved( const ContainerEvent& rEvent )throw(RuntimeException)
 427 {
 428     Reference< XContainerListener >  xPeer(getPeer(), UNO_QUERY);
 429     if ( xPeer.is() )
 430         xPeer->elementRemoved( rEvent );
 431     Reference< XInterface > xRoadmapItem;
 432     rEvent.Element >>= xRoadmapItem;
 433     Reference< XPropertySet > xPropertySet( xRoadmapItem, UNO_QUERY );
 434     if ( xPropertySet.is() )
 435         xPropertySet->removePropertyChangeListener( rtl::OUString(), this );
 436 }
 437
 438
 439 void UnoRoadmapControl::elementReplaced( const ContainerEvent& rEvent )throw(RuntimeException)
 440 {
 441     Reference< XContainerListener >  xPeer(getPeer(), UNO_QUERY);
 442     if ( xPeer.is() )
 443         xPeer->elementReplaced( rEvent );
 444 }
 445
 446
 447 void SAL_CALL UnoRoadmapControl::itemStateChanged( const ItemEvent& rEvent ) throw (RuntimeException)
 448 {
 449     sal_Int16 CurItemIndex = sal::static_int_cast< sal_Int16 >(rEvent.ItemId);
 450     Any aAny;
 451     aAny <<= CurItemIndex;
 452     Reference< XControlModel > xModel( getModel( ), UNO_QUERY );
 453     Reference< XPropertySet > xPropertySet( xModel, UNO_QUERY );
 454     xPropertySet->setPropertyValue( GetPropertyName( BASEPROPERTY_CURRENTITEMID ), aAny );
 455     if ( maItemListeners.getLength() )
 456         maItemListeners.itemStateChanged( rEvent );
 457 }
 458
 459
 460 void SAL_CALL UnoRoadmapControl::addItemListener( const Reference< XItemListener >& l ) throw (RuntimeException)
 461 {
 462     maItemListeners.addInterface( l );
 463     if( getPeer().is() && maItemListeners.getLength() == 1 )
 464     {
 465         Reference < XItemEventBroadcaster > xRoadmap( getPeer(), UNO_QUERY );
 466         xRoadmap->addItemListener( this );
 467     }
 468 }
 469
 470
 471 void SAL_CALL UnoRoadmapControl::removeItemListener( const Reference< XItemListener >& l ) throw (RuntimeException)
 472 {
 473     if( getPeer().is() && maItemListeners.getLength() == 1 )
 474     {
 475         Reference < XItemEventBroadcaster >  xRoadmap( getPeer(), UNO_QUERY );
 476         xRoadmap->removeItemListener( this );
 477     }
 478
 479     maItemListeners.removeInterface( l );
 480 }
 481
 482
 483 void SAL_CALL UnoRoadmapControl::propertyChange( const PropertyChangeEvent& evt ) throw (RuntimeException)
 484 {
 485     Reference< XPropertyChangeListener >  xPeer(getPeer(), UNO_QUERY);
 486     if ( xPeer.is() )
 487         xPeer->propertyChange( evt );
 488 }
 489
 490 }
 491
 492 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */