svtools/source/hatchwindow/documentcloser.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: documentcloser.cxx,v $
  10  * $Revision: 1.5 $
  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_svtools.hxx"
  33 #include <com/sun/star/util/XCloseBroadcaster.hpp>
  34 #include <com/sun/star/util/XCloseable.hpp>
  35 #include <com/sun/star/lang/DisposedException.hpp>
  36 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  37 #include <com/sun/star/frame/DoubleInitializationException.hpp>
  38 #include <com/sun/star/frame/DoubleInitializationException.hpp>
  39 #include <com/sun/star/beans/XPropertySet.hpp>
  40 #include <com/sun/star/awt/XVclWindowPeer.hpp>
  41
  42 #include <vos/mutex.hxx>
  43 #include <vcl/svapp.hxx>
  44 #include <vcl/dialog.hxx>
  45 #include <tools/link.hxx>
  46 #include <toolkit/helper/vclunohelper.hxx>
  47
  48 #include "documentcloser.hxx"
  49
  50 using namespace ::com::sun::star;
  51
  52
  53 // ====================================================================
  54 // MainThreadFrameCloserRequest
  55 // ====================================================================
  56
  57 class MainThreadFrameCloserRequest
  58 {
  59     uno::Reference< frame::XFrame > m_xFrame;
  60
  61     public:
  62         MainThreadFrameCloserRequest( const uno::Reference< frame::XFrame >& xFrame )
  63         : m_xFrame( xFrame )
  64         {}
  65
  66         DECL_STATIC_LINK( MainThreadFrameCloserRequest, worker, MainThreadFrameCloserRequest* );
  67
  68         static void Start( MainThreadFrameCloserRequest* pRequest );
  69 };
  70
  71 // --------------------------------------------------------
  72 void MainThreadFrameCloserRequest::Start( MainThreadFrameCloserRequest* pMTRequest )
  73 {
  74     if ( pMTRequest )
  75     {
  76         if ( Application::GetMainThreadIdentifier() == osl_getThreadIdentifier( NULL ) )
  77         {
  78             // this is the main thread
  79             worker( NULL, pMTRequest );
  80         }
  81         else
  82             Application::PostUserEvent( STATIC_LINK( NULL, MainThreadFrameCloserRequest, worker ), pMTRequest );
  83     }
  84 }
  85
  86 // --------------------------------------------------------
  87 IMPL_STATIC_LINK( MainThreadFrameCloserRequest, worker, MainThreadFrameCloserRequest*, pMTRequest )
  88 {
  89     (void) pThis; // unused
  90     if ( pMTRequest )
  91     {
  92         if ( pMTRequest->m_xFrame.is() )
  93         {
  94             // this is the main thread, the solar mutex must be locked
  95             ::vos::OGuard aGuard( Application::GetSolarMutex() );
  96
  97             try
  98             {
  99                 uno::Reference< awt::XWindow > xWindow = pMTRequest->m_xFrame->getContainerWindow();
 100                 uno::Reference< awt::XVclWindowPeer > xWinPeer( xWindow, uno::UNO_QUERY_THROW );
 101
 102                 xWindow->setVisible( sal_False );
 103
 104                 // reparent the window
 105                 xWinPeer->setProperty( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "PluginParent" ) ),
 106                                         uno::makeAny( (sal_Int64) 0 ) );
 107
 108                 Window* pWindow = VCLUnoHelper::GetWindow( xWindow );
 109                 if ( pWindow )
 110                     Dialog::EndAllDialogs( pWindow );
 111             }
 112             catch( uno::Exception& )
 113             {
 114                 // ignore all the errors
 115             }
 116
 117             try
 118             {
 119                 uno::Reference< util::XCloseable > xCloseable( pMTRequest->m_xFrame, uno::UNO_QUERY_THROW );
 120                 xCloseable->close( sal_True );
 121             }
 122             catch( uno::Exception& )
 123             {
 124                 // ignore all the errors
 125             }
 126         }
 127
 128         delete pMTRequest;
 129     }
 130
 131     return 0;
 132 }
 133
 134
 135 // ====================================================================
 136 // ODocumentCloser
 137 // ====================================================================
 138
 139 // --------------------------------------------------------
 140 ODocumentCloser::ODocumentCloser( const uno::Reference< uno::XComponentContext >& xContext )
 141 : m_xContext( xContext )
 142 , m_pListenersContainer( NULL )
 143 , m_bDisposed( sal_False )
 144 , m_bInitialized( sal_False )
 145 {
 146 }
 147
 148 // --------------------------------------------------------
 149 ODocumentCloser::~ODocumentCloser()
 150 {
 151     if ( m_pListenersContainer )
 152     {
 153         delete m_pListenersContainer;
 154         m_pListenersContainer = NULL;
 155     }
 156 }
 157
 158 // XComponent
 159 // --------------------------------------------------------
 160 void SAL_CALL ODocumentCloser::dispose()
 161     throw (uno::RuntimeException)
 162 {
 163     ::osl::MutexGuard aGuard( m_aMutex );
 164
 165     if ( m_bDisposed )
 166         throw lang::DisposedException();
 167
 168        lang::EventObject aSource( static_cast< ::cppu::OWeakObject* >(this) );
 169     if ( m_pListenersContainer )
 170         m_pListenersContainer->disposeAndClear( aSource );
 171
 172     // TODO: trigger a main thread execution to close the frame
 173     if ( m_xFrame.is() )
 174     {
 175         // the created object will be deleted after thread execution
 176         MainThreadFrameCloserRequest* pCloser = new MainThreadFrameCloserRequest( m_xFrame );
 177         MainThreadFrameCloserRequest::Start( pCloser );
 178     }
 179
 180     m_bDisposed = sal_True;
 181 }
 182
 183 // --------------------------------------------------------
 184 void SAL_CALL ODocumentCloser::addEventListener( const uno::Reference< lang::XEventListener >& xListener )
 185     throw (uno::RuntimeException)
 186 {
 187     ::osl::MutexGuard aGuard( m_aMutex );
 188     if ( m_bDisposed )
 189         throw lang::DisposedException(); // TODO
 190
 191     if ( !m_pListenersContainer )
 192         m_pListenersContainer = new ::cppu::OInterfaceContainerHelper( m_aMutex );
 193
 194     m_pListenersContainer->addInterface( xListener );
 195 }
 196
 197 // --------------------------------------------------------
 198 void SAL_CALL ODocumentCloser::removeEventListener( const uno::Reference< lang::XEventListener >& xListener )
 199     throw (uno::RuntimeException)
 200 {
 201     ::osl::MutexGuard aGuard( m_aMutex );
 202     if ( m_pListenersContainer )
 203         m_pListenersContainer->removeInterface( xListener );
 204 }
 205
 206 // XInitialization
 207 // --------------------------------------------------------
 208 void SAL_CALL ODocumentCloser::initialize( const uno::Sequence< uno::Any >& aArguments )
 209     throw (uno::Exception, uno::RuntimeException)
 210 {
 211     ::osl::MutexGuard aGuard( m_aMutex );
 212     if ( m_bInitialized )
 213         throw frame::DoubleInitializationException();
 214
 215     if ( m_bDisposed )
 216         throw lang::DisposedException(); // TODO
 217
 218     if ( !m_refCount )
 219         throw uno::RuntimeException(); // the object must be refcounted already!
 220
 221     sal_Int32 nLen = aArguments.getLength();
 222     if ( nLen != 1 )
 223         throw lang::IllegalArgumentException(
 224                         ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("Wrong count of parameters!" ) ),
 225                         uno::Reference< uno::XInterface >(),
 226                         0 );
 227
 228     if ( !( aArguments[0] >>= m_xFrame ) || !m_xFrame.is() )
 229         throw lang::IllegalArgumentException(
 230                 ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("Nonempty reference is expected as the first argument!" ) ),
 231                 uno::Reference< uno::XInterface >(),
 232                 0 );
 233
 234     m_bInitialized = sal_True;
 235 }
 236
 237
 238 // XServiceInfo
 239 // --------------------------------------------------------
 240 ::rtl::OUString SAL_CALL ODocumentCloser::getImplementationName(  )
 241     throw (uno::RuntimeException)
 242 {
 243     return impl_staticGetImplementationName();
 244 }
 245
 246 // --------------------------------------------------------
 247 ::sal_Bool SAL_CALL ODocumentCloser::supportsService( const ::rtl::OUString& ServiceName )
 248     throw (uno::RuntimeException)
 249 {
 250     uno::Sequence< ::rtl::OUString > aSeq = impl_staticGetSupportedServiceNames();
 251
 252     for ( sal_Int32 nInd = 0; nInd < aSeq.getLength(); nInd++ )
 253         if ( ServiceName.compareTo( aSeq[nInd] ) == 0 )
 254             return sal_True;
 255
 256     return sal_False;
 257 }
 258
 259 // --------------------------------------------------------
 260 uno::Sequence< ::rtl::OUString > SAL_CALL ODocumentCloser::getSupportedServiceNames()
 261     throw (uno::RuntimeException)
 262 {
 263     return impl_staticGetSupportedServiceNames();
 264 }
 265
 266 // Static methods
 267 // --------------------------------------------------------
 268 uno::Sequence< ::rtl::OUString > SAL_CALL ODocumentCloser::impl_staticGetSupportedServiceNames()
 269 {
 270     const rtl::OUString aServiceName( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.embed.DocumentCloser" ) );
 271     return uno::Sequence< rtl::OUString >( &aServiceName, 1 );
 272 }
 273
 274 // --------------------------------------------------------
 275 ::rtl::OUString SAL_CALL ODocumentCloser::impl_staticGetImplementationName()
 276 {
 277     return rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.comp.embed.DocumentCloser" ) );
 278 }
 279
 280 // --------------------------------------------------------
 281 uno::Reference< uno::XInterface > SAL_CALL ODocumentCloser::impl_staticCreateSelfInstance(
 282                                 const uno::Reference< lang::XMultiServiceFactory >& xServiceManager )
 283 {
 284     uno::Reference< uno::XComponentContext > xContext;
 285     uno::Reference< beans::XPropertySet > xPropSet( xServiceManager, uno::UNO_QUERY );
 286     if ( xPropSet.is() )
 287         xPropSet->getPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "DefaultContext" ) ) ) >>= xContext;
 288
 289     if ( !xContext.is() )
 290     {
 291         throw uno::RuntimeException(
 292             rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Unable to obtain component context from service manager!" ) ),
 293             uno::Reference< uno::XInterface >() );
 294     }
 295
 296     return static_cast< cppu::OWeakObject * >( new ODocumentCloser( xContext ) );
 297 }
 298