svtools/source/uno/wizard/unowizard.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 "../unowizard.hxx"
  22 #include "wizardshell.hxx"
  23
  24 #include <com/sun/star/lang/XInitialization.hpp>
  25 #include <com/sun/star/beans/XPropertySetInfo.hpp>
  26 #include <com/sun/star/uno/XComponentContext.hpp>
  27 #include <com/sun/star/ucb/AlreadyInitializedException.hpp>
  28 #include <com/sun/star/ui/dialogs/XWizardController.hpp>
  29 #include <com/sun/star/ui/dialogs/WizardButton.hpp>
  30
  31 #include <tools/diagnose_ex.h>
  32 #include <rtl/strbuf.hxx>
  33 #include <osl/mutex.hxx>
  34 #include <vcl/svapp.hxx>
  35 #include <tools/urlobj.hxx>
  36
  37 //......................................................................................................................
  38 namespace svt { namespace uno
  39 {
  40 //......................................................................................................................
  41
  42     using ::com::sun::star::uno::Reference;
  43     using ::com::sun::star::uno::XInterface;
  44     using ::com::sun::star::uno::UNO_QUERY;
  45     using ::com::sun::star::uno::UNO_QUERY_THROW;
  46     using ::com::sun::star::uno::UNO_SET_THROW;
  47     using ::com::sun::star::uno::Exception;
  48     using ::com::sun::star::uno::RuntimeException;
  49     using ::com::sun::star::uno::Any;
  50     using ::com::sun::star::uno::makeAny;
  51     using ::com::sun::star::uno::Sequence;
  52     using ::com::sun::star::uno::Type;
  53     using ::com::sun::star::lang::XServiceInfo;
  54     using ::com::sun::star::ui::dialogs::XWizard;
  55     using ::com::sun::star::lang::XInitialization;
  56     using ::com::sun::star::beans::XPropertySetInfo;
  57     using ::com::sun::star::uno::XComponentContext;
  58     using ::com::sun::star::beans::Property;
  59     using ::com::sun::star::lang::IllegalArgumentException;
  60     using ::com::sun::star::ucb::AlreadyInitializedException;
  61     using ::com::sun::star::ui::dialogs::XWizardController;
  62     using ::com::sun::star::ui::dialogs::XWizardPage;
  63     using ::com::sun::star::container::NoSuchElementException;
  64     using ::com::sun::star::util::InvalidStateException;
  65     using ::com::sun::star::awt::XWindow;
  66
  67     namespace WizardButton = ::com::sun::star::ui::dialogs::WizardButton;
  68
  69     //------------------------------------------------------------------------------------------------------------------
  70     namespace
  71     {
  72         sal_uInt32 lcl_convertWizardButtonToWZB( const sal_Int16 i_nWizardButton )
  73         {
  74             switch ( i_nWizardButton )
  75             {
  76             case WizardButton::NONE:        return WZB_NONE;
  77             case WizardButton::NEXT:        return WZB_NEXT;
  78             case WizardButton::PREVIOUS:    return WZB_PREVIOUS;
  79             case WizardButton::FINISH:      return WZB_FINISH;
  80             case WizardButton::CANCEL:      return WZB_CANCEL;
  81             case WizardButton::HELP:        return WZB_HELP;
  82             }
  83             OSL_FAIL( "lcl_convertWizardButtonToWZB: invalid WizardButton constant!" );
  84             return WZB_NONE;
  85         }
  86     }
  87
  88     //==================================================================================================================
  89     //= Wizard - implementation
  90     //==================================================================================================================
  91     //------------------------------------------------------------------------------------------------------------------
  92     Wizard::Wizard( const Reference< XComponentContext >& _rxContext )
  93         :Wizard_Base( _rxContext )
  94         ,m_aContext( _rxContext )
  95     {
  96     }
  97
  98     //--------------------------------------------------------------------
  99     Wizard::~Wizard()
 100     {
 101         // we do this here cause the base class' call to destroyDialog won't reach us anymore : we're within an dtor,
 102         // so this virtual-method-call the base class does does not work, we're already dead then ...
 103         if ( m_pDialog )
 104         {
 105             ::osl::MutexGuard aGuard( m_aMutex );
 106             if ( m_pDialog )
 107                 destroyDialog();
 108         }
 109     }
 110
 111     //--------------------------------------------------------------------
 112     Reference< XInterface > SAL_CALL Wizard::Create( const Reference< XComponentContext >& _rxContext )
 113     {
 114         return *(new Wizard( _rxContext ) );
 115     }
 116
 117     //--------------------------------------------------------------------
 118     namespace
 119     {
 120         static void lcl_checkPaths( const Sequence< Sequence< sal_Int16 > >& i_rPaths, const Reference< XInterface >& i_rContext )
 121         {
 122             // need at least one path
 123             if ( i_rPaths.getLength() == 0 )
 124                 throw IllegalArgumentException( OUString(), i_rContext, 2 );
 125
 126             // each path must be of length 1, at least
 127             for ( sal_Int32 i = 0; i < i_rPaths.getLength(); ++i )
 128             {
 129                 if ( i_rPaths[i].getLength() == 0 )
 130                     throw IllegalArgumentException( OUString(), i_rContext, 2 );
 131
 132                 // page IDs must be in ascending order
 133                 sal_Int16 nPreviousPageID = i_rPaths[i][0];
 134                 for ( sal_Int32 j=1; j<i_rPaths[i].getLength(); ++j )
 135                 {
 136                     if ( i_rPaths[i][j] <= nPreviousPageID )
 137                     {
 138                         OStringBuffer message;
 139                         message.append( "Path " );
 140                         message.append( i );
 141                         message.append( ": invalid page ID sequence - each page ID must be greater than the previous one." );
 142                         throw IllegalArgumentException(
 143                             OStringToOUString( message.makeStringAndClear(), RTL_TEXTENCODING_ASCII_US ),
 144                             i_rContext, 2 );
 145                     }
 146                     nPreviousPageID = i_rPaths[i][j];
 147                 }
 148             }
 149
 150             // if we have one path, that's okay
 151             if ( i_rPaths.getLength() == 1 )
 152                 return;
 153
 154             // if we have multiple paths, they must start with the same page id
 155             const sal_Int16 nFirstPageId = i_rPaths[0][0];
 156             for ( sal_Int32 i = 0; i < i_rPaths.getLength(); ++i )
 157             {
 158                 if ( i_rPaths[i][0] != nFirstPageId )
 159                     throw IllegalArgumentException(
 160                         OUString( "All paths must start with the same page id." ),
 161                         i_rContext, 2 );
 162             }
 163         }
 164     }
 165
 166     //--------------------------------------------------------------------
 167     void SAL_CALL Wizard::initialize( const Sequence< Any >& i_Arguments ) throw (Exception, RuntimeException)
 168     {
 169         ::osl::MutexGuard aGuard( m_aMutex );
 170         if ( m_bInitialized )
 171             throw AlreadyInitializedException( OUString(), *this );
 172
 173         if ( i_Arguments.getLength() != 2 )
 174             throw IllegalArgumentException( OUString(), *this, -1 );
 175
 176         // the second argument must be a XWizardController, for each constructor
 177         m_xController.set( i_Arguments[1], UNO_QUERY );
 178         if ( !m_xController.is() )
 179             throw IllegalArgumentException( OUString(), *this, 2 );
 180
 181         // the first arg is either a single path (short[]), or multiple paths (short[][])
 182         Sequence< sal_Int16 > aSinglePath;
 183         i_Arguments[0] >>= aSinglePath;
 184         Sequence< Sequence< sal_Int16 > > aMultiplePaths;
 185         i_Arguments[0] >>= aMultiplePaths;
 186
 187         if ( !aMultiplePaths.getLength() )
 188         {
 189             aMultiplePaths.realloc(1);
 190             aMultiplePaths[0] = aSinglePath;
 191         }
 192         lcl_checkPaths( aMultiplePaths, *this );
 193         // if we survived this, the paths are valid, and we're done here ...
 194         m_aWizardSteps = aMultiplePaths;
 195
 196         m_bInitialized = true;
 197     }
 198
 199     static OString lcl_getHelpId( const OUString& _rHelpURL )
 200     {
 201         INetURLObject aHID( _rHelpURL );
 202         if ( aHID.GetProtocol() == INET_PROT_HID )
 203             return OUStringToOString( aHID.GetURLPath(), RTL_TEXTENCODING_UTF8 );
 204         else
 205             return OUStringToOString( _rHelpURL, RTL_TEXTENCODING_UTF8 );
 206     }
 207
 208     //------------------------------------------------------------------------
 209     static OUString lcl_getHelpURL( const OString& sHelpId )
 210     {
 211         OUStringBuffer aBuffer;
 212         OUString aTmp(
 213             OStringToOUString( sHelpId, RTL_TEXTENCODING_UTF8 ) );
 214         INetURLObject aHID( aTmp );
 215         if ( aHID.GetProtocol() == INET_PROT_NOT_VALID )
 216             aBuffer.appendAscii( INET_HID_SCHEME );
 217         aBuffer.append( aTmp.getStr() );
 218         return aBuffer.makeStringAndClear();
 219     }
 220
 221     //--------------------------------------------------------------------
 222     Dialog* Wizard::createDialog( Window* i_pParent )
 223     {
 224         WizardShell* pDialog( new WizardShell( i_pParent, this, m_xController, m_aWizardSteps ) );
 225         pDialog->SetHelpId(  lcl_getHelpId( m_sHelpURL ) );
 226         pDialog->setTitleBase( m_sTitle );
 227         return pDialog;
 228     }
 229
 230     //--------------------------------------------------------------------
 231     void Wizard::destroyDialog()
 232     {
 233         if ( m_pDialog )
 234             m_sHelpURL = lcl_getHelpURL( m_pDialog->GetHelpId() );
 235
 236         Wizard_Base::destroyDialog();
 237     }
 238
 239     //--------------------------------------------------------------------
 240     OUString SAL_CALL Wizard::getImplementationName_static() throw(RuntimeException)
 241     {
 242         return OUString( "com.sun.star.comp.svtools.uno.Wizard" );
 243     }
 244
 245     //--------------------------------------------------------------------
 246     Sequence< OUString > SAL_CALL Wizard::getSupportedServiceNames_static() throw(RuntimeException)
 247     {
 248         Sequence< OUString > aServices(1);
 249         aServices[0] = OUString( "com.sun.star.ui.dialogs.Wizard" );
 250         return aServices;
 251     }
 252
 253     //--------------------------------------------------------------------
 254     OUString SAL_CALL Wizard::getImplementationName() throw(RuntimeException)
 255     {
 256         return getImplementationName_static();
 257     }
 258
 259     //--------------------------------------------------------------------
 260     Sequence< OUString > SAL_CALL Wizard::getSupportedServiceNames() throw(RuntimeException)
 261     {
 262         return getSupportedServiceNames_static();
 263     }
 264
 265     //--------------------------------------------------------------------
 266     Reference< XPropertySetInfo > SAL_CALL Wizard::getPropertySetInfo() throw(RuntimeException)
 267     {
 268         return createPropertySetInfo( getInfoHelper() );
 269     }
 270
 271     //--------------------------------------------------------------------
 272     ::cppu::IPropertyArrayHelper& SAL_CALL Wizard::getInfoHelper()
 273     {
 274         return *const_cast< Wizard* >( this )->getArrayHelper();
 275     }
 276
 277     //--------------------------------------------------------------------
 278     ::cppu::IPropertyArrayHelper* Wizard::createArrayHelper( ) const
 279     {
 280         Sequence< Property > aProps;
 281         describeProperties( aProps );
 282         return new ::cppu::OPropertyArrayHelper( aProps );
 283     }
 284
 285     //------------------------------------------------------------------------------------------------------------------
 286     OUString SAL_CALL Wizard::getHelpURL() throw (RuntimeException)
 287     {
 288         SolarMutexGuard aSolarGuard;
 289         ::osl::MutexGuard aGuard( m_aMutex );
 290
 291         if ( !m_pDialog )
 292             return m_sHelpURL;
 293
 294         return lcl_getHelpURL( m_pDialog->GetHelpId() );
 295     }
 296
 297     //------------------------------------------------------------------------------------------------------------------
 298     void SAL_CALL Wizard::setHelpURL( const OUString& i_HelpURL ) throw (RuntimeException)
 299     {
 300         SolarMutexGuard aSolarGuard;
 301         ::osl::MutexGuard aGuard( m_aMutex );
 302
 303         if ( !m_pDialog )
 304             m_sHelpURL = i_HelpURL;
 305         else
 306             m_pDialog->SetHelpId( lcl_getHelpId( i_HelpURL ) );
 307     }
 308
 309     //------------------------------------------------------------------------------------------------------------------
 310     Reference< XWindow > SAL_CALL Wizard::getDialogWindow() throw (RuntimeException)
 311     {
 312         SolarMutexGuard aSolarGuard;
 313         ::osl::MutexGuard aGuard( m_aMutex );
 314
 315         ENSURE_OR_RETURN( m_pDialog, "Wizard::getDialogWindow: illegal call (execution did not start, yet)!", NULL );
 316         return Reference< XWindow >( m_pDialog->GetComponentInterface(), UNO_QUERY );
 317     }
 318
 319     //------------------------------------------------------------------------------------------------------------------
 320     void SAL_CALL Wizard::enableButton( ::sal_Int16 i_WizardButton, ::sal_Bool i_Enable ) throw (RuntimeException)
 321     {
 322         SolarMutexGuard aSolarGuard;
 323         ::osl::MutexGuard aGuard( m_aMutex );
 324
 325         WizardShell* pWizardImpl = dynamic_cast< WizardShell* >( m_pDialog );
 326         ENSURE_OR_RETURN_VOID( pWizardImpl, "Wizard::enableButtons: invalid dialog implementation!" );
 327
 328         pWizardImpl->enableButtons( lcl_convertWizardButtonToWZB( i_WizardButton ), i_Enable );
 329     }
 330
 331     //------------------------------------------------------------------------------------------------------------------
 332     void SAL_CALL Wizard::setDefaultButton( ::sal_Int16 i_WizardButton ) throw (RuntimeException)
 333     {
 334         SolarMutexGuard aSolarGuard;
 335         ::osl::MutexGuard aGuard( m_aMutex );
 336
 337         WizardShell* pWizardImpl = dynamic_cast< WizardShell* >( m_pDialog );
 338         ENSURE_OR_RETURN_VOID( pWizardImpl, "Wizard::setDefaultButton: invalid dialog implementation!" );
 339
 340         pWizardImpl->defaultButton( lcl_convertWizardButtonToWZB( i_WizardButton ) );
 341     }
 342
 343     //------------------------------------------------------------------------------------------------------------------
 344     sal_Bool SAL_CALL Wizard::travelNext(  ) throw (RuntimeException)
 345     {
 346         SolarMutexGuard aSolarGuard;
 347         ::osl::MutexGuard aGuard( m_aMutex );
 348
 349         WizardShell* pWizardImpl = dynamic_cast< WizardShell* >( m_pDialog );
 350         ENSURE_OR_RETURN_FALSE( pWizardImpl, "Wizard::travelNext: invalid dialog implementation!" );
 351
 352         return pWizardImpl->travelNext();
 353     }
 354
 355     //------------------------------------------------------------------------------------------------------------------
 356     sal_Bool SAL_CALL Wizard::travelPrevious(  ) throw (RuntimeException)
 357     {
 358         SolarMutexGuard aSolarGuard;
 359         ::osl::MutexGuard aGuard( m_aMutex );
 360
 361         WizardShell* pWizardImpl = dynamic_cast< WizardShell* >( m_pDialog );
 362         ENSURE_OR_RETURN_FALSE( pWizardImpl, "Wizard::travelPrevious: invalid dialog implementation!" );
 363
 364         return pWizardImpl->travelPrevious();
 365     }
 366
 367     //------------------------------------------------------------------------------------------------------------------
 368     void SAL_CALL Wizard::enablePage( ::sal_Int16 i_PageID, ::sal_Bool i_Enable ) throw (NoSuchElementException, InvalidStateException, RuntimeException)
 369     {
 370         SolarMutexGuard aSolarGuard;
 371         ::osl::MutexGuard aGuard( m_aMutex );
 372
 373         WizardShell* pWizardImpl = dynamic_cast< WizardShell* >( m_pDialog );
 374         ENSURE_OR_RETURN_VOID( pWizardImpl, "Wizard::enablePage: invalid dialog implementation!" );
 375
 376         if ( !pWizardImpl->knowsPage( i_PageID ) )
 377             throw NoSuchElementException( OUString(), *this );
 378
 379         if ( i_PageID == pWizardImpl->getCurrentPage() )
 380             throw InvalidStateException( OUString(), *this );
 381
 382         pWizardImpl->enablePage( i_PageID, i_Enable );
 383     }
 384
 385     //------------------------------------------------------------------------------------------------------------------
 386     void SAL_CALL Wizard::updateTravelUI(  ) throw (RuntimeException)
 387     {
 388         SolarMutexGuard aSolarGuard;
 389         ::osl::MutexGuard aGuard( m_aMutex );
 390
 391         WizardShell* pWizardImpl = dynamic_cast< WizardShell* >( m_pDialog );
 392         ENSURE_OR_RETURN_VOID( pWizardImpl, "Wizard::updateTravelUI: invalid dialog implementation!" );
 393
 394         pWizardImpl->updateTravelUI();
 395     }
 396
 397     //------------------------------------------------------------------------------------------------------------------
 398     ::sal_Bool SAL_CALL Wizard::advanceTo( ::sal_Int16 i_PageId ) throw (RuntimeException)
 399     {
 400         SolarMutexGuard aSolarGuard;
 401         ::osl::MutexGuard aGuard( m_aMutex );
 402
 403         WizardShell* pWizardImpl = dynamic_cast< WizardShell* >( m_pDialog );
 404         ENSURE_OR_RETURN_FALSE( pWizardImpl, "Wizard::advanceTo: invalid dialog implementation!" );
 405
 406         return pWizardImpl->advanceTo( i_PageId );
 407     }
 408
 409     //------------------------------------------------------------------------------------------------------------------
 410     ::sal_Bool SAL_CALL Wizard::goBackTo( ::sal_Int16 i_PageId ) throw (RuntimeException)
 411     {
 412         SolarMutexGuard aSolarGuard;
 413         ::osl::MutexGuard aGuard( m_aMutex );
 414
 415         WizardShell* pWizardImpl = dynamic_cast< WizardShell* >( m_pDialog );
 416         ENSURE_OR_RETURN_FALSE( pWizardImpl, "Wizard::goBackTo: invalid dialog implementation!" );
 417
 418         return pWizardImpl->goBackTo( i_PageId );
 419     }
 420
 421     //------------------------------------------------------------------------------------------------------------------
 422     Reference< XWizardPage > SAL_CALL Wizard::getCurrentPage(  ) throw (RuntimeException)
 423     {
 424         SolarMutexGuard aSolarGuard;
 425         ::osl::MutexGuard aGuard( m_aMutex );
 426
 427         WizardShell* pWizardImpl = dynamic_cast< WizardShell* >( m_pDialog );
 428         ENSURE_OR_RETURN( pWizardImpl, "Wizard::getCurrentPage: invalid dialog implementation!", Reference< XWizardPage >() );
 429
 430         return pWizardImpl->getCurrentWizardPage();
 431     }
 432
 433     //------------------------------------------------------------------------------------------------------------------
 434     void SAL_CALL Wizard::activatePath( ::sal_Int16 i_PathIndex, ::sal_Bool i_Final ) throw (NoSuchElementException, InvalidStateException, RuntimeException)
 435     {
 436         SolarMutexGuard aSolarGuard;
 437         ::osl::MutexGuard aGuard( m_aMutex );
 438
 439         if ( ( i_PathIndex < 0 ) || ( i_PathIndex >= m_aWizardSteps.getLength() ) )
 440             throw NoSuchElementException( OUString(), *this );
 441
 442         WizardShell* pWizardImpl = dynamic_cast< WizardShell* >( m_pDialog );
 443         ENSURE_OR_RETURN_VOID( pWizardImpl, "Wizard::activatePath: invalid dialog implementation!" );
 444
 445         pWizardImpl->activatePath( i_PathIndex, i_Final );
 446     }
 447
 448     //------------------------------------------------------------------------------------------------------------------
 449     void SAL_CALL Wizard::setTitle( const OUString& i_Title ) throw (RuntimeException)
 450     {
 451         // simply disambiguate
 452         Wizard_Base::OGenericUnoDialog::setTitle( i_Title );
 453     }
 454
 455     //------------------------------------------------------------------------------------------------------------------
 456     ::sal_Int16 SAL_CALL Wizard::execute(  ) throw (RuntimeException)
 457     {
 458         return Wizard_Base::OGenericUnoDialog::execute();
 459     }
 460
 461 //......................................................................................................................
 462 } } // namespace svt::uno
 463 //......................................................................................................................
 464
 465 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */