lokhelper.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/.
 */
 
#ifndef INCLUDED_SFX2_LOKHELPER_HXX
#define INCLUDED_SFX2_LOKHELPER_HXX
 
#include <vcl/IDialogRenderable.hxx>
#include <vcl/ITiledRenderable.hxx>
#include <vcl/event.hxx>
#include <vcl/vclptr.hxx>
#include <vcl/window.hxx>
#include <sfx2/dllapi.h>
#include <sfx2/viewsh.hxx>
#include <tools/gen.hxx>
#include <cstddef>
#include <rtl/strbuf.hxx>
#include <rtl/string.hxx>
#include <optional>
#include <string_view>
#include <sfx2/app.hxx>
 
struct SFX2_DLLPUBLIC LokMouseEventData
{
    int mnType;
    Point maPosition;
    int mnCount;
    MouseEventModifiers meModifiers;
    int mnButtons;
    int mnModifier;
    std::optional<Point> maLogicPosition;
 
    LokMouseEventData(int nType, Point aPosition, int nCount, MouseEventModifiers eModifiers, int nButtons, int nModifier)
        : mnType(nType)
        , maPosition(aPosition)
        , mnCount(nCount)
        , meModifiers(eModifiers)
        , mnButtons(nButtons)
        , mnModifier(nModifier)
    {}
};
 
#include <boost/property_tree/ptree_fwd.hpp>
 
namespace com::sun::star::ui { struct ContextChangeEventObject; };
 
class SFX2_DLLPUBLIC SfxLokHelper
{
public:
    static std::unordered_map<OUString, css::uno::Reference<com::sun::star::ui::XAcceleratorConfiguration>>& getAcceleratorConfs();
    static int createView();
    static int createView(int nDocId);
    static void destroyView(int nId);
    static void setView(int nId);
    static void setEditMode(int nMode, vcl::ITiledRenderable* pDoc);
    static SfxViewShell* getViewOfId(int nId);
    static int getView(const SfxViewShell* pViewShell = nullptr);
    static std::size_t getViewsCount(int nDocId);
    static bool getViewIds(int nDocId, int* pArray, size_t nSize);
    static void setBlockedCommandList(int nViewId, const char* blockedCommandList);
    static int getDocumentIdOfView(int nViewId);
    static const LanguageTag & getDefaultLanguage();
    static void setViewLanguage(int nId, const OUString& rBcp47LanguageTag);
    static void setDefaultLanguage(const OUString& rBcp47LanguageTag);
    static void setAccessibilityState(int nId, bool nEnabled);
    static const LanguageTag & getLoadLanguage();
    static void setLoadLanguage(const OUString& rBcp47LanguageTag);
    static void setViewLocale(int nId, const OUString& rBcp47LanguageTag);
    static LOKDeviceFormFactor getDeviceFormFactor();
    static void setDeviceFormFactor(std::u16string_view rDeviceFormFactor);
 
    static void setDefaultTimezone(bool isSet, const OUString& rTimezone);
    static std::pair<bool, OUString> getDefaultTimezone();
    static void setViewTimezone(int nId, bool isSet, const OUString& rTimezone);
    static std::pair<bool, OUString> getViewTimezone(int nId);
 
    template<typename ViewShellType, typename FunctionType>
    static void forEachOtherView(ViewShellType* pThisViewShell, FunctionType f);
 
    static void notifyOtherViews(const SfxViewShell* pThisView, int nType, std::string_view rKey,
                                 const OString& rPayload);
    static void notifyOtherViews(const SfxViewShell* pThisView, int nType,
                                 const boost::property_tree::ptree& rTree);
    static void notifyOtherView(const SfxViewShell* pThisView, SfxViewShell const* pOtherView,
                                int nType, std::string_view rKey, const OString& rPayload);
    static void notifyOtherView(const SfxViewShell* pThisView, SfxViewShell const* pOtherView,
                                int nType, const boost::property_tree::ptree& rTree);
 
    static void sendUnoStatus(const SfxViewShell* pShell, const SfxPoolItem* pItem);
    static void notifyWindow(const SfxViewShell* pThisView,
                             vcl::LOKWindowId nWindowId,
                             std::u16string_view rAction,
                             const std::vector<vcl::LOKPayloadItem>& rPayload = std::vector<vcl::LOKPayloadItem>());
    static void notifyDocumentSizeChanged(SfxViewShell const* pThisView, const OString& rPayload, vcl::ITiledRenderable* pDoc, bool bInvalidateAll = true);
    static void notifyDocumentSizeChangedAllViews(vcl::ITiledRenderable* pDoc, bool bInvalidateAll = true);
    static void notifyPartSizeChangedAllViews(vcl::ITiledRenderable* pDoc, int nPart);
    static void notifyInvalidation(SfxViewShell const* pThisView, tools::Rectangle const *);
    static void notifyAllViews(int nType, const OString& rPayload);
 
    static void notifyContextChange(const css::ui::ContextChangeEventObject& rEvent);
 
    static void notifyViewRenderState(SfxViewShell const* pViewShell, vcl::ITiledRenderable* pDoc);
 
    // Notify about the given type needing an update.
    static void notifyUpdate(SfxViewShell const* pViewShell, int nType);
    // Notify about the given type needing a per-viewid update.
    static void notifyUpdatePerViewId(SfxViewShell const* pViewShell, int nType);
    static void notifyUpdatePerViewId(SfxViewShell const* pTargetShell, SfxViewShell const* pViewShell,
        SfxViewShell const* pSourceShell, int nType);
    // Notify other views about the given type needing a per-viewid update.
    static void notifyOtherViewsUpdatePerViewId(SfxViewShell const* pViewShell, int nType);
 
    static OString makePayloadJSON(const SfxViewShell* pThisView, int nViewId, std::string_view rKey, const OString& rPayload);
    static OString makeVisCursorInvalidation(int nViewId, const OString& rRectangle,
                                             bool bMispelledWord = false, const OString& rHyperlink = "");
 
    static void postKeyEventAsync(const VclPtr<vcl::Window> &xWindow,
                                  int nType, int nCharCode, int nKeyCode, int nRepeat = 0);
 
    static void postExtTextEventAsync(const VclPtr<vcl::Window> &xWindow,
                                      int nType, const OUString &rText);
 
    static void postMouseEventAsync(const VclPtr<vcl::Window> &xWindow, LokMouseEventData const & rLokMouseEventData);
 
    static const tools::Long MaxTwips = 1e9;
 
    static void dumpState(rtl::OStringBuffer &rState);
 
    static bool testInPlaceComponentMouseEventHit(SfxViewShell* pViewShell, int nType, int nX,
                                                  int nY, int nCount, int nButtons, int nModifier,
                                                  double fScaleX, double fScaleY,
                                                  bool bNegativeX = false);
 
    static VclPtr<vcl::Window> getInPlaceDocWindow(SfxViewShell* pViewShell);
 
private:
    static int createView(SfxViewFrame& rViewFrame, ViewShellDocId docId);
};
 
template<typename ViewShellType, typename FunctionType>
void SfxLokHelper::forEachOtherView(ViewShellType* pThisViewShell, FunctionType f)
{
    SfxViewShell* pViewShell = SfxViewShell::GetFirst();
    while (pViewShell)
    {
        auto pOtherViewShell = dynamic_cast<ViewShellType*>(pViewShell);
        if (pOtherViewShell != nullptr && pOtherViewShell != pThisViewShell && pOtherViewShell->GetDocId() == pThisViewShell->GetDocId())
        {
            f(pOtherViewShell);
        }
        pViewShell = SfxViewShell::GetNext(*pViewShell);
    }
}
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */