dbaccess/source/ui/misc/controllerframe.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: controllerframe.cxx,v $
  10  * $Revision: 1.3.2.2 $
  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 #include "controllerframe.hxx"
  32 #include "IController.hxx"
  33
  34 /** === begin UNO includes === **/
  35 #include <com/sun/star/sdb/XOfficeDatabaseDocument.hpp>
  36 #include <com/sun/star/awt/XTopWindow.hpp>
  37 #include <com/sun/star/awt/XWindow2.hpp>
  38 #include <com/sun/star/lang/DisposedException.hpp>
  39 #include <com/sun/star/document/XDocumentEventBroadcaster.hpp>
  40 #include <com/sun/star/frame/XController2.hpp>
  41 /** === end UNO includes === **/
  42
  43 #include <cppuhelper/implbase1.hxx>
  44 #include <rtl/ref.hxx>
  45 #include <sfx2/objsh.hxx>
  46 #include <tools/diagnose_ex.h>
  47
  48 //........................................................................
  49 namespace dbaui
  50 {
  51 //........................................................................
  52
  53     /** === begin UNO using === **/
  54     using ::com::sun::star::uno::Reference;
  55     using ::com::sun::star::uno::XInterface;
  56     using ::com::sun::star::uno::UNO_QUERY;
  57     using ::com::sun::star::uno::UNO_QUERY_THROW;
  58     using ::com::sun::star::uno::UNO_SET_THROW;
  59     using ::com::sun::star::uno::Exception;
  60     using ::com::sun::star::uno::RuntimeException;
  61     using ::com::sun::star::uno::Any;
  62     using ::com::sun::star::uno::makeAny;
  63     using ::com::sun::star::frame::XFrame;
  64     using ::com::sun::star::frame::FrameAction;
  65     using ::com::sun::star::frame::FrameAction_FRAME_ACTIVATED;
  66     using ::com::sun::star::frame::FrameAction_FRAME_UI_ACTIVATED;
  67     using ::com::sun::star::frame::FrameAction_FRAME_DEACTIVATING;
  68     using ::com::sun::star::frame::FrameAction_FRAME_UI_DEACTIVATING;
  69     using ::com::sun::star::frame::XModel;
  70     using ::com::sun::star::frame::XController;
  71     using ::com::sun::star::frame::XController2;
  72     using ::com::sun::star::frame::XFramesSupplier;
  73     using ::com::sun::star::sdb::XOfficeDatabaseDocument;
  74     using ::com::sun::star::awt::XTopWindow;
  75     using ::com::sun::star::awt::XTopWindowListener;
  76     using ::com::sun::star::awt::XWindow2;
  77     using ::com::sun::star::lang::DisposedException;
  78     using ::com::sun::star::lang::EventObject;
  79     using ::com::sun::star::document::XDocumentEventBroadcaster;
  80     /** === end UNO using === **/
  81
  82     //====================================================================
  83     //= FrameWindowActivationListener
  84     //====================================================================
  85     typedef ::cppu::WeakImplHelper1 <   XTopWindowListener
  86                                     >   FrameWindowActivationListener_Base;
  87     class FrameWindowActivationListener : public FrameWindowActivationListener_Base
  88     {
  89     public:
  90         FrameWindowActivationListener( ControllerFrame_Data& _rData );
  91
  92         void dispose();
  93
  94     protected:
  95         ~FrameWindowActivationListener();
  96
  97         // XTopWindowListener
  98         virtual void SAL_CALL windowOpened( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
  99         virtual void SAL_CALL windowClosing( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
 100         virtual void SAL_CALL windowClosed( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
 101         virtual void SAL_CALL windowMinimized( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
 102         virtual void SAL_CALL windowNormalized( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
 103         virtual void SAL_CALL windowActivated( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
 104         virtual void SAL_CALL windowDeactivated( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
 105
 106         // XEventListener
 107         virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw (::com::sun::star::uno::RuntimeException);
 108
 109     private:
 110         void impl_checkDisposed_throw() const;
 111         void impl_registerOnFrameContainerWindow_nothrow( bool _bRegister );
 112
 113     private:
 114         ControllerFrame_Data*   m_pData;
 115     };
 116
 117     //====================================================================
 118     //= ControllerFrame_Data
 119     //====================================================================
 120     struct ControllerFrame_Data
 121     {
 122         ControllerFrame_Data( IController& _rController )
 123             :m_rController( _rController )
 124             ,m_xFrame()
 125             ,m_xDocEventBroadcaster()
 126             ,m_pListener()
 127             ,m_bActive( false )
 128             ,m_bLivesInTopWindow( false )
 129         {
 130         }
 131
 132         IController&                                        m_rController;
 133         Reference< XFrame >                                 m_xFrame;
 134         Reference< XDocumentEventBroadcaster >              m_xDocEventBroadcaster;
 135         ::rtl::Reference< FrameWindowActivationListener >   m_pListener;
 136         bool                                                m_bActive;
 137         bool                                                m_bLivesInTopWindow;
 138     };
 139
 140     //====================================================================
 141     //= helper
 142     //====================================================================
 143     //--------------------------------------------------------------------
 144     static void lcl_setFrame_nothrow( ControllerFrame_Data& _rData, const Reference< XFrame >& _rxFrame )
 145     {
 146         // release old listener
 147         if ( _rData.m_pListener.get() )
 148         {
 149             _rData.m_pListener->dispose();
 150             _rData.m_pListener = NULL;
 151         }
 152
 153         // remember new frame
 154         _rData.m_xFrame = _rxFrame;
 155
 156         // create new listener
 157         if ( _rData.m_xFrame.is() )
 158             _rData.m_pListener = new FrameWindowActivationListener( _rData );
 159
 160         // at this point in time, we can assume the controller also has a model set, if it supports models
 161         try
 162         {
 163             Reference< XController > xController( _rData.m_rController.getXController(), UNO_SET_THROW );
 164             Reference< XModel > xModel( xController->getModel() );
 165             if ( xModel.is() )
 166                 _rData.m_xDocEventBroadcaster.set( xModel, UNO_QUERY );
 167         }
 168         catch( const Exception& )
 169         {
 170             DBG_UNHANDLED_EXCEPTION();
 171         }
 172     }
 173
 174     //--------------------------------------------------------------------
 175     static bool lcl_isActive_nothrow( const Reference< XFrame >& _rxFrame )
 176     {
 177         bool bIsActive = false;
 178         try
 179         {
 180             if ( _rxFrame.is() )
 181             {
 182                 Reference< XWindow2 > xWindow( _rxFrame->getContainerWindow(), UNO_QUERY_THROW );
 183                 bIsActive = xWindow->isActive();
 184             }
 185
 186         }
 187         catch( const Exception& )
 188         {
 189             DBG_UNHANDLED_EXCEPTION();
 190         }
 191         return bIsActive;
 192     }
 193
 194     //--------------------------------------------------------------------
 195     /** updates various global and local states with a new active component
 196
 197         In particular, the following are updated
 198             * the global working document (aka Basic's ThisComponent in the application
 199             Basic), with our controller's model, or the controller itself if there is no such
 200             model.
 201     */
 202     static void lcl_updateActiveComponents_nothrow( const ControllerFrame_Data& _rData )
 203     {
 204         try
 205         {
 206             Reference< XController > xCompController( _rData.m_rController.getXController() );
 207             OSL_ENSURE( xCompController.is(), "lcl_updateActiveComponents_nothrow: can't do anything without a controller!" );
 208             if ( !xCompController.is() )
 209                 return;
 210
 211             if ( _rData.m_bActive && _rData.m_bLivesInTopWindow )
 212             {
 213                 // set the "current component" at the SfxObjectShell
 214                 Reference< XModel > xModel( xCompController->getModel() );
 215                 Reference< XInterface > xCurrentComponent;
 216                 if ( xModel.is() )
 217                     xCurrentComponent = xModel;
 218                 else
 219                     xCurrentComponent = xCompController;
 220                 SfxObjectShell::SetCurrentComponent( xCurrentComponent );
 221             }
 222         }
 223         catch( const Exception& )
 224         {
 225             DBG_UNHANDLED_EXCEPTION();
 226         }
 227     }
 228
 229     //--------------------------------------------------------------------
 230     /** broadcasts the OnFocus resp. OnUnfocus event
 231     */
 232     static void lcl_notifyFocusChange_nothrow( ControllerFrame_Data& _rData, bool _bActive )
 233     {
 234         try
 235         {
 236             if ( _rData.m_xDocEventBroadcaster.is() )
 237             {
 238                 ::rtl::OUString sEventName( ::rtl::OUString::createFromAscii( _bActive ? "OnFocus" : "OnUnfocus" ) );
 239                 Reference< XController2 > xController( _rData.m_rController.getXController(), UNO_QUERY_THROW );
 240                 _rData.m_xDocEventBroadcaster->notifyDocumentEvent( sEventName, xController, Any() );
 241             }
 242         }
 243         catch( const Exception& )
 244         {
 245             DBG_UNHANDLED_EXCEPTION();
 246         }
 247     }
 248
 249     //--------------------------------------------------------------------
 250     static void lcl_updateActive_nothrow( ControllerFrame_Data& _rData, bool _bActive )
 251     {
 252         if ( _rData.m_bActive == _bActive )
 253             return;
 254         _rData.m_bActive = _bActive;
 255
 256         lcl_updateActiveComponents_nothrow( _rData );
 257         lcl_notifyFocusChange_nothrow( _rData, _bActive );
 258     }
 259
 260     //--------------------------------------------------------------------
 261     FrameWindowActivationListener::FrameWindowActivationListener( ControllerFrame_Data& _rData )
 262         :m_pData( &_rData )
 263     {
 264         impl_registerOnFrameContainerWindow_nothrow( true );
 265     }
 266
 267     //--------------------------------------------------------------------
 268     FrameWindowActivationListener::~FrameWindowActivationListener()
 269     {
 270     }
 271
 272     //--------------------------------------------------------------------
 273     void FrameWindowActivationListener::dispose()
 274     {
 275         impl_registerOnFrameContainerWindow_nothrow( false );
 276         m_pData = NULL;
 277     }
 278
 279     //--------------------------------------------------------------------
 280     void FrameWindowActivationListener::impl_registerOnFrameContainerWindow_nothrow( bool _bRegister )
 281     {
 282         OSL_ENSURE( m_pData && m_pData->m_xFrame.is(), "FrameWindowActivationListener::impl_registerOnFrameContainerWindow_nothrow: no frame!" );
 283         if ( !m_pData || !m_pData->m_xFrame.is() )
 284             return;
 285
 286         try
 287         {
 288             void ( SAL_CALL XTopWindow::*pListenerAction )( const Reference< XTopWindowListener >& ) =
 289                 _bRegister ? &XTopWindow::addTopWindowListener : &XTopWindow::removeTopWindowListener;
 290
 291             Reference< XTopWindow > xFrameContainer( m_pData->m_xFrame->getContainerWindow(), UNO_QUERY );
 292             if ( _bRegister )
 293                 m_pData->m_bLivesInTopWindow = xFrameContainer.is();
 294             if ( xFrameContainer.is() )
 295                 (xFrameContainer.get()->*pListenerAction)( this );
 296         }
 297         catch( const Exception& )
 298         {
 299             DBG_UNHANDLED_EXCEPTION();
 300         }
 301     }
 302
 303     //--------------------------------------------------------------------
 304     void FrameWindowActivationListener::impl_checkDisposed_throw() const
 305     {
 306         if ( !m_pData )
 307             throw DisposedException( ::rtl::OUString(), *const_cast< FrameWindowActivationListener* >( this ) );
 308     }
 309
 310     //--------------------------------------------------------------------
 311     void SAL_CALL FrameWindowActivationListener::windowOpened( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
 312     {
 313         // not interested in
 314     }
 315
 316     //--------------------------------------------------------------------
 317     void SAL_CALL FrameWindowActivationListener::windowClosing( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
 318     {
 319         // not interested in
 320     }
 321
 322     //--------------------------------------------------------------------
 323     void SAL_CALL FrameWindowActivationListener::windowClosed( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
 324     {
 325         // not interested in
 326     }
 327
 328     //--------------------------------------------------------------------
 329     void SAL_CALL FrameWindowActivationListener::windowMinimized( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
 330     {
 331         // not interested in
 332     }
 333
 334     //--------------------------------------------------------------------
 335     void SAL_CALL FrameWindowActivationListener::windowNormalized( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
 336     {
 337         // not interested in
 338     }
 339
 340     //--------------------------------------------------------------------
 341     void SAL_CALL FrameWindowActivationListener::windowActivated( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
 342     {
 343         impl_checkDisposed_throw();
 344         lcl_updateActive_nothrow( *m_pData, true );
 345     }
 346
 347     //--------------------------------------------------------------------
 348     void SAL_CALL FrameWindowActivationListener::windowDeactivated( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
 349     {
 350         impl_checkDisposed_throw();
 351         lcl_updateActive_nothrow( *m_pData, false );
 352     }
 353
 354     //--------------------------------------------------------------------
 355     void SAL_CALL FrameWindowActivationListener::disposing( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
 356     {
 357         dispose();
 358     }
 359
 360     //====================================================================
 361     //= ControllerFrame
 362     //====================================================================
 363     //--------------------------------------------------------------------
 364     ControllerFrame::ControllerFrame( IController& _rController )
 365         :m_pData( new ControllerFrame_Data( _rController ) )
 366     {
 367     }
 368
 369     //--------------------------------------------------------------------
 370     ControllerFrame::~ControllerFrame()
 371     {
 372     }
 373
 374     //--------------------------------------------------------------------
 375     const Reference< XFrame >& ControllerFrame::attachFrame( const Reference< XFrame >& _rxFrame )
 376     {
 377         // set new frame, including listener handling
 378         lcl_setFrame_nothrow( *m_pData, _rxFrame );
 379
 380         // determine whether we're active
 381         m_pData->m_bActive = lcl_isActive_nothrow( m_pData->m_xFrame );
 382
 383         // update active component
 384         if ( m_pData->m_bActive )
 385         {
 386             lcl_updateActiveComponents_nothrow( *m_pData );
 387             lcl_notifyFocusChange_nothrow( *m_pData, true );
 388         }
 389
 390         return m_pData->m_xFrame;
 391     }
 392
 393     //--------------------------------------------------------------------
 394     const Reference< XFrame >& ControllerFrame::getFrame() const
 395     {
 396         return m_pData->m_xFrame;
 397     }
 398
 399     //--------------------------------------------------------------------
 400     bool ControllerFrame::isActive() const
 401     {
 402         return m_pData->m_bActive;
 403     }
 404
 405     //--------------------------------------------------------------------
 406     void ControllerFrame::frameAction( FrameAction _eAction )
 407     {
 408         bool bActive = m_pData->m_bActive;
 409
 410         switch ( _eAction )
 411         {
 412             case FrameAction_FRAME_ACTIVATED:
 413             case FrameAction_FRAME_UI_ACTIVATED:
 414                 bActive = true;
 415                 break;
 416
 417             case FrameAction_FRAME_DEACTIVATING:
 418             case FrameAction_FRAME_UI_DEACTIVATING:
 419                 bActive = false;
 420                 break;
 421
 422             default:
 423                 break;
 424         }
 425
 426         lcl_updateActive_nothrow( *m_pData, bActive );
 427     }
 428
 429 //........................................................................
 430 } // namespace dbaui
 431 //........................................................................