FrameworkHelper.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 <ViewShell.hxx>
 
#include <tools/SdGlobalResourceContainer.hxx>
 
#include <functional>
#include <map>
#include <memory>
#include <mutex>
 
namespace com::sun::star::drawing::framework { class XConfigurationController; }
namespace com::sun::star::drawing::framework { class XResourceId; }
namespace com::sun::star::drawing::framework { class XView; }
namespace com::sun::star::drawing::framework { struct ConfigurationChangeEvent; }
 
namespace sd {
class ViewShellBase;
}
 
 
namespace sd::framework {
 
class FrameworkHelper final
    : public std::enable_shared_from_this<FrameworkHelper>,
      public SdGlobalResource
{
public:
    // URLs of frequently used panes.
    static constexpr OUStringLiteral msPaneURLPrefix = u"private:resource/pane/";
    static const OUString msCenterPaneURL;
    static const OUString msFullScreenPaneURL;
    static const OUString msLeftImpressPaneURL;
    static const OUString msLeftDrawPaneURL;
 
    // URLs of frequently used views.
    static constexpr OUStringLiteral msViewURLPrefix = u"private:resource/view/";
    static const OUString msImpressViewURL;
    static const OUString msDrawViewURL;
    static const OUString msOutlineViewURL;
    static const OUString msNotesViewURL;
    static const OUString msHandoutViewURL;
    static const OUString msSlideSorterURL;
    static const OUString msPresentationViewURL;
    static const OUString msSidebarViewURL;
 
    // URLs of frequently used tool bars.
    static constexpr OUStringLiteral msToolBarURLPrefix = u"private:resource/toolbar/";
    static const OUString msViewTabBarURL;
 
    // Names of frequently used events.
    static constexpr OUStringLiteral msResourceActivationRequestEvent
        = u"ResourceActivationRequested";
    static constexpr OUStringLiteral msResourceDeactivationRequestEvent
        = u"ResourceDeactivationRequest";
    static constexpr OUStringLiteral msResourceActivationEvent = u"ResourceActivation";
    static constexpr OUStringLiteral msResourceDeactivationEvent = u"ResourceDeactivation";
    static constexpr OUStringLiteral msResourceDeactivationEndEvent = u"ResourceDeactivationEnd";
    static constexpr OUStringLiteral msConfigurationUpdateStartEvent = u"ConfigurationUpdateStart";
    static constexpr OUStringLiteral msConfigurationUpdateEndEvent = u"ConfigurationUpdateEnd";
 
    static ::std::shared_ptr<FrameworkHelper> Instance (ViewShellBase& rBase);
 
    static void DisposeInstance (const ViewShellBase& rBase);
 
    static void ReleaseInstance (const ViewShellBase& rBase);
 
    static ViewShell::ShellType GetViewId (const OUString& rsViewURL);
 
    static OUString GetViewURL (ViewShell::ShellType eType);
 
    static ::std::shared_ptr<ViewShell> GetViewShell (
        const css::uno::Reference<css::drawing::framework::XView>& rxView);
 
    typedef ::std::function<bool (const css::drawing::framework::ConfigurationChangeEvent&)>
        ConfigurationChangeEventFilter;
    typedef ::std::function<void (bool bEventSeen)> Callback;
    typedef ::std::function<
        void (
            const css::uno::Reference<
                css::drawing::framework::XResourceId>&)
        > ResourceFunctor;
 
    bool IsValid() const;
 
    ::std::shared_ptr<ViewShell> GetViewShell (const OUString& rsPaneURL);
 
    css::uno::Reference<css::drawing::framework::XView> GetView (
        const css::uno::Reference<css::drawing::framework::XResourceId>& rxPaneOrViewId);
 
    css::uno::Reference<css::drawing::framework::XResourceId> RequestView (
        const OUString& rsResourceURL,
        const OUString& rsAnchorURL);
 
    void HandleModeChangeSlot (
        sal_uInt16 nSlotId,
        SfxRequest const & rRequest);
 
    void RunOnConfigurationEvent(
        const OUString& rsEventType,
        const Callback& rCallback);
 
    void RunOnResourceActivation(
        const css::uno::Reference<css::drawing::framework::XResourceId>& rxResourceId,
        const Callback& rCallback);
 
    void RequestSynchronousUpdate();
 
    void WaitForEvent (const OUString& rsEventName) const;
 
    void WaitForUpdate() const;
 
    void UpdateConfiguration();
 
    static OUString ResourceIdToString (
        const css::uno::Reference<
            css::drawing::framework::XResourceId>& rxResourceId);
 
    static css::uno::Reference<
        css::drawing::framework::XResourceId>
            CreateResourceId (
                const OUString& rsResourceURL);
 
    static css::uno::Reference<
        css::drawing::framework::XResourceId>
            CreateResourceId (
                const OUString& rsResourceURL,
                const OUString& rsAnchorURL);
 
    static css::uno::Reference<
        css::drawing::framework::XResourceId>
            CreateResourceId (
                const OUString& rsResourceURL,
                const css::uno::Reference<
                    css::drawing::framework::XResourceId>& rxAnchor);
 
    const css::uno::Reference<css::drawing::framework::XConfigurationController>&
        GetConfigurationController() const { return mxConfigurationController;}
 
private:
    typedef ::std::map<
        const ViewShellBase*,
        ::std::shared_ptr<FrameworkHelper> > InstanceMap;
    static InstanceMap maInstanceMap;
    class ViewURLMap;
    static ViewURLMap maViewURLMap;
    static std::mutex maInstanceMapMutex;
 
    ViewShellBase& mrBase;
    css::uno::Reference<css::drawing::framework::XConfigurationController>
        mxConfigurationController;
 
    class DisposeListener;
    friend class DisposeListener;
    css::uno::Reference<css::lang::XComponent>
        mxDisposeListener;
 
    FrameworkHelper (ViewShellBase& rBase);
    FrameworkHelper (const FrameworkHelper& rHelper) = delete;
    virtual ~FrameworkHelper() override;
    class Deleter; friend class Deleter;
    FrameworkHelper& operator= (const FrameworkHelper& rHelper) = delete;
 
    void Initialize();
 
    void Dispose();
 
    void RunOnEvent(
        const OUString& rsEventType,
        const ConfigurationChangeEventFilter& rFilter,
        const Callback& rCallback) const;
 
    void disposing (const css::lang::EventObject& rEventObject);
};
 
} // end of namespace sd::framework
 
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */