extensions/source/propctrlr/composeduiupdate.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: composeduiupdate.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_extensions.hxx"
  33 #include "composeduiupdate.hxx"
  34
  35 /** === begin UNO includes === **/
  36 #include <com/sun/star/inspection/XObjectInspectorUI.hpp>
  37 #include <com/sun/star/lang/DisposedException.hpp>
  38 #include <com/sun/star/inspection/PropertyLineElement.hpp>
  39 /** === end UNO includes === **/
  40 #include <osl/mutex.hxx>
  41 #include <rtl/ref.hxx>
  42
  43 #include <algorithm>
  44
  45 //........................................................................
  46 namespace pcr
  47 {
  48 //........................................................................
  49
  50     /** === begin UNO using === **/
  51     using ::com::sun::star::uno::Exception;
  52     using ::com::sun::star::lang::DisposedException;
  53     using ::com::sun::star::lang::NullPointerException;
  54     using ::com::sun::star::inspection::XPropertyHandler;
  55     using ::com::sun::star::uno::Reference;
  56     using ::com::sun::star::inspection::XObjectInspectorUI;
  57     using ::com::sun::star::inspection::XPropertyControl;
  58     using ::com::sun::star::uno::RuntimeException;
  59     using ::com::sun::star::lang::NoSupportException;
  60     using ::com::sun::star::inspection::XPropertyControlObserver;
  61     /** === end UNO using === **/
  62
  63     namespace PropertyLineElement = ::com::sun::star::inspection::PropertyLineElement;
  64
  65     //====================================================================
  66     //= helper
  67     //====================================================================
  68     namespace
  69     {
  70         struct HandlerLess : public ::std::binary_function  <   Reference< XPropertyHandler >
  71                                                             ,   Reference< XPropertyHandler >
  72                                                             ,   bool
  73                                                             >
  74         {
  75             bool operator()( const Reference< XPropertyHandler >& lhs, const Reference< XPropertyHandler >& rhs) const
  76             {
  77                 return lhs.get() < rhs.get();
  78             }
  79         };
  80
  81         //================================================================
  82         typedef ::std::set< ::rtl::OUString >       StringBag;
  83         typedef ::std::map< sal_Int16, StringBag >  MapIntToStringBag;
  84     }
  85
  86     //====================================================================
  87     //= callbacks for CachedInspectorUI
  88     //====================================================================
  89     typedef void (ComposedPropertyUIUpdate::*FNotifySingleUIChange)();
  90
  91     //====================================================================
  92     //= CachedInspectorUI
  93     //====================================================================
  94     typedef ::cppu::WeakImplHelper1 <   ::com::sun::star::inspection::XObjectInspectorUI
  95                                     >   CachedInspectorUI_Base;
  96     struct CachedInspectorUI : public CachedInspectorUI_Base
  97     {
  98     private:
  99         ::osl::Mutex            m_aMutex;
 100         oslInterlockedCount     m_refCount;
 101         bool                    m_bDisposed;
 102         ComposedPropertyUIUpdate&
 103                                 m_rMaster;
 104         FNotifySingleUIChange   m_pUIChangeNotification;
 105
 106         // enablePropertyUI cache
 107         StringBag               aEnabledProperties;
 108         StringBag               aDisabledProperties;
 109
 110         // show/hidePropertyUI cache
 111         StringBag               aShownProperties;
 112         StringBag               aHiddenProperties;
 113
 114         // rebuildPropertyUI cache
 115         StringBag               aRebuiltProperties;
 116
 117         // showCategory cache
 118         StringBag               aShownCategories;
 119         StringBag               aHiddenCategories;
 120
 121         // enablePropertyUIElements cache
 122         MapIntToStringBag       aEnabledElements;
 123         MapIntToStringBag       aDisabledElements;
 124
 125     public:
 126         typedef StringBag& (CachedInspectorUI::*FGetStringBag)();
 127
 128         // enablePropertyUI cache
 129         StringBag&  getEnabledProperties()          { return aEnabledProperties; }
 130         StringBag&  getDisabledProperties()         { return aDisabledProperties; }
 131
 132         // show/hidePropertyUI cache
 133         StringBag&  getShownProperties()            { return aShownProperties; }
 134         StringBag&  getHiddenProperties()           { return aHiddenProperties; }
 135
 136         // rebuildPropertyUI cache
 137         StringBag&  getRebuiltProperties()          { return aRebuiltProperties; }
 138
 139         // showCategory cache
 140         StringBag&  getShownCategories()            { return aShownCategories; }
 141         StringBag&  getHiddenCategories()           { return aHiddenCategories; }
 142
 143         // enablePropertyUIElements
 144         StringBag&  getEnabledInputControls()       { return aEnabledElements[ PropertyLineElement::InputControl ]; }
 145         StringBag&  getDisabledInputControls()      { return aDisabledElements[ PropertyLineElement::InputControl ]; }
 146         StringBag&  getEnabledPrimaryButtons()      { return aEnabledElements[ PropertyLineElement::PrimaryButton ]; }
 147         StringBag&  getDisabledPrimaryButtons()     { return aDisabledElements[ PropertyLineElement::PrimaryButton ]; }
 148         StringBag&  getEnabledSecondaryButtons()    { return aEnabledElements[ PropertyLineElement::SecondaryButton ]; }
 149         StringBag&  getDisabledSecondaryButtons()   { return aDisabledElements[ PropertyLineElement::SecondaryButton ]; }
 150
 151     public:
 152         CachedInspectorUI( ComposedPropertyUIUpdate& _rMaster, FNotifySingleUIChange _pUIChangeNotification );
 153
 154         /// disposes the instance
 155         void dispose();
 156
 157         // XObjectInspectorUI overridables
 158         virtual void SAL_CALL enablePropertyUI( const ::rtl::OUString& _rPropertyName, ::sal_Bool _bEnable ) throw (RuntimeException);
 159         virtual void SAL_CALL enablePropertyUIElements( const ::rtl::OUString& _rPropertyName, ::sal_Int16 _nElements, ::sal_Bool _bEnable ) throw (RuntimeException);
 160         virtual void SAL_CALL rebuildPropertyUI( const ::rtl::OUString& _rPropertyName ) throw (RuntimeException);
 161         virtual void SAL_CALL showPropertyUI( const ::rtl::OUString& _rPropertyName ) throw (RuntimeException);
 162         virtual void SAL_CALL hidePropertyUI( const ::rtl::OUString& _rPropertyName ) throw (RuntimeException);
 163         virtual void SAL_CALL showCategory( const ::rtl::OUString& _rCategory, ::sal_Bool _bShow ) throw (RuntimeException);
 164         virtual Reference< XPropertyControl > SAL_CALL getPropertyControl( const ::rtl::OUString& _rPropertyName ) throw (RuntimeException);
 165         virtual void SAL_CALL registerControlObserver( const Reference< XPropertyControlObserver >& Observer ) throw (RuntimeException);
 166         virtual void SAL_CALL revokeControlObserver( const Reference< XPropertyControlObserver >& Observer ) throw (RuntimeException);
 167         virtual void SAL_CALL setHelpSectionText( const ::rtl::OUString& _HelpText ) throw (NoSupportException, RuntimeException);
 168
 169         // UNOCompatibleNonUNOReference overridables
 170         virtual void SAL_CALL acquire() throw();
 171         virtual void SAL_CALL release() throw();
 172
 173     protected:
 174         ~CachedInspectorUI();
 175
 176         /// determines whether the instance is already disposed
 177         inline bool isDisposed() const { return m_bDisposed; }
 178
 179         /// throws an exception if the component is already disposed
 180         void checkDisposed() const;
 181
 182     private:
 183         void    impl_markElementEnabledOrDisabled( const ::rtl::OUString& _rPropertyName, sal_Int16 _nElementIdOrZero, sal_Bool _bEnable );
 184
 185         /** calls <member>m_pUIChangeNotification</member> at <member>m_rMaster</member>
 186         */
 187         void    impl_notifySingleUIChange() const;
 188
 189     private:
 190         CachedInspectorUI( const CachedInspectorUI& );              // never implemented
 191         CachedInspectorUI& operator=( const CachedInspectorUI& );   // never implemented
 192
 193     private:
 194         class MethodGuard;
 195         friend class MethodGuard;
 196         class MethodGuard : public ::osl::MutexGuard
 197         {
 198         public:
 199             MethodGuard( CachedInspectorUI& rInstance )
 200                 : ::osl::MutexGuard( rInstance.m_aMutex )
 201             {
 202                 rInstance.checkDisposed();
 203             }
 204         };
 205     };
 206
 207     //----------------------------------------------------------------
 208     CachedInspectorUI::CachedInspectorUI( ComposedPropertyUIUpdate& _rMaster, FNotifySingleUIChange _pUIChangeNotification )
 209         :m_refCount( 0 )
 210         ,m_bDisposed( false )
 211         ,m_rMaster( _rMaster )
 212         ,m_pUIChangeNotification( _pUIChangeNotification )
 213     {
 214     }
 215
 216     //----------------------------------------------------------------
 217     CachedInspectorUI::~CachedInspectorUI()
 218     {
 219     }
 220
 221     //----------------------------------------------------------------
 222     void CachedInspectorUI::dispose()
 223     {
 224         ::osl::MutexGuard aGuard( m_aMutex );
 225         m_bDisposed = true;
 226
 227         clearContainer( aEnabledProperties );
 228         clearContainer( aDisabledProperties );
 229         clearContainer( aRebuiltProperties );
 230         clearContainer( aShownProperties );
 231         clearContainer( aHiddenProperties );
 232         clearContainer( aShownCategories );
 233         clearContainer( aHiddenCategories );
 234         clearContainer( aEnabledElements );
 235         clearContainer( aDisabledElements );
 236     }
 237
 238     //----------------------------------------------------------------
 239     void SAL_CALL CachedInspectorUI::acquire() throw()
 240     {
 241         osl_incrementInterlockedCount( &m_refCount );
 242     }
 243
 244     //----------------------------------------------------------------
 245     void SAL_CALL CachedInspectorUI::release() throw()
 246     {
 247         if ( 0 == osl_decrementInterlockedCount( &m_refCount ) )
 248             delete this;
 249     }
 250
 251
 252     //----------------------------------------------------------------
 253     void CachedInspectorUI::checkDisposed() const
 254     {
 255         if ( isDisposed() )
 256             throw DisposedException();
 257     }
 258
 259     //----------------------------------------------------------------
 260     namespace
 261     {
 262         void lcl_markStringKeyPositiveOrNegative( const ::rtl::OUString& _rKeyName, StringBag& _rPositives, StringBag& _rNegatives, sal_Bool _bMarkPositive )
 263         {
 264             if ( _bMarkPositive )
 265             {
 266                 _rPositives.insert( _rKeyName );
 267                 // if the same key has been remember as in the "negative" list before, clear this information, since it's overruled
 268                 _rNegatives.erase( _rKeyName );
 269             }
 270             else
 271                 _rNegatives.insert( _rKeyName );
 272         }
 273     }
 274
 275     //----------------------------------------------------------------
 276     void CachedInspectorUI::enablePropertyUI( const ::rtl::OUString& _rPropertyName, sal_Bool _bEnable ) throw (RuntimeException)
 277     {
 278         MethodGuard aGuard( *this );
 279         if ( !m_rMaster.shouldContinuePropertyHandling( _rPropertyName ) )
 280             return;
 281
 282         lcl_markStringKeyPositiveOrNegative( _rPropertyName, aEnabledProperties, aDisabledProperties, _bEnable );
 283         impl_notifySingleUIChange();
 284     }
 285
 286     //----------------------------------------------------------------
 287     void CachedInspectorUI::impl_markElementEnabledOrDisabled( const ::rtl::OUString& _rPropertyName, sal_Int16 _nElementIdOrZero, sal_Bool _bEnable )
 288     {
 289         if ( _nElementIdOrZero == 0 )
 290             return;
 291
 292         lcl_markStringKeyPositiveOrNegative(
 293             _rPropertyName,
 294             aEnabledElements[ _nElementIdOrZero ],
 295             aDisabledElements[ _nElementIdOrZero ],
 296             _bEnable
 297         );
 298     }
 299
 300     //----------------------------------------------------------------
 301     void CachedInspectorUI::impl_notifySingleUIChange() const
 302     {
 303         (m_rMaster.*m_pUIChangeNotification)();
 304     }
 305
 306     //----------------------------------------------------------------
 307     void CachedInspectorUI::enablePropertyUIElements( const ::rtl::OUString& _rPropertyName, sal_Int16 _nElements, sal_Bool _bEnable ) throw (RuntimeException)
 308     {
 309         MethodGuard aGuard( *this );
 310         if ( !m_rMaster.shouldContinuePropertyHandling( _rPropertyName ) )
 311             return;
 312
 313         impl_markElementEnabledOrDisabled( _rPropertyName, _nElements & PropertyLineElement::InputControl,    _bEnable );
 314         impl_markElementEnabledOrDisabled( _rPropertyName, _nElements & PropertyLineElement::PrimaryButton,   _bEnable );
 315         impl_markElementEnabledOrDisabled( _rPropertyName, _nElements & PropertyLineElement::SecondaryButton, _bEnable );
 316
 317         impl_notifySingleUIChange();
 318     }
 319
 320     //----------------------------------------------------------------
 321     void CachedInspectorUI::rebuildPropertyUI( const ::rtl::OUString& _rPropertyName ) throw (RuntimeException)
 322     {
 323         MethodGuard aGuard( *this );
 324         if ( !m_rMaster.shouldContinuePropertyHandling( _rPropertyName ) )
 325             return;
 326
 327         aRebuiltProperties.insert( _rPropertyName );
 328
 329         impl_notifySingleUIChange();
 330     }
 331
 332     //----------------------------------------------------------------
 333     void CachedInspectorUI::showPropertyUI( const ::rtl::OUString& _rPropertyName ) throw (RuntimeException)
 334     {
 335         MethodGuard aGuard( *this );
 336         if ( !m_rMaster.shouldContinuePropertyHandling( _rPropertyName ) )
 337             return;
 338
 339         aShownProperties.insert( _rPropertyName );
 340         // if the same category has been hidden before, clear this information, since it's overruled
 341         aHiddenProperties.erase( _rPropertyName );
 342
 343         impl_notifySingleUIChange();
 344     }
 345
 346     //----------------------------------------------------------------
 347     void CachedInspectorUI::hidePropertyUI( const ::rtl::OUString& _rPropertyName ) throw (RuntimeException)
 348     {
 349         MethodGuard aGuard( *this );
 350         if ( !m_rMaster.shouldContinuePropertyHandling( _rPropertyName ) )
 351             return;
 352
 353         aHiddenProperties.insert( _rPropertyName );
 354         impl_notifySingleUIChange();
 355     }
 356
 357     //----------------------------------------------------------------
 358     void CachedInspectorUI::showCategory( const ::rtl::OUString& _rCategory, sal_Bool _bShow ) throw (RuntimeException)
 359     {
 360         MethodGuard aGuard( *this );
 361
 362         lcl_markStringKeyPositiveOrNegative( _rCategory, aShownCategories, aHiddenCategories, _bShow );
 363         impl_notifySingleUIChange();
 364     }
 365
 366     //----------------------------------------------------------------
 367     Reference< XPropertyControl > SAL_CALL CachedInspectorUI::getPropertyControl( const ::rtl::OUString& _rPropertyName ) throw (RuntimeException)
 368     {
 369         MethodGuard aGuard( *this );
 370         if ( !m_rMaster.shouldContinuePropertyHandling( _rPropertyName ) )
 371             return Reference< XPropertyControl >();
 372
 373         return m_rMaster.getDelegatorUI()->getPropertyControl( _rPropertyName );
 374     }
 375
 376     //--------------------------------------------------------------------
 377     void SAL_CALL CachedInspectorUI::registerControlObserver( const Reference< XPropertyControlObserver >& _Observer ) throw (RuntimeException)
 378     {
 379         OSL_ENSURE( false, "CachedInspectorUI::registerControlObserver: not expected to be called!" );
 380             // CachedInspectorUI is used as context for the controls, and we don't expect them to
 381             // register listeners themself
 382         m_rMaster.getDelegatorUI()->registerControlObserver( _Observer );
 383     }
 384
 385     //--------------------------------------------------------------------
 386     void SAL_CALL CachedInspectorUI::revokeControlObserver( const Reference< XPropertyControlObserver >& _Observer ) throw (RuntimeException)
 387     {
 388         OSL_ENSURE( false, "CachedInspectorUI::revokeControlObserver: not expected to be called!" );
 389             // CachedInspectorUI is used as context for the controls, and we don't expect them to
 390             // register listeners themself
 391         m_rMaster.getDelegatorUI()->revokeControlObserver( _Observer );
 392     }
 393
 394     //----------------------------------------------------------------
 395     void SAL_CALL CachedInspectorUI::setHelpSectionText( const ::rtl::OUString& _HelpText ) throw (NoSupportException, RuntimeException)
 396     {
 397         m_rMaster.getDelegatorUI()->setHelpSectionText( _HelpText );
 398     }
 399
 400     //====================================================================
 401     //= HandlerMap
 402     //====================================================================
 403     typedef ::std::map  <   Reference< XPropertyHandler >
 404                         ,   ::rtl::Reference< CachedInspectorUI >
 405                         ,   HandlerLess
 406                         >   ImplMapHandlerToUI;
 407     struct MapHandlerToUI
 408     {
 409         ImplMapHandlerToUI aHandlers;
 410     };
 411
 412     //====================================================================
 413     //= ComposedPropertyUIUpdate
 414     //====================================================================
 415     //----------------------------------------------------------------
 416     ComposedPropertyUIUpdate::ComposedPropertyUIUpdate( const Reference< XObjectInspectorUI >& _rxDelegatorUI,
 417         IPropertyExistenceCheck* _pPropertyCheck )
 418         :m_pCollectedUIs( new MapHandlerToUI )
 419         ,m_xDelegatorUI( _rxDelegatorUI )
 420         ,m_nSuspendCounter( 0 )
 421         ,m_pPropertyCheck( _pPropertyCheck )
 422     {
 423         if ( !m_xDelegatorUI.is() )
 424             throw NullPointerException();
 425     }
 426
 427     //----------------------------------------------------------------
 428     ComposedPropertyUIUpdate::~ComposedPropertyUIUpdate( )
 429     {
 430     }
 431
 432     //----------------------------------------------------------------
 433     Reference< XObjectInspectorUI > ComposedPropertyUIUpdate::getUIForPropertyHandler( const Reference< XPropertyHandler >& _rxHandler )
 434     {
 435         impl_checkDisposed();
 436
 437         ::rtl::Reference< CachedInspectorUI >& rUI = m_pCollectedUIs->aHandlers[ _rxHandler ];
 438         if ( !rUI.is() )
 439             rUI = new CachedInspectorUI( *this, &ComposedPropertyUIUpdate::callback_inspectorUIChanged_throw );
 440         return rUI.get();
 441     }
 442
 443     //----------------------------------------------------------------
 444     namespace
 445     {
 446         //============================================================
 447         //= StringBagCollector
 448         //============================================================
 449         /** an STL-compatible structure which collects strings from a CachedInspectorUI instances
 450         */
 451         struct StringBagCollector : public ::std::unary_function< ImplMapHandlerToUI::value_type, void >
 452         {
 453         private:
 454             StringBag&                      m_rBag;
 455             CachedInspectorUI::FGetStringBag  m_pGetter;
 456
 457         public:
 458             StringBagCollector( StringBag& _rBag, CachedInspectorUI::FGetStringBag _pGetter ) :m_rBag( _rBag ), m_pGetter( _pGetter ) { }
 459
 460             void operator()( const ImplMapHandlerToUI::value_type& _rUI )
 461             {
 462                 StringBag& rBag( ((_rUI.second.get())->*m_pGetter)() );
 463                 m_rBag.insert( rBag.begin(), rBag.end() );
 464             }
 465
 466             static void collectAll( StringBag& _rAll, const ImplMapHandlerToUI& _rMap, CachedInspectorUI::FGetStringBag _pGetter )
 467             {
 468                 ::std::for_each( _rMap.begin(), _rMap.end(), StringBagCollector( _rAll, _pGetter ) );
 469             }
 470         };
 471
 472         //============================================================
 473         //= StringBagClearer
 474         //============================================================
 475         /** an STL-compatible structure which cleans a certain string bag in a CachedInspectorUI instances
 476         */
 477         struct StringBagClearer : public ::std::unary_function< ImplMapHandlerToUI::value_type, void >
 478         {
 479         private:
 480             CachedInspectorUI::FGetStringBag  m_pGetter;
 481
 482         public:
 483             StringBagClearer( CachedInspectorUI::FGetStringBag _pGetter ) :m_pGetter( _pGetter ) { }
 484
 485             void operator()( const ImplMapHandlerToUI::value_type& _rUI )
 486             {
 487                 clearContainer( ((_rUI.second.get())->*m_pGetter)() );
 488             }
 489
 490             static void clearAll( const ImplMapHandlerToUI& _rMap, CachedInspectorUI::FGetStringBag _pGetter )
 491             {
 492                 ::std::for_each( _rMap.begin(), _rMap.end(), StringBagClearer( _pGetter ) );
 493             }
 494         };
 495
 496         //============================================================
 497         //= FPropertyUISetter
 498         //============================================================
 499         /** a typedef for a ->XObjectInspectorUI member function taking a string
 500         */
 501         typedef void ( SAL_CALL XObjectInspectorUI::*FPropertyUISetter )( const ::rtl::OUString& );
 502
 503         //============================================================
 504         //= PropertyUIOperator
 505         //============================================================
 506         /** an STL-compatible struct which calls a certain member method (taking a string) at a
 507             given ->XObjectInspectorUI instance
 508         */
 509         struct PropertyUIOperator : public ::std::unary_function< ::rtl::OUString, void >
 510         {
 511         private:
 512             Reference< XObjectInspectorUI > m_xUpdater;
 513             FPropertyUISetter               m_pSetter;
 514
 515         public:
 516             PropertyUIOperator( const Reference< XObjectInspectorUI >& _rxInspectorUI, FPropertyUISetter _pSetter )
 517                 :m_xUpdater( _rxInspectorUI )
 518                 ,m_pSetter( _pSetter )
 519             {
 520             }
 521
 522             void operator()( const ::rtl::OUString& _rPropertyName )
 523             {
 524                 ((m_xUpdater.get())->*m_pSetter)( _rPropertyName );
 525             }
 526
 527             static void forEach( const StringBag& _rProperties, const Reference< XObjectInspectorUI >& _rxDelegatorUI, FPropertyUISetter _pSetter )
 528             {
 529                 ::std::for_each( _rProperties.begin(), _rProperties.end(), PropertyUIOperator( _rxDelegatorUI, _pSetter ) );
 530             }
 531         };
 532
 533         //============================================================
 534         //= IStringKeyBooleanUIUpdate
 535         //============================================================
 536         /** an interface which encapsulates access to a single aspect of the ->XObjectInspectorUI,
 537             where this aspect is given by a string key, and has a boolean value.
 538         */
 539         class IStringKeyBooleanUIUpdate
 540         {
 541         public:
 542             virtual void updateUIForKey( const ::rtl::OUString& _rKey, sal_Bool _bFlag ) const = 0;
 543
 544             virtual ~IStringKeyBooleanUIUpdate() { }
 545         };
 546
 547         //============================================================
 548         //= FPropertyUIFlagSetter
 549         //============================================================
 550         /** an implementation of the ->IStringKeyBooleanUIUpdate interface which,
 551             for a fixed ->XObjectInspectorUI instance and a fixed UI element (->PropertyLineElement),
 552             updates this element for a given property with a given boolean flag
 553             (->XObjectInspectorUI::enablePropertyUIElements)
 554         */
 555         class EnablePropertyUIElement : public IStringKeyBooleanUIUpdate
 556         {
 557         private:
 558             Reference< XObjectInspectorUI > m_xUIUpdate;
 559             sal_Int16                       m_nElement;
 560
 561         public:
 562             EnablePropertyUIElement( const Reference< XObjectInspectorUI >& _rxUIUpdate, sal_Int16 _nElement )
 563                 :m_xUIUpdate( _rxUIUpdate )
 564                 ,m_nElement( _nElement )
 565             {
 566             }
 567             // IStringKeyBooleanUIUpdate
 568             virtual void updateUIForKey( const ::rtl::OUString& _rKey, sal_Bool _bFlag ) const;
 569         };
 570
 571         //............................................................
 572         void EnablePropertyUIElement::updateUIForKey( const ::rtl::OUString& _rKey, sal_Bool _bFlag ) const
 573         {
 574             m_xUIUpdate->enablePropertyUIElements( _rKey, m_nElement, _bFlag );
 575         }
 576
 577         //============================================================
 578         //= FPropertyUIFlagSetter
 579         //============================================================
 580         /** a ->XObjectInspectorUI method taking a string and a boolean
 581         */
 582         typedef void ( SAL_CALL XObjectInspectorUI::*FPropertyUIFlagSetter )( const ::rtl::OUString&, sal_Bool );
 583
 584         //============================================================
 585         //= DefaultStringKeyBooleanUIUpdate
 586         //============================================================
 587         /** an implementaiton of the ->IStringKeyBooleanUIUpdate interface which calls
 588             am arbitrary ->XObjectInspectorUI method taking a string and a boolean flag
 589         */
 590         class DefaultStringKeyBooleanUIUpdate : public IStringKeyBooleanUIUpdate
 591         {
 592         private:
 593             Reference< XObjectInspectorUI > m_xUIUpdate;
 594             FPropertyUIFlagSetter           m_pSetter;
 595
 596         public:
 597             DefaultStringKeyBooleanUIUpdate( const Reference< XObjectInspectorUI >& _rxUIUpdate, FPropertyUIFlagSetter _pSetter );
 598             // IStringKeyBooleanUIUpdate
 599             virtual void updateUIForKey( const ::rtl::OUString& _rKey, sal_Bool _bFlag ) const;
 600         };
 601
 602         //............................................................
 603         DefaultStringKeyBooleanUIUpdate::DefaultStringKeyBooleanUIUpdate( const Reference< XObjectInspectorUI >& _rxUIUpdate, FPropertyUIFlagSetter _pSetter )
 604             :m_xUIUpdate( _rxUIUpdate )
 605             ,m_pSetter( _pSetter )
 606         {
 607         }
 608
 609         //............................................................
 610         void DefaultStringKeyBooleanUIUpdate::updateUIForKey( const ::rtl::OUString& _rKey, sal_Bool _bFlag ) const
 611         {
 612             ((m_xUIUpdate.get())->*m_pSetter)( _rKey, _bFlag );
 613         }
 614
 615         //============================================================
 616         //= BooleanUIAspectUpdate
 617         //============================================================
 618         /** an STL-compatible structure which applies a ->IStringKeyBooleanUIUpdate::updateUIForKey
 619             operation with a fixed boolean value, for a given string value
 620         */
 621         struct BooleanUIAspectUpdate : public ::std::unary_function< ::rtl::OUString, void >
 622         {
 623         private:
 624             const IStringKeyBooleanUIUpdate&    m_rUpdater;
 625             sal_Bool                            m_bFlag;
 626
 627         public:
 628             BooleanUIAspectUpdate( const IStringKeyBooleanUIUpdate& _rUpdater, sal_Bool _bFlag )
 629                 :m_rUpdater( _rUpdater )
 630                 ,m_bFlag( _bFlag )
 631             {
 632             }
 633
 634             void operator()( const ::rtl::OUString& _rPropertyName )
 635             {
 636                 m_rUpdater.updateUIForKey( _rPropertyName, m_bFlag );
 637             }
 638
 639             static void forEach( const StringBag& _rProperties, const IStringKeyBooleanUIUpdate& _rUpdater, sal_Bool _bFlag )
 640             {
 641                 ::std::for_each( _rProperties.begin(), _rProperties.end(), BooleanUIAspectUpdate( _rUpdater, _bFlag ) );
 642             }
 643         };
 644
 645         //============================================================
 646         //= BooleanUIAspectUpdate
 647         //============================================================
 648         /** an STL-compatible structure subtracting a given string from a fixed ->StringBag
 649         */
 650         struct StringBagComplement : public ::std::unary_function< ::rtl::OUString, void >
 651         {
 652         private:
 653             StringBag&  m_rMinuend;
 654
 655         public:
 656             StringBagComplement( StringBag& _rMinuend ) :m_rMinuend( _rMinuend ) { }
 657
 658             void operator()( const ::rtl::OUString& _rPropertyToSubtract )
 659             {
 660                 m_rMinuend.erase( _rPropertyToSubtract );
 661             }
 662
 663             static void subtract( StringBag& _rMinuend, const StringBag& _rSubtrahend )
 664             {
 665                 ::std::for_each( _rSubtrahend.begin(), _rSubtrahend.end(), StringBagComplement( _rMinuend ) );
 666             }
 667         };
 668
 669         //============================================================
 670         //= BooleanUIAspectUpdate
 671         //============================================================
 672         void lcl_fireUIStateFlag(
 673                 const IStringKeyBooleanUIUpdate& _rUIUpdate,
 674                 const ImplMapHandlerToUI& _rHandlerUIs,
 675                 CachedInspectorUI::FGetStringBag _pGetPositives,
 676                 CachedInspectorUI::FGetStringBag _pGetNegatives
 677             )
 678         {
 679             // all strings which are in the "positive" list of one handler
 680             StringBag aAllPositives;
 681             StringBagCollector::collectAll( aAllPositives, _rHandlerUIs, _pGetPositives );
 682
 683             // all strings which are in the "negative" list of one handler
 684             StringBag aAllNegatives;
 685             StringBagCollector::collectAll( aAllNegatives, _rHandlerUIs, _pGetNegatives );
 686
 687             // propagate the "negative" flags to the delegator UI
 688             BooleanUIAspectUpdate::forEach( aAllNegatives, _rUIUpdate, sal_False );
 689
 690             // propagate the "positive" flags to the delegator UI, for all elements where _no_
 691             // "negative" flag exists
 692             StringBagComplement::subtract( aAllPositives, aAllNegatives );
 693             BooleanUIAspectUpdate::forEach( aAllPositives, _rUIUpdate, sal_True );
 694
 695             // the "positive" request can be cleared no, only negative requests
 696             // (such as "disable a property" or "hide a category") need to be preserved for the next round
 697             StringBagClearer::clearAll( _rHandlerUIs, _pGetPositives );
 698         }
 699     }
 700
 701     //----------------------------------------------------------------
 702     void ComposedPropertyUIUpdate::impl_fireEnablePropertyUI_throw()
 703     {
 704         lcl_fireUIStateFlag(
 705             DefaultStringKeyBooleanUIUpdate( m_xDelegatorUI, &XObjectInspectorUI::enablePropertyUI ),
 706             m_pCollectedUIs->aHandlers,
 707             &CachedInspectorUI::getEnabledProperties,
 708             &CachedInspectorUI::getDisabledProperties
 709         );
 710     }
 711
 712     //----------------------------------------------------------------
 713     void ComposedPropertyUIUpdate::impl_fireRebuildPropertyUI_throw()
 714     {
 715         // collect all properties for which a rebuild request has been made
 716         StringBag aAllRebuilt;
 717         StringBagCollector::collectAll( aAllRebuilt, m_pCollectedUIs->aHandlers, &CachedInspectorUI::getRebuiltProperties );
 718
 719         // rebuild all those properties
 720         PropertyUIOperator::forEach( aAllRebuilt, m_xDelegatorUI, &XObjectInspectorUI::rebuildPropertyUI );
 721
 722         // clear the "properties to rebuild" at all handlers, since the request has been fulfilled now.
 723         StringBagClearer::clearAll( m_pCollectedUIs->aHandlers, &CachedInspectorUI::getRebuiltProperties );
 724     }
 725
 726     //----------------------------------------------------------------
 727     void ComposedPropertyUIUpdate::impl_fireShowHidePropertyUI_throw()
 728     {
 729         // all properties which have been shown by at least one handler
 730         StringBag aAllShown;
 731         StringBagCollector::collectAll( aAllShown, m_pCollectedUIs->aHandlers, &CachedInspectorUI::getShownProperties );
 732         // all properties which have been hidden by at least one handler
 733         StringBag aAllHidden;
 734         StringBagCollector::collectAll( aAllHidden, m_pCollectedUIs->aHandlers, &CachedInspectorUI::getHiddenProperties );
 735
 736         // hide properties as necessary
 737         PropertyUIOperator::forEach( aAllHidden, m_xDelegatorUI, &XObjectInspectorUI::hidePropertyUI );
 738
 739         // for those properties which are hidden, ignore all "show" requests which other handlers might have had
 740         StringBagComplement::subtract( aAllShown, aAllHidden );
 741
 742         // show properties
 743         PropertyUIOperator::forEach( aAllShown, m_xDelegatorUI, &XObjectInspectorUI::showPropertyUI );
 744     }
 745
 746     //----------------------------------------------------------------
 747     void ComposedPropertyUIUpdate::impl_fireShowCategory_throw()
 748     {
 749         lcl_fireUIStateFlag(
 750             DefaultStringKeyBooleanUIUpdate( m_xDelegatorUI, &XObjectInspectorUI::showCategory ),
 751             m_pCollectedUIs->aHandlers,
 752             &CachedInspectorUI::getShownCategories,
 753             &CachedInspectorUI::getHiddenCategories
 754         );
 755     }
 756
 757     //----------------------------------------------------------------
 758     void ComposedPropertyUIUpdate::impl_fireEnablePropertyUIElements_throw()
 759     {
 760         lcl_fireUIStateFlag(
 761             EnablePropertyUIElement( m_xDelegatorUI, PropertyLineElement::InputControl ),
 762             m_pCollectedUIs->aHandlers,
 763             &CachedInspectorUI::getEnabledInputControls,
 764             &CachedInspectorUI::getDisabledInputControls
 765         );
 766
 767         lcl_fireUIStateFlag(
 768             EnablePropertyUIElement( m_xDelegatorUI, PropertyLineElement::PrimaryButton ),
 769             m_pCollectedUIs->aHandlers,
 770             &CachedInspectorUI::getEnabledPrimaryButtons,
 771             &CachedInspectorUI::getDisabledPrimaryButtons
 772         );
 773
 774         lcl_fireUIStateFlag(
 775             EnablePropertyUIElement( m_xDelegatorUI, PropertyLineElement::SecondaryButton ),
 776             m_pCollectedUIs->aHandlers,
 777             &CachedInspectorUI::getEnabledSecondaryButtons,
 778             &CachedInspectorUI::getDisabledSecondaryButtons
 779         );
 780     }
 781
 782     //----------------------------------------------------------------
 783     void SAL_CALL ComposedPropertyUIUpdate::fire()
 784     {
 785         impl_checkDisposed();
 786         impl_fireAll_throw();
 787     }
 788
 789     //--------------------------------------------------------------------
 790     void ComposedPropertyUIUpdate::impl_fireAll_throw()
 791     {
 792         OSL_PRECOND( !impl_isDisposed(), "ComposedPropertyUIUpdate::impl_fireAll_throw: already disposed, this will crash!" );
 793
 794         impl_fireEnablePropertyUI_throw();
 795         impl_fireShowHidePropertyUI_throw();
 796         impl_fireRebuildPropertyUI_throw();
 797         impl_fireShowCategory_throw();
 798         impl_fireEnablePropertyUIElements_throw();
 799     }
 800
 801     //--------------------------------------------------------------------
 802     void SAL_CALL ComposedPropertyUIUpdate::suspendAutoFire()
 803     {
 804         impl_checkDisposed();
 805         osl_incrementInterlockedCount( &m_nSuspendCounter );
 806     }
 807
 808     //--------------------------------------------------------------------
 809     void SAL_CALL ComposedPropertyUIUpdate::resumeAutoFire()
 810     {
 811         impl_checkDisposed();
 812         if ( 0 == osl_decrementInterlockedCount( &m_nSuspendCounter ) )
 813             impl_fireAll_throw();
 814     }
 815
 816     //----------------------------------------------------------------
 817     void ComposedPropertyUIUpdate::impl_checkDisposed() const
 818     {
 819         if ( impl_isDisposed() )
 820             throw DisposedException();
 821     }
 822
 823     //----------------------------------------------------------------
 824     void ComposedPropertyUIUpdate::callback_inspectorUIChanged_throw()
 825     {
 826         if ( 0 == m_nSuspendCounter )
 827             impl_fireAll_throw();
 828     }
 829
 830     //----------------------------------------------------------------
 831     Reference< XObjectInspectorUI > ComposedPropertyUIUpdate::getDelegatorUI() const
 832     {
 833         impl_checkDisposed();
 834         return m_xDelegatorUI;
 835     }
 836
 837     //----------------------------------------------------------------
 838     void SAL_CALL ComposedPropertyUIUpdate::dispose()
 839     {
 840         if ( impl_isDisposed() )
 841             return;
 842
 843         OSL_ENSURE( m_nSuspendCounter == 0, "ComposedPropertyUIUpdate::dispose: still suspended, the changes will be lost!" );
 844
 845         for ( ImplMapHandlerToUI::const_iterator singleUI = m_pCollectedUIs->aHandlers.begin();
 846               singleUI != m_pCollectedUIs->aHandlers.end();
 847               ++singleUI
 848             )
 849         {
 850             singleUI->second->dispose();
 851         }
 852         m_pCollectedUIs.reset( NULL );
 853         m_xDelegatorUI.set( NULL );
 854     }
 855
 856     //----------------------------------------------------------------
 857     bool ComposedPropertyUIUpdate::shouldContinuePropertyHandling( const ::rtl::OUString& _rName ) const
 858     {
 859         if ( !m_pPropertyCheck )
 860             return true;
 861         if ( m_pPropertyCheck->hasPropertyByName( _rName ) )
 862             return true;
 863         return false;
 864     }
 865
 866 //........................................................................
 867 } // namespace pcr
 868 //........................................................................
 869