svtools/source/uno/genericunodialog.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 #include "svtools/genericunodialog.hxx"
  22
  23 #include <com/sun/star/beans/NamedValue.hpp>
  24 #include <com/sun/star/ucb/AlreadyInitializedException.hpp>
  25
  26 #include <toolkit/awt/vclxwindow.hxx>
  27 #include <comphelper/extract.hxx>
  28 #include <cppuhelper/supportsservice.hxx>
  29 #include <cppuhelper/typeprovider.hxx>
  30 #include <comphelper/property.hxx>
  31 #include <osl/diagnose.h>
  32 #include <tools/diagnose_ex.h>
  33 #include <vcl/msgbox.hxx>
  34 #include <osl/mutex.hxx>
  35 #include <vcl/svapp.hxx>
  36
  37 using namespace ::comphelper;
  38 using namespace ::com::sun::star::uno;
  39 using namespace ::com::sun::star::lang;
  40 using namespace ::com::sun::star::beans;
  41 using namespace ::com::sun::star::ucb;
  42
  43 //.........................................................................
  44 namespace svt
  45 {
  46 //.........................................................................
  47
  48 //-------------------------------------------------------------------------
  49 OGenericUnoDialog::OGenericUnoDialog(const Reference< XComponentContext >& _rxContext)
  50         :OPropertyContainer(GetBroadcastHelper())
  51         ,m_pDialog(NULL)
  52         ,m_bExecuting(sal_False)
  53         ,m_bCanceled(sal_False)
  54         ,m_bTitleAmbiguous(sal_True)
  55         ,m_bInitialized( false )
  56         ,m_bNeedInitialization( false )
  57         ,m_aContext(_rxContext)
  58 {
  59     registerProperty(OUString(UNODIALOG_PROPERTY_TITLE), UNODIALOG_PROPERTY_ID_TITLE, PropertyAttribute::TRANSIENT,
  60         &m_sTitle, getCppuType(&m_sTitle));
  61     registerProperty(OUString(UNODIALOG_PROPERTY_PARENT), UNODIALOG_PROPERTY_ID_PARENT, PropertyAttribute::TRANSIENT,
  62         &m_xParent, getCppuType(&m_xParent));
  63 }
  64
  65 //-------------------------------------------------------------------------
  66 OGenericUnoDialog::~OGenericUnoDialog()
  67 {
  68     if ( m_pDialog )
  69     {
  70         SolarMutexGuard aSolarGuard;
  71         ::osl::MutexGuard aGuard( m_aMutex );
  72         if ( m_pDialog )
  73             destroyDialog();
  74     }
  75 }
  76
  77 //-------------------------------------------------------------------------
  78 Any SAL_CALL OGenericUnoDialog::queryInterface(const Type& _rType) throw (RuntimeException)
  79 {
  80     Any aReturn = OGenericUnoDialogBase::queryInterface(_rType);
  81
  82     if (!aReturn.hasValue())
  83         aReturn = ::cppu::queryInterface(_rType
  84             ,static_cast<XPropertySet*>(this)
  85             ,static_cast<XMultiPropertySet*>(this)
  86             ,static_cast<XFastPropertySet*>(this)
  87         );
  88
  89     return aReturn;
  90 }
  91
  92 //-------------------------------------------------------------------------
  93 Sequence<Type> SAL_CALL OGenericUnoDialog::getTypes(  ) throw(RuntimeException)
  94 {
  95     return ::comphelper::concatSequences(
  96         OGenericUnoDialogBase::getTypes(),
  97         ::comphelper::OPropertyContainer::getTypes()
  98     );
  99 }
 100
 101 sal_Bool SAL_CALL OGenericUnoDialog::supportsService(const OUString& ServiceName) throw(RuntimeException)
 102 {
 103     return cppu::supportsService(this, ServiceName);
 104 }
 105
 106 //-------------------------------------------------------------------------
 107 void OGenericUnoDialog::setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const Any& rValue ) throw(Exception)
 108 {
 109     // TODO : need some handling if we're currently executing ...
 110
 111     OPropertyContainer::setFastPropertyValue_NoBroadcast(nHandle, rValue);
 112
 113     if (UNODIALOG_PROPERTY_ID_TITLE == nHandle)
 114     {
 115         // from now on m_sTitle is valid
 116         m_bTitleAmbiguous = sal_False;
 117
 118         if (m_pDialog)
 119             m_pDialog->SetText(m_sTitle);
 120     }
 121 }
 122
 123 //-------------------------------------------------------------------------
 124 sal_Bool OGenericUnoDialog::convertFastPropertyValue( Any& rConvertedValue, Any& rOldValue, sal_Int32 nHandle, const Any& rValue) throw(IllegalArgumentException)
 125 {
 126     switch (nHandle)
 127     {
 128         case UNODIALOG_PROPERTY_ID_PARENT:
 129         {
 130             Reference<starawt::XWindow> xNew;
 131             ::cppu::extractInterface(xNew, rValue);
 132             if (xNew != m_xParent)
 133             {
 134                 rConvertedValue <<= xNew;
 135                 rOldValue <<= m_xParent;
 136                 return sal_True;
 137             }
 138             return sal_False;
 139         }
 140     }
 141     return OPropertyContainer::convertFastPropertyValue(rConvertedValue, rOldValue, nHandle, rValue);
 142 }
 143
 144 //-------------------------------------------------------------------------
 145 void SAL_CALL OGenericUnoDialog::setTitle( const OUString& _rTitle ) throw(RuntimeException)
 146 {
 147     UnoDialogEntryGuard aGuard( *this );
 148
 149     try
 150     {
 151         setPropertyValue(OUString(UNODIALOG_PROPERTY_TITLE), makeAny(_rTitle));
 152     }
 153     catch(RuntimeException&)
 154     {
 155         // allowed to pass
 156         throw;
 157     }
 158     catch( const Exception& )
 159     {
 160         DBG_UNHANDLED_EXCEPTION();
 161         // not allowed to pass
 162     }
 163 }
 164
 165 //-------------------------------------------------------------------------
 166 bool OGenericUnoDialog::impl_ensureDialog_lck()
 167 {
 168     if ( m_pDialog )
 169         return true;
 170
 171     // get the parameters for the dialog from the current settings
 172
 173     // the parent window
 174     Window* pParent = NULL;
 175     VCLXWindow* pImplementation = VCLXWindow::GetImplementation(m_xParent);
 176     if (pImplementation)
 177         pParent = pImplementation->GetWindow();
 178
 179     // the title
 180     OUString sTitle = m_sTitle;
 181
 182     Dialog* pDialog = createDialog( pParent );
 183     OSL_ENSURE( pDialog, "OGenericUnoDialog::impl_ensureDialog_lck: createDialog returned nonsense!" );
 184     if ( !pDialog )
 185         return false;
 186
 187     // do some initialisations
 188     if ( !m_bTitleAmbiguous )
 189         pDialog->SetText( sTitle );
 190
 191     // be notified when the dialog is killed by somebody else
 192     // #i65958# / 2006-07-07 / frank.schoenheit@sun.com
 193     pDialog->AddEventListener( LINK( this, OGenericUnoDialog, OnDialogDying ) );
 194
 195     m_pDialog = pDialog;
 196
 197     return true;
 198 }
 199
 200 //-------------------------------------------------------------------------
 201 sal_Int16 SAL_CALL OGenericUnoDialog::execute(  ) throw(RuntimeException)
 202 {
 203     // both creation and execution of the dialog must be guarded with the SolarMutex, so be generous here
 204     SolarMutexGuard aSolarGuard;
 205
 206     Dialog* pDialogToExecute = NULL;
 207     // create the dialog, if necessary
 208     {
 209         UnoDialogEntryGuard aGuard( *this );
 210
 211         if (m_bExecuting)
 212             throw RuntimeException(
 213                     OUString( "already executing the dialog (recursive call)" ),
 214                     *this
 215                   );
 216
 217         m_bCanceled = sal_False;
 218         m_bExecuting = sal_True;
 219
 220         if ( !impl_ensureDialog_lck() )
 221             return 0;
 222
 223         pDialogToExecute = m_pDialog;
 224     }
 225
 226     // start execution
 227     sal_Int16 nReturn(0);
 228     if ( pDialogToExecute )
 229         nReturn = pDialogToExecute->Execute();
 230
 231     {
 232         ::osl::MutexGuard aExecutionGuard(m_aExecutionMutex);
 233         if (m_bCanceled)
 234             nReturn = RET_CANCEL;
 235     }
 236
 237     {
 238         ::osl::MutexGuard aGuard(m_aMutex);
 239
 240         // get the settings of the dialog
 241         executedDialog( nReturn );
 242
 243         m_bExecuting = sal_False;
 244     }
 245
 246     // outta here
 247     return nReturn;
 248 }
 249
 250 #ifdef AWT_DIALOG
 251 //-------------------------------------------------------------------------
 252 void SAL_CALL OGenericUnoDialog::endExecute(  ) throw(RuntimeException)
 253 {
 254     UnoDialogEntryGuard aGuard( *this );
 255     if (!m_bExecuting)
 256         throw RuntimeException();
 257
 258     {
 259         ::osl::MutexGuard aExecutionGuard(m_aExecutionMutex);
 260         OSL_ENSURE(m_pDialog, "OGenericUnoDialog::endExecute : executing which dialog ?");
 261             // m_bExecuting is true but we have no dialog ?
 262         if (!m_pDialog)
 263             throw RuntimeException();
 264
 265         if (!m_pDialog->IsInExecute())
 266             // we tighly missed it ... another thread finished the execution of the dialog,
 267             // but did not manage it to reset m_bExecuting, it currently tries to acquire
 268             // m_aMutex or m_aExecutionMutex
 269             // => nothing to do
 270             return;
 271
 272         m_pDialog->EndDialog(RET_CANCEL);
 273         m_bCanceled = sal_True;
 274     }
 275 }
 276 #endif
 277
 278 //-------------------------------------------------------------------------
 279 void OGenericUnoDialog::implInitialize(const Any& _rValue)
 280 {
 281     try
 282     {
 283         PropertyValue aProperty;
 284         NamedValue aValue;
 285         if ( _rValue >>= aProperty )
 286         {
 287             setPropertyValue( aProperty.Name, aProperty.Value );
 288         }
 289         else if ( _rValue >>= aValue )
 290         {
 291             setPropertyValue( aValue.Name, aValue.Value );
 292         }
 293     }
 294     catch(const Exception&)
 295     {
 296         DBG_UNHANDLED_EXCEPTION();
 297     }
 298 }
 299
 300 //-------------------------------------------------------------------------
 301 void SAL_CALL OGenericUnoDialog::initialize( const Sequence< Any >& aArguments ) throw(Exception, RuntimeException)
 302 {
 303     ::osl::MutexGuard aGuard( m_aMutex );
 304     if ( m_bInitialized )
 305         throw AlreadyInitializedException( OUString(), *this );
 306
 307     const Any* pArguments = aArguments.getConstArray();
 308     for (sal_Int32 i=0; i<aArguments.getLength(); ++i, ++pArguments)
 309         implInitialize(*pArguments);
 310
 311     m_bInitialized = true;
 312 }
 313
 314 //-------------------------------------------------------------------------
 315 void OGenericUnoDialog::destroyDialog()
 316 {
 317     delete m_pDialog;
 318     m_pDialog = NULL;
 319 }
 320
 321 //-------------------------------------------------------------------------
 322 IMPL_LINK( OGenericUnoDialog, OnDialogDying, VclWindowEvent*, _pEvent )
 323 {
 324     OSL_ENSURE( _pEvent->GetWindow() == m_pDialog, "OGenericUnoDialog::OnDialogDying: where does this come from?" );
 325     if ( _pEvent->GetId() == VCLEVENT_OBJECT_DYING )
 326         m_pDialog = NULL;
 327     return 0L;
 328 }
 329
 330 //.........................................................................
 331 }   // namespace svt
 332 //.........................................................................
 333
 334 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */