UnoControls/source/controls/statusindicator.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: statusindicator.cxx,v $
  10  * $Revision: 1.7 $
  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 //____________________________________________________________________________________________________________
  32 //      my own includes
  33 //____________________________________________________________________________________________________________
  34
  35 #include "statusindicator.hxx"
  36
  37 //____________________________________________________________________________________________________________
  38 //      includes of other projects
  39 //____________________________________________________________________________________________________________
  40 #include <com/sun/star/awt/InvalidateStyle.hpp>
  41 #include <com/sun/star/awt/WindowAttribute.hpp>
  42 #include <cppuhelper/typeprovider.hxx>
  43 #include <tools/debug.hxx>
  44
  45 //____________________________________________________________________________________________________________
  46 //      includes of my project
  47 //____________________________________________________________________________________________________________
  48 #include "progressbar.hxx"
  49
  50 //____________________________________________________________________________________________________________
  51 //      namespace
  52 //____________________________________________________________________________________________________________
  53
  54 using namespace ::cppu                                  ;
  55 using namespace ::osl                                   ;
  56 using namespace ::rtl                                   ;
  57 using namespace ::com::sun::star::uno   ;
  58 using namespace ::com::sun::star::lang  ;
  59 using namespace ::com::sun::star::awt   ;
  60 using namespace ::com::sun::star::task  ;
  61
  62 namespace unocontrols{
  63
  64 //____________________________________________________________________________________________________________
  65 //      construct/destruct
  66 //____________________________________________________________________________________________________________
  67
  68 StatusIndicator::StatusIndicator( const Reference< XMultiServiceFactory >& xFactory )
  69     : BaseContainerControl      ( xFactory      )
  70 {
  71     // Its not allowed to work with member in this method (refcounter !!!)
  72     // But with a HACK (++refcount) its "OK" :-(
  73     ++m_refCount ;
  74
  75     // Create instances for fixedtext and progress ...
  76     m_xText                     = Reference< XFixedText >       ( xFactory->createInstance( OUString::createFromAscii( FIXEDTEXT_SERVICENAME    ) ), UNO_QUERY );
  77     m_xProgressBar      = Reference< XProgressBar >     ( xFactory->createInstance( OUString::createFromAscii( SERVICENAME_PROGRESSBAR  ) ), UNO_QUERY );
  78     // ... cast controls to Reference< XControl > and set model ...
  79     // ( ProgressBar has no model !!! )
  80     Reference< XControl > xTextControl          ( m_xText               , UNO_QUERY );
  81     Reference< XControl > xProgressControl      ( m_xProgressBar, UNO_QUERY );
  82     xTextControl->setModel( Reference< XControlModel >( xFactory->createInstance( OUString::createFromAscii( FIXEDTEXT_MODELNAME ) ), UNO_QUERY ) );
  83     // ... and add controls to basecontainercontrol!
  84     addControl( OUString::createFromAscii( CONTROLNAME_TEXT                     ), xTextControl         );
  85     addControl( OUString::createFromAscii( CONTROLNAME_PROGRESSBAR      ), xProgressControl     );
  86     // FixedText make it automaticly visible by himself ... but not the progressbar !!!
  87     // it must be set explicitly
  88     Reference< XWindow > xProgressWindow( m_xProgressBar, UNO_QUERY );
  89     xProgressWindow->setVisible( sal_True );
  90     // Reset to defaults !!!
  91     // (progressbar take automaticly its own defaults)
  92     m_xText->setText( OUString::createFromAscii( DEFAULT_TEXT ) );
  93
  94     --m_refCount ;
  95 }
  96
  97 StatusIndicator::~StatusIndicator()
  98 {
  99     // Release all references
 100     m_xText                     = Reference< XFixedText >();
 101     m_xProgressBar      = Reference< XProgressBar >();
 102 }
 103
 104 //____________________________________________________________________________________________________________
 105 //      XInterface
 106 //____________________________________________________________________________________________________________
 107
 108 Any SAL_CALL StatusIndicator::queryInterface( const Type& rType ) throw( RuntimeException )
 109 {
 110     // Attention:
 111     //  Don't use mutex or guard in this method!!! Is a method of XInterface.
 112     Any aReturn ;
 113     Reference< XInterface > xDel = BaseContainerControl::impl_getDelegator();
 114     if ( xDel.is() )
 115     {
 116         // If an delegator exist, forward question to his queryInterface.
 117         // Delegator will ask his own queryAggregation!
 118         aReturn = xDel->queryInterface( rType );
 119     }
 120     else
 121     {
 122         // If an delegator unknown, forward question to own queryAggregation.
 123         aReturn = queryAggregation( rType );
 124     }
 125
 126     return aReturn ;
 127 }
 128
 129 //____________________________________________________________________________________________________________
 130 //      XInterface
 131 //____________________________________________________________________________________________________________
 132
 133 void SAL_CALL StatusIndicator::acquire() throw()
 134 {
 135     // Attention:
 136     //  Don't use mutex or guard in this method!!! Is a method of XInterface.
 137
 138     // Forward to baseclass
 139     BaseControl::acquire();
 140 }
 141
 142 //____________________________________________________________________________________________________________
 143 //      XInterface
 144 //____________________________________________________________________________________________________________
 145
 146 void SAL_CALL StatusIndicator::release() throw()
 147 {
 148     // Attention:
 149     //  Don't use mutex or guard in this method!!! Is a method of XInterface.
 150
 151     // Forward to baseclass
 152     BaseControl::release();
 153 }
 154
 155 //____________________________________________________________________________________________________________
 156 //      XTypeProvider
 157 //____________________________________________________________________________________________________________
 158
 159 Sequence< Type > SAL_CALL StatusIndicator::getTypes() throw( RuntimeException )
 160 {
 161     // Optimize this method !
 162     // We initialize a static variable only one time. And we don't must use a mutex at every call!
 163     // For the first call; pTypeCollection is NULL - for the second call pTypeCollection is different from NULL!
 164     static OTypeCollection* pTypeCollection = NULL ;
 165
 166     if ( pTypeCollection == NULL )
 167     {
 168         // Ready for multithreading; get global mutex for first call of this method only! see before
 169         MutexGuard aGuard( Mutex::getGlobalMutex() );
 170
 171         // Control these pointer again ... it can be, that another instance will be faster then these!
 172         if ( pTypeCollection == NULL )
 173         {
 174             // Create a static typecollection ...
 175             static OTypeCollection aTypeCollection      (       ::getCppuType(( const Reference< XLayoutConstrains      >*)NULL )       ,
 176                                                           ::getCppuType(( const Reference< XStatusIndicator     >*)NULL )       ,
 177                                                         BaseContainerControl::getTypes()
 178                                                     );
 179             // ... and set his address to static pointer!
 180             pTypeCollection = &aTypeCollection ;
 181         }
 182     }
 183
 184     return pTypeCollection->getTypes();
 185 }
 186
 187 //____________________________________________________________________________________________________________
 188 //      XAggregation
 189 //____________________________________________________________________________________________________________
 190
 191 Any SAL_CALL StatusIndicator::queryAggregation( const Type& aType ) throw( RuntimeException )
 192 {
 193     // Ask for my own supported interfaces ...
 194     // Attention: XTypeProvider and XInterface are supported by OComponentHelper!
 195     Any aReturn ( ::cppu::queryInterface(       aType                                                                           ,
 196                                                static_cast< XLayoutConstrains*  > ( this )      ,
 197                                                static_cast< XStatusIndicator*   > ( this )
 198                                         )
 199                 );
 200
 201     // If searched interface not supported by this class ...
 202     if ( aReturn.hasValue() == sal_False )
 203     {
 204         // ... ask baseclasses.
 205         aReturn = BaseControl::queryAggregation( aType );
 206     }
 207
 208     return aReturn ;
 209 }
 210
 211 //____________________________________________________________________________________________________________
 212 //      XStatusIndicator
 213 //____________________________________________________________________________________________________________
 214
 215 void SAL_CALL StatusIndicator::start( const OUString& sText, sal_Int32 nRange ) throw( RuntimeException )
 216 {
 217     // Ready for multithreading
 218     MutexGuard aGuard( m_aMutex );
 219
 220     // Initialize status controls with given values.
 221     m_xText->setText( sText );
 222     m_xProgressBar->setRange( 0, nRange );
 223     // force repaint ... fixedtext has changed !
 224     impl_recalcLayout ( WindowEvent(static_cast< OWeakObject* >(this),0,0,impl_getWidth(),impl_getHeight(),0,0,0,0) ) ;
 225 }
 226
 227 //____________________________________________________________________________________________________________
 228 //      XStatusIndicator
 229 //____________________________________________________________________________________________________________
 230
 231 void SAL_CALL StatusIndicator::end() throw( RuntimeException )
 232 {
 233     // Ready for multithreading
 234     MutexGuard aGuard( m_aMutex );
 235
 236     // Clear values of status controls.
 237     m_xText->setText( OUString() );
 238     m_xProgressBar->setValue( 0 );
 239     setVisible( sal_False );
 240 }
 241
 242 //____________________________________________________________________________________________________________
 243 //      XStatusIndicator
 244 //____________________________________________________________________________________________________________
 245
 246 void SAL_CALL StatusIndicator::setText( const OUString& sText ) throw( RuntimeException )
 247 {
 248     // Ready for multithreading
 249     MutexGuard aGuard( m_aMutex );
 250
 251     // Take text on right control
 252     m_xText->setText( sText );
 253 }
 254
 255 //____________________________________________________________________________________________________________
 256 //      XStatusIndicator
 257 //____________________________________________________________________________________________________________
 258
 259 void SAL_CALL StatusIndicator::setValue( sal_Int32 nValue ) throw( RuntimeException )
 260 {
 261     // Ready for multithreading
 262     MutexGuard aGuard( m_aMutex );
 263
 264     // Take value on right control
 265     m_xProgressBar->setValue( nValue );
 266 }
 267
 268 //____________________________________________________________________________________________________________
 269 //      XStatusIndicator
 270 //____________________________________________________________________________________________________________
 271
 272 void SAL_CALL StatusIndicator::reset() throw( RuntimeException )
 273 {
 274     // Ready for multithreading
 275     MutexGuard aGuard( m_aMutex );
 276
 277     // Clear values of status controls.
 278     // (Don't hide the window! User will reset current values ... but he will not finish using of indicator!)
 279     m_xText->setText( OUString() );
 280     m_xProgressBar->setValue( 0 );
 281 }
 282
 283 //____________________________________________________________________________________________________________
 284 //      XLayoutConstrains
 285 //____________________________________________________________________________________________________________
 286
 287 Size SAL_CALL StatusIndicator::getMinimumSize () throw( RuntimeException )
 288 {
 289     return Size (DEFAULT_WIDTH, DEFAULT_HEIGHT) ;
 290 }
 291
 292 //____________________________________________________________________________________________________________
 293 //      XLayoutConstrains
 294 //____________________________________________________________________________________________________________
 295
 296 Size SAL_CALL StatusIndicator::getPreferredSize () throw( RuntimeException )
 297 {
 298     // Ready for multithreading
 299     ClearableMutexGuard aGuard ( m_aMutex ) ;
 300
 301     // get information about required place of child controls
 302     Reference< XLayoutConstrains >      xTextLayout     ( m_xText, UNO_QUERY );
 303     Size                                                        aTextSize       = xTextLayout->getPreferredSize();
 304
 305     aGuard.clear () ;
 306
 307     // calc preferred size of status indicator
 308     sal_Int32 nWidth  = impl_getWidth()                 ;
 309     sal_Int32 nHeight = (2*FREEBORDER)+aTextSize.Height ;
 310
 311     // norm to minimum
 312     if ( nWidth<DEFAULT_WIDTH )
 313     {
 314         nWidth = DEFAULT_WIDTH ;
 315     }
 316     if ( nHeight<DEFAULT_HEIGHT )
 317     {
 318         nHeight = DEFAULT_HEIGHT ;
 319     }
 320
 321     // return to caller
 322     return Size ( nWidth, nHeight ) ;
 323 }
 324
 325 //____________________________________________________________________________________________________________
 326 //      XLayoutConstrains
 327 //____________________________________________________________________________________________________________
 328
 329 Size SAL_CALL StatusIndicator::calcAdjustedSize ( const Size& /*rNewSize*/ ) throw( RuntimeException )
 330 {
 331     return getPreferredSize () ;
 332 }
 333
 334 //____________________________________________________________________________________________________________
 335 //      XControl
 336 //____________________________________________________________________________________________________________
 337
 338 void SAL_CALL StatusIndicator::createPeer ( const Reference< XToolkit > & rToolkit, const Reference< XWindowPeer > & rParent    ) throw( RuntimeException )
 339 {
 340     if( getPeer().is() == sal_False )
 341     {
 342         BaseContainerControl::createPeer( rToolkit, rParent );
 343
 344         // If user forget to call "setPosSize()", we have still a correct size.
 345         // And a "MinimumSize" IS A "MinimumSize"!
 346         // We change not the position of control at this point.
 347         Size aDefaultSize = getMinimumSize () ;
 348         setPosSize ( 0, 0, aDefaultSize.Width, aDefaultSize.Height, PosSize::SIZE ) ;
 349     }
 350 }
 351
 352 //____________________________________________________________________________________________________________
 353 //      XControl
 354 //____________________________________________________________________________________________________________
 355
 356 sal_Bool SAL_CALL StatusIndicator::setModel ( const Reference< XControlModel > & /*rModel*/ ) throw( RuntimeException )
 357 {
 358     // We have no model.
 359     return sal_False ;
 360 }
 361
 362 //____________________________________________________________________________________________________________
 363 //      XControl
 364 //____________________________________________________________________________________________________________
 365
 366 Reference< XControlModel > SAL_CALL StatusIndicator::getModel () throw( RuntimeException )
 367 {
 368     // We have no model.
 369     // return (XControlModel*)this ;
 370     return Reference< XControlModel >  () ;
 371 }
 372
 373 //____________________________________________________________________________________________________________
 374 //      XComponent
 375 //____________________________________________________________________________________________________________
 376
 377 void SAL_CALL StatusIndicator::dispose () throw( RuntimeException )
 378 {
 379     // Ready for multithreading
 380     MutexGuard aGuard ( m_aMutex ) ;
 381
 382     // "removeControl()" control the state of a reference
 383     Reference< XControl >  xTextControl         ( m_xText               , UNO_QUERY );
 384     Reference< XControl >  xProgressControl     ( m_xProgressBar, UNO_QUERY );
 385
 386     removeControl( xTextControl         );
 387     removeControl( xProgressControl     );
 388
 389     // do'nt use "...->clear ()" or "... = XFixedText ()"
 390     // when other hold a reference at this object !!!
 391     xTextControl->dispose();
 392     xProgressControl->dispose();
 393     BaseContainerControl::dispose();
 394 }
 395
 396 //____________________________________________________________________________________________________________
 397 //      XWindow
 398 //____________________________________________________________________________________________________________
 399
 400 void SAL_CALL StatusIndicator::setPosSize ( sal_Int32 nX, sal_Int32 nY, sal_Int32 nWidth, sal_Int32 nHeight, sal_Int16 nFlags ) throw( RuntimeException )
 401 {
 402     Rectangle   aBasePosSize = getPosSize () ;
 403     BaseContainerControl::setPosSize (nX, nY, nWidth, nHeight, nFlags) ;
 404
 405     // if position or size changed
 406     if (
 407         ( nWidth  != aBasePosSize.Width ) ||
 408         ( nHeight != aBasePosSize.Height)
 409        )
 410     {
 411         // calc new layout for controls
 412         impl_recalcLayout ( WindowEvent(static_cast< OWeakObject* >(this),0,0,nWidth,nHeight,0,0,0,0) ) ;
 413         // clear background (!)
 414         // [Childs was repainted in "recalcLayout" by setPosSize() automaticly!]
 415         getPeer()->invalidate(2);
 416         // and repaint the control
 417         impl_paint ( 0, 0, impl_getGraphicsPeer() ) ;
 418     }
 419 }
 420
 421 //____________________________________________________________________________________________________________
 422 //      impl but public method to register service
 423 //____________________________________________________________________________________________________________
 424
 425 const Sequence< OUString > StatusIndicator::impl_getStaticSupportedServiceNames()
 426 {
 427     MutexGuard aGuard( Mutex::getGlobalMutex() );
 428     Sequence< OUString > seqServiceNames( 1 );
 429     seqServiceNames.getArray() [0] = OUString::createFromAscii( SERVICENAME_STATUSINDICATOR );
 430     return seqServiceNames ;
 431 }
 432
 433 //____________________________________________________________________________________________________________
 434 //      impl but public method to register service
 435 //____________________________________________________________________________________________________________
 436
 437 const OUString StatusIndicator::impl_getStaticImplementationName()
 438 {
 439     return OUString::createFromAscii( IMPLEMENTATIONNAME_STATUSINDICATOR );
 440 }
 441
 442 //____________________________________________________________________________________________________________
 443 //      protected method
 444 //____________________________________________________________________________________________________________
 445
 446 WindowDescriptor* StatusIndicator::impl_getWindowDescriptor( const Reference< XWindowPeer >& xParentPeer )
 447 {
 448     // - used from "createPeer()" to set the values of an ::com::sun::star::awt::WindowDescriptor !!!
 449     // - if you will change the descriptor-values, you must override this virtuell function
 450     // - the caller must release the memory for this dynamical descriptor !!!
 451
 452     WindowDescriptor* pDescriptor = new WindowDescriptor ;
 453
 454     pDescriptor->Type                           =       WindowClass_SIMPLE                                                              ;
 455     pDescriptor->WindowServiceName      =       OUString::createFromAscii( "floatingwindow" )   ;
 456     pDescriptor->ParentIndex            =       -1                                                                                              ;
 457     pDescriptor->Parent                         =       xParentPeer                                                                             ;
 458     pDescriptor->Bounds                         =       getPosSize ()                                                                   ;
 459
 460     return pDescriptor ;
 461 }
 462
 463 //____________________________________________________________________________________________________________
 464 //      protected method
 465 //____________________________________________________________________________________________________________
 466
 467 void StatusIndicator::impl_paint ( sal_Int32 nX, sal_Int32 nY, const Reference< XGraphics > & rGraphics )
 468 {
 469     // This paint method ist not buffered !!
 470     // Every request paint the completely control. ( but only, if peer exist )
 471      if ( rGraphics.is () )
 472     {
 473         MutexGuard      aGuard (m_aMutex) ;
 474
 475         // background = gray
 476         Reference< XWindowPeer > xPeer( impl_getPeerWindow(), UNO_QUERY );
 477         if( xPeer.is() == sal_True )
 478             xPeer->setBackground( BACKGROUNDCOLOR );
 479
 480         // FixedText background = gray
 481         Reference< XControl > xTextControl( m_xText, UNO_QUERY );
 482         xPeer = xTextControl->getPeer();
 483         if( xPeer.is() == sal_True )
 484             xPeer->setBackground( BACKGROUNDCOLOR );
 485
 486         // Progress background = gray
 487         xPeer = Reference< XWindowPeer >( m_xProgressBar, UNO_QUERY );
 488         if( xPeer.is() == sal_True )
 489             xPeer->setBackground( BACKGROUNDCOLOR );
 490
 491         // paint shadow border
 492         rGraphics->setLineColor ( LINECOLOR_BRIGHT                          );
 493         rGraphics->drawLine     ( nX, nY, impl_getWidth(), nY               );
 494         rGraphics->drawLine     ( nX, nY, nX             , impl_getHeight() );
 495
 496         rGraphics->setLineColor ( LINECOLOR_SHADOW                                                              );
 497         rGraphics->drawLine     ( impl_getWidth()-1, impl_getHeight()-1, impl_getWidth()-1, nY                  );
 498         rGraphics->drawLine     ( impl_getWidth()-1, impl_getHeight()-1, nX               , impl_getHeight()-1  );
 499     }
 500 }
 501
 502 //____________________________________________________________________________________________________________
 503 //      protected method
 504 //____________________________________________________________________________________________________________
 505
 506 void StatusIndicator::impl_recalcLayout ( const WindowEvent& aEvent )
 507 {
 508     sal_Int32   nX_ProgressBar                  ;
 509     sal_Int32   nY_ProgressBar                  ;
 510     sal_Int32   nWidth_ProgressBar              ;
 511     sal_Int32   nHeight_ProgressBar             ;
 512     sal_Int32   nX_Text                                 ;
 513     sal_Int32   nY_Text                                 ;
 514     sal_Int32   nWidth_Text                             ;
 515     sal_Int32   nHeight_Text                    ;
 516
 517     // Ready for multithreading
 518     MutexGuard aGuard ( m_aMutex ) ;
 519
 520     // get information about required place of child controls
 521     Size                                                        aWindowSize             ( aEvent.Width, aEvent.Height );
 522     Reference< XLayoutConstrains >      xTextLayout             ( m_xText, UNO_QUERY );
 523     Size                                                        aTextSize               = xTextLayout->getPreferredSize();
 524
 525     if( aWindowSize.Width < DEFAULT_WIDTH )
 526     {
 527         aWindowSize.Width = DEFAULT_WIDTH;
 528     }
 529     if( aWindowSize.Height < DEFAULT_HEIGHT )
 530     {
 531         aWindowSize.Height = DEFAULT_HEIGHT;
 532     }
 533
 534     // calc position and size of child controls
 535     nX_Text             = FREEBORDER                                    ;
 536     nY_Text             = FREEBORDER                                    ;
 537     nWidth_Text         = aTextSize.Width                               ;
 538     nHeight_Text        = aTextSize.Height                              ;
 539
 540     nX_ProgressBar      = nX_Text+nWidth_Text+FREEBORDER                ;
 541     nY_ProgressBar      = nY_Text                                       ;
 542     nWidth_ProgressBar  = aWindowSize.Width-nWidth_Text-(3*FREEBORDER)  ;
 543     nHeight_ProgressBar = nHeight_Text                                  ;
 544
 545     // Set new position and size on all controls
 546     Reference< XWindow >  xTextWindow           ( m_xText               , UNO_QUERY );
 547     Reference< XWindow >  xProgressWindow       ( m_xProgressBar, UNO_QUERY );
 548
 549     xTextWindow->setPosSize             ( nX_Text               , nY_Text               , nWidth_Text           , nHeight_Text                  , 15 ) ;
 550     xProgressWindow->setPosSize ( nX_ProgressBar, nY_ProgressBar, nWidth_ProgressBar, nHeight_ProgressBar       , 15 ) ;
 551 }
 552
 553 //____________________________________________________________________________________________________________
 554 //      debug methods
 555 //____________________________________________________________________________________________________________
 556
 557 #if OSL_DEBUG_LEVEL > 1
 558
 559 #endif  // #if OSL_DEBUG_LEVEL > 1
 560
 561 }       // namespace unocontrols