/* -*- 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 #include #include #include #include #include #include #include #include #include #include #include #include struct SFX2_DLLPUBLIC LokMouseEventData { int mnType; Point maPosition; int mnCount; MouseEventModifiers meModifiers; int mnButtons; int mnModifier; std::optional 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 namespace com::sun::star::ui { struct ContextChangeEventObject; }; class SFX2_DLLPUBLIC SfxLokHelper { public: /// Create a new view shell from the current view frame. /// This assumes a single document is ever loaded. static int createView(); /// Create a new view shell for the given DocId, for multi-document support. static int createView(int nDocId); /// Destroy a view shell from the global shell list. static void destroyView(int nId); /// Set a view shell as current one. static void setView(int nId); /// Set the edit mode for a document with callbacks disabled. static void setEditMode(int nMode, vcl::ITiledRenderable* pDoc); /// Get view shell with id static SfxViewShell* getViewOfId(int nId); /// Get the currently active view. static int getView(const SfxViewShell* pViewShell = nullptr); /// Get the number of views of the current DocId. static std::size_t getViewsCount(int nDocId); /// Get viewIds of views of the current DocId. static bool getViewIds(int nDocId, int* pArray, size_t nSize); /// Set View Blocked for some uno commands static void setBlockedCommandList(int nViewId, const char* blockedCommandList); /// Get the document id for a view static int getDocumentIdOfView(int nViewId); /// Get the default language that should be used for views static const LanguageTag & getDefaultLanguage(); /// Set language of the given view. static void setViewLanguage(int nId, const OUString& rBcp47LanguageTag); /// Set the default language for views. static void setDefaultLanguage(const OUString& rBcp47LanguageTag); /// Get the language used by the loading view (used for all save operations). static const LanguageTag & getLoadLanguage(); /// Set the language used by the loading view (used for all save operations). static void setLoadLanguage(const OUString& rBcp47LanguageTag); /// Set the locale for the given view. static void setViewLocale(int nId, const OUString& rBcp47LanguageTag); /// Get the device form factor that should be used for a new view. static LOKDeviceFormFactor getDeviceFormFactor(); /// Set the device form factor that should be used for a new view. static void setDeviceFormFactor(std::u16string_view rDeviceFormFactor); /// Set timezone of the given view. /// @isSet true to use @rTimezone, even if it's empty. Otherwise, no timezone. /// @rTimezone the value to set (which could be empty). static void setDefaultTimezone(bool isSet, const OUString& rTimezone); /// Get timezone of the given view. See @setDefaultTimezone. static std::pair getDefaultTimezone(); /// Set the timezone of the given view. static void setViewTimezone(int nId, bool isSet, const OUString& rTimezone); /// Get the timezone of the given view. static std::pair getViewTimezone(int nId); /// Iterate over any view shell, except pThisViewShell, passing it to the f function. template static void forEachOtherView(ViewShellType* pThisViewShell, FunctionType f); /// Invoke the LOK callback of all other views showing the same document as pThisView, with a payload of rKey-rPayload. static void notifyOtherViews(const SfxViewShell* pThisView, int nType, std::string_view rKey, const OString& rPayload); /// Invoke the LOK callback of all views except pThisView, with a JSON payload created from the given property tree. static void notifyOtherViews(const SfxViewShell* pThisView, int nType, const boost::property_tree::ptree& rTree); /// Same as notifyOtherViews(), but works on a selected "other" view, not on all of them. static void notifyOtherView(const SfxViewShell* pThisView, SfxViewShell const* pOtherView, int nType, std::string_view rKey, const OString& rPayload); /// Same as notifyOtherViews(), the property-tree version, but works on a selected "other" view, not on all of them. static void notifyOtherView(const SfxViewShell* pThisView, SfxViewShell const* pOtherView, int nType, const boost::property_tree::ptree& rTree); /// Emits a LOK_CALLBACK_STATE_CHANGED static void sendUnoStatus(const SfxViewShell* pShell, const SfxPoolItem* pItem); /// Emits a LOK_CALLBACK_WINDOW static void notifyWindow(const SfxViewShell* pThisView, vcl::LOKWindowId nWindowId, std::u16string_view rAction, const std::vector& rPayload = std::vector()); /// Emits a LOK_CALLBACK_DOCUMENT_SIZE_CHANGED - if @bInvalidateAll - first invalidates all parts static void notifyDocumentSizeChanged(SfxViewShell const* pThisView, const OString& rPayload, vcl::ITiledRenderable* pDoc, bool bInvalidateAll = true); /// Emits a LOK_CALLBACK_DOCUMENT_SIZE_CHANGED for all views of the same document - if @bInvalidateAll - first invalidates all parts static void notifyDocumentSizeChangedAllViews(vcl::ITiledRenderable* pDoc, bool bInvalidateAll = true); /// Emits a LOK_CALLBACK_DOCUMENT_SIZE_CHANGED for all views of the same document with the same part static void notifyPartSizeChangedAllViews(vcl::ITiledRenderable* pDoc, int nPart); /// Emits a LOK_CALLBACK_INVALIDATE_TILES, but tweaks it according to setOptionalFeatures() if needed. static void notifyInvalidation(SfxViewShell const* pThisView, tools::Rectangle const *); /// Notifies all views with the given type and payload. static void notifyAllViews(int nType, const OString& rPayload); /// Notify about the editing context change. static void notifyContextChange(const css::ui::ContextChangeEventObject& rEvent); // 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); /// Same as notifyUpdatePerViewId(), pTargetShell will be notified, relevant viewId in pViewShell, /// pSourceView->getLOKPayload() will be called to get the data. 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); /// Makes a LOK_CALLBACK_INVALIDATE_VISIBLE_CURSOR payload, but tweaks it according to setOptionalFeatures() if needed. static OString makeVisCursorInvalidation(int nViewId, const OString& rRectangle, bool bMispelledWord = false, const OString& rHyperlink = ""); /// Helper for posting async key event static void postKeyEventAsync(const VclPtr &xWindow, int nType, int nCharCode, int nKeyCode, int nRepeat = 0); /// Helper for posting input event static void postExtTextEventAsync(const VclPtr &xWindow, int nType, const OUString &rText); /// Helper for posting async mouse event static void postMouseEventAsync(const VclPtr &xWindow, LokMouseEventData const & rLokMouseEventData); /// A special value to signify 'infinity'. /// This value is chosen such that sal_Int32 will not overflow when manipulated. static const tools::Long MaxTwips = 1e9; /// Helper for diagnosing run-time problems static void dumpState(rtl::OStringBuffer &rState); /// Notify all views of a media update. /// This could be a new insertion or property modifications to an existing one. static void notifyMediaUpdate(boost::property_tree::ptree& json); /// Process the mouse event in the currently active in-place component (if any). /// Returns true if the event has been processed, and no further processing is necessary. 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 getInPlaceDocWindow(SfxViewShell* pViewShell); private: static int createView(SfxViewFrame* pViewFrame, ViewShellDocId docId); }; template void SfxLokHelper::forEachOtherView(ViewShellType* pThisViewShell, FunctionType f) { SfxViewShell* pViewShell = SfxViewShell::GetFirst(); while (pViewShell) { auto pOtherViewShell = dynamic_cast(pViewShell); if (pOtherViewShell != nullptr && pOtherViewShell != pThisViewShell && pOtherViewShell->GetDocId() == pThisViewShell->GetDocId()) { f(pOtherViewShell); } pViewShell = SfxViewShell::GetNext(*pViewShell); } } #endif /* vim:set shiftwidth=4 softtabstop=4 expandtab: */