genericunodialog.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#pragma once
 
#include <svtools/svtdllapi.h>
 
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XInitialization.hpp>
#include <com/sun/star/ui/dialogs/XExecutableDialog.hpp>
 
#include <cppuhelper/implbase.hxx>
#include <comphelper/uno3.hxx>
#include <comphelper/propertycontainer.hxx>
#include <comphelper/broadcasthelper.hxx>
#include <vcl/weld.hxx>
 
namespace com :: sun :: star :: awt { class XWindow; }
namespace com :: sun :: star :: uno { class XComponentContext; }
 
class VclWindowEvent;
 
 
namespace svt
{
 
 
#define     UNODIALOG_PROPERTY_ID_TITLE     1
#define     UNODIALOG_PROPERTY_ID_PARENT    2
 
inline constexpr OUStringLiteral UNODIALOG_PROPERTY_TITLE = u"Title";
inline constexpr OUStringLiteral UNODIALOG_PROPERTY_PARENT = u"ParentWindow";
 
    typedef cppu::WeakImplHelper< css::ui::dialogs::XExecutableDialog,
                                  css::lang::XServiceInfo,
                                  css::lang::XInitialization > OGenericUnoDialogBase;
 
    class SVT_DLLPUBLIC OGenericUnoDialog
            :public OGenericUnoDialogBase
            ,public ::comphelper::OMutexAndBroadcastHelper
            ,public ::comphelper::OPropertyContainer
    {
    protected:
        std::unique_ptr<weld::DialogController> m_xDialog;      
        bool                        m_bExecuting : 1;           
        bool                        m_bTitleAmbiguous : 1;      
        bool                        m_bInitialized : 1;         
 
        // <properties>
        OUString                                         m_sTitle;   
        css::uno::Reference<css::awt::XWindow>           m_xParent;  
        // </properties>
 
        css::uno::Reference<css::uno::XComponentContext> m_aContext;
 
    protected:
        OGenericUnoDialog(const css::uno::Reference< css::uno::XComponentContext >& _rxContext);
        virtual ~OGenericUnoDialog() override;
 
    public:
        // UNO
        DECLARE_UNO3_DEFAULTS(OGenericUnoDialog, OGenericUnoDialogBase)
        virtual css::uno::Any SAL_CALL queryInterface(const css::uno::Type& _rType) override;
 
        // XTypeProvider
        virtual css::uno::Sequence<css::uno::Type> SAL_CALL getTypes(  ) override;
        virtual css::uno::Sequence<sal_Int8> SAL_CALL getImplementationId(  ) override = 0;
 
        // XServiceInfo
        virtual OUString SAL_CALL getImplementationName() override = 0;
        virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
        virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override = 0;
 
        // OPropertySetHelper
        virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const css::uno::Any& rValue ) override;
        virtual sal_Bool SAL_CALL convertFastPropertyValue( css::uno::Any& rConvertedValue, css::uno::Any& rOldValue, sal_Int32 nHandle, const css::uno::Any& rValue) override;
 
        // XExecutableDialog
        virtual void SAL_CALL setTitle( const OUString& aTitle ) override;
        virtual sal_Int16 SAL_CALL execute(  ) override;
 
        // XInitialization
        virtual void SAL_CALL initialize( const css::uno::Sequence< css::uno::Any >& aArguments ) override;
 
    protected:
        virtual std::unique_ptr<weld::DialogController> createDialog(const css::uno::Reference<css::awt::XWindow>& rParent) = 0;
 
        void destroyDialog();
 
        virtual void executedDialog(sal_Int16 /*_nExecutionResult*/) { }
 
        virtual void implInitialize(const css::uno::Any& _rValue);
 
    private:
 
        bool    impl_ensureDialog_lck();
    };
 
    class UnoDialogEntryGuard
    {
    public:
        UnoDialogEntryGuard( OGenericUnoDialog& _rDialog )
            :m_aGuard( _rDialog.GetMutex() )
        {
        }
 
    private:
        ::osl::MutexGuard   m_aGuard;
    };
 
 
}   // namespace svt
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */