include/svtools/genericunodialog.hxx

   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 #ifndef INCLUDED_SVTOOLS_GENERICUNODIALOG_HXX
  21 #define INCLUDED_SVTOOLS_GENERICUNODIALOG_HXX
  22
  23 #include <svtools/svtdllapi.h>
  24
  25 #include <com/sun/star/lang/XServiceInfo.hpp>
  26 #include <com/sun/star/lang/XInitialization.hpp>
  27 #include <com/sun/star/awt/XWindow.hpp>
  28 #include <com/sun/star/uno/XComponentContext.hpp>
  29 #include <com/sun/star/ui/dialogs/XExecutableDialog.hpp>
  30 #include <com/sun/star/beans/PropertyValue.hpp>
  31 #include <com/sun/star/beans/PropertyAttribute.hpp>
  32 #include <com/sun/star/lang/NotInitializedException.hpp>
  33
  34 #include <cppuhelper/implbase3.hxx>
  35 #include <cppuhelper/propshlp.hxx>
  36 #include <comphelper/proparrhlp.hxx>
  37 #include <comphelper/uno3.hxx>
  38 #include <comphelper/propertycontainer.hxx>
  39 #include <comphelper/broadcasthelper.hxx>
  40 #include <tools/link.hxx>
  41 #include <vcl/vclptr.hxx>
  42
  43 class Dialog;
  44 namespace vcl { class Window; }
  45 class VclWindowEvent;
  46
  47
  48 namespace svt
  49 {
  50
  51
  52
  53 #define     UNODIALOG_PROPERTY_ID_TITLE     1
  54 #define     UNODIALOG_PROPERTY_ID_PARENT    2
  55
  56 #define     UNODIALOG_PROPERTY_TITLE        "Title"
  57 #define     UNODIALOG_PROPERTY_PARENT       "ParentWindow"
  58
  59
  60
  61     typedef ::cppu::WeakImplHelper3 <   com::sun::star::ui::dialogs::XExecutableDialog
  62                                     ,   com::sun::star::lang::XServiceInfo
  63                                     ,   com::sun::star::lang::XInitialization
  64                                     >   OGenericUnoDialogBase;
  65
  66     /** abstract base class for implementing UNO objects representing dialogs (com.sun.star.awt::XDialog)
  67     */
  68     class SVT_DLLPUBLIC OGenericUnoDialog
  69             :public OGenericUnoDialogBase
  70             ,public ::comphelper::OMutexAndBroadcastHelper
  71             ,public ::comphelper::OPropertyContainer
  72     {
  73     private:
  74         ::osl::Mutex                    m_aExecutionMutex;  /// access safety for execute/cancel
  75
  76     protected:
  77         VclPtr<Dialog>              m_pDialog;                  /// the dialog to execute
  78         bool                        m_bExecuting : 1;           /// we're currently executing the dialog
  79         bool                        m_bCanceled : 1;            /// endDialog was called while we were executing
  80         bool                        m_bTitleAmbiguous : 1;      /// m_sTitle has not been set yet
  81         bool                        m_bInitialized : 1;         /// has "initialize" been called?
  82         bool                        m_bNeedInitialization : 1;  /// do we need to be initialized before any other API call is allowed?
  83
  84         // <properties>
  85         OUString                                                 m_sTitle;   /// title of the dialog
  86         com::sun::star::uno::Reference<com::sun::star::awt::XWindow>    m_xParent;  /// parent window
  87         // </properties>
  88
  89         com::sun::star::uno::Reference<com::sun::star::uno::XComponentContext> m_aContext;
  90
  91     public:
  92         inline bool needInitialization() const { return m_bNeedInitialization && !m_bInitialized; }
  93
  94     protected:
  95         OGenericUnoDialog(const com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext >& _rxContext);
  96         virtual ~OGenericUnoDialog();
  97
  98     public:
  99         // UNO
 100         DECLARE_UNO3_DEFAULTS(OGenericUnoDialog, OGenericUnoDialogBase)
 101         virtual com::sun::star::uno::Any SAL_CALL queryInterface(const com::sun::star::uno::Type& _rType) throw (com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 102
 103         // XTypeProvider
 104         virtual com::sun::star::uno::Sequence<com::sun::star::uno::Type> SAL_CALL getTypes(  ) throw(com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 105         virtual com::sun::star::uno::Sequence<sal_Int8> SAL_CALL getImplementationId(  ) throw(com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE = 0;
 106
 107         // XServiceInfo
 108         virtual OUString SAL_CALL getImplementationName() throw(com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE = 0;
 109         virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) throw(com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 110         virtual ::comphelper::StringSequence SAL_CALL getSupportedServiceNames() throw(com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE = 0;
 111
 112         // OPropertySetHelper
 113         virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const com::sun::star::uno::Any& rValue ) throw(com::sun::star::uno::Exception, std::exception) SAL_OVERRIDE;
 114         virtual sal_Bool SAL_CALL convertFastPropertyValue( com::sun::star::uno::Any& rConvertedValue, com::sun::star::uno::Any& rOldValue, sal_Int32 nHandle, const com::sun::star::uno::Any& rValue) throw(com::sun::star::lang::IllegalArgumentException) SAL_OVERRIDE;
 115
 116         // XExecutableDialog
 117         virtual void SAL_CALL setTitle( const OUString& aTitle ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 118         virtual sal_Int16 SAL_CALL execute(  ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 119
 120         // XInitialization
 121         virtual void SAL_CALL initialize( const com::sun::star::uno::Sequence< com::sun::star::uno::Any >& aArguments ) throw(com::sun::star::uno::Exception, com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 122
 123     protected:
 124         /** create the concret dialog instance. note that m_aMutex is not locked when this method get's called,
 125             but the application-wide solar mutex is (to guard the not thread-safe ctor of the dialog).
 126             @param      pParent     the parent window for the new dialog
 127         */
 128         virtual VclPtr<Dialog> createDialog(vcl::Window* _pParent) = 0;
 129
 130         /// called to destroy the dialog used. the default implementation just deletes m_pDialog and resets it to NULL
 131         virtual void destroyDialog();
 132
 133         /** called after the dialog has been executed
 134             @param      _nExecutionResult       the execution result as returned by Dialog::Execute
 135         */
 136         virtual void executedDialog(sal_Int16 /*_nExecutionResult*/) { }
 137
 138         /** smaller form of <method>initialize</method>.<p/>
 139             The <method>initialize</method> method is called with a sequence of com.sun.star.uno::Any's,
 140             which is split up into the single elements, which are passed to implInitialize. The default implementation
 141             tries to exract an com.sun.star.beans::PropertyValue from the value an pass it to the
 142             com.sun.star.beans::XPropertySet interface of the object.
 143         */
 144         virtual void implInitialize(const com::sun::star::uno::Any& _rValue);
 145
 146     private:
 147         DECL_LINK( OnDialogDying, VclWindowEvent* );
 148
 149         /** ensures that m_pDialog is not <NULL/>
 150
 151             This method does nothing if m_pDialog is already non-<NULL/>. Else, it calls createDialog and does
 152             all necessary initializations of the new dialog instance.
 153
 154             @precond
 155                 m_aMutex is locked
 156
 157             @return
 158                 <TRUE/> if and only if m_pDialog is non-<NULL/> upon returning from the method. Note that the only
 159                 case where m_pDialog is <NULL/> is when createDialog returned <NULL/>, which is will fire an assertion
 160                 in non-product builds.
 161         */
 162         bool    impl_ensureDialog_lck();
 163     };
 164
 165     /// helper class for guarding access to methods of a OGenericUnoDialog
 166     class UnoDialogEntryGuard
 167     {
 168     public:
 169         UnoDialogEntryGuard( OGenericUnoDialog& _rDialog )
 170             :m_aGuard( _rDialog.GetMutex() )
 171         {
 172             if ( _rDialog.needInitialization() )
 173                 throw ::com::sun::star::lang::NotInitializedException();
 174         }
 175
 176     private:
 177         ::osl::MutexGuard   m_aGuard;
 178     };
 179
 180
 181 }   // namespace svt
 182
 183
 184 #endif // INCLUDED_SVTOOLS_GENERICUNODIALOG_HXX
 185
 186 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */