closedispatcher.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 <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/frame/XStatusListener.hpp>
#include <com/sun/star/frame/XNotifyingDispatch.hpp>
#include <com/sun/star/frame/XDispatchInformationProvider.hpp>
#include <com/sun/star/util/URL.hpp>
#include <com/sun/star/frame/XDispatchResultListener.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
 
#include <memory>
#include <cppuhelper/implbase.hxx>
#include <cppuhelper/weakref.hxx>
#include <vcl/evntpost.hxx>
#include <vcl/vclptr.hxx>
 
class SystemWindow;
 
namespace framework{
 
class CloseDispatcher final : public  ::cppu::WeakImplHelper<
                                    css::frame::XNotifyingDispatch,             // => XDispatch
                                    css::frame::XDispatchInformationProvider >
{
 
    // types
 
    private:
 
        enum EOperation
        {
            E_CLOSE_DOC,
            E_CLOSE_FRAME,
            E_CLOSE_WIN
        };
 
    // member
 
    private:
 
        css::uno::Reference< css::uno::XComponentContext > m_xContext;
 
        css::uno::WeakReference< css::frame::XFrame > m_xCloseFrame;
 
        std::unique_ptr<vcl::EventPoster> m_aAsyncCallback;
 
        EOperation m_eOperation;
 
        css::uno::Reference< css::uno::XInterface > m_xSelfHold;
 
        css::uno::Reference< css::frame::XDispatchResultListener > m_xResultListener;
 
        VclPtr<SystemWindow> m_pSysWindow;
 
    // native interface
 
    public:
 
        CloseDispatcher(css::uno::Reference< css::uno::XComponentContext >        xContext  ,
                        const css::uno::Reference< css::frame::XFrame >&          xFrame ,
                        std::u16string_view                                       sTarget);
 
        virtual ~CloseDispatcher() override;
 
    // uno interface
 
    public:
 
        // XNotifyingDispatch
        virtual void SAL_CALL dispatchWithNotification( const css::util::URL&                                             aURL      ,
                                                        const css::uno::Sequence< css::beans::PropertyValue >&            lArguments,
                                                        const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) override;
 
        // XDispatch
        virtual void SAL_CALL dispatch            ( const css::util::URL&                                     aURL      ,
                                                    const css::uno::Sequence< css::beans::PropertyValue >&    lArguments) override;
        virtual void SAL_CALL addStatusListener   ( const css::uno::Reference< css::frame::XStatusListener >& xListener ,
                                                    const css::util::URL&                                     aURL      ) override;
        virtual void SAL_CALL removeStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xListener ,
                                                    const css::util::URL&                                     aURL      ) override;
 
        // XDispatchInformationProvider
        virtual css::uno::Sequence< sal_Int16 >                       SAL_CALL getSupportedCommandGroups         (                         ) override;
        virtual css::uno::Sequence< css::frame::DispatchInformation > SAL_CALL getConfigurableDispatchInformation( sal_Int16 nCommandGroup ) override;
 
    // internal helper
 
    private:
 
        DECL_LINK( impl_asyncCallback, LinkParamNone*, void );
 
        bool implts_prepareFrameForClosing(const css::uno::Reference< css::frame::XFrame >& xFrame,
                                           bool                                   bCloseAllOtherViewsToo,
                                           bool&                                  bControllerSuspended  );
 
        bool implts_closeFrame();
 
        bool implts_establishBackingMode();
 
        bool implts_terminateApplication();
 
        void implts_notifyResultListener(const css::uno::Reference< css::frame::XDispatchResultListener >& xListener,
                                               sal_Int16                                                   nState   ,
                                         const css::uno::Any&                                              aResult  );
 
        static css::uno::Reference< css::frame::XFrame > static_impl_searchRightTargetFrame(const css::uno::Reference< css::frame::XFrame >& xFrame ,
                                                                                            std::u16string_view                        sTarget);
 
}; // class CloseDispatcher
 
} // namespace framework
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */