extensions/source/propctrlr/composeduiupdate.cxx

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