summaryrefslogtreecommitdiffstats
path: root/framework/inc/uielement/toolbarmanager.hxx
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /framework/inc/uielement/toolbarmanager.hxx
parentInitial commit. (diff)
downloadlibreoffice-upstream.tar.xz
libreoffice-upstream.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'framework/inc/uielement/toolbarmanager.hxx')
-rw-r--r--framework/inc/uielement/toolbarmanager.hxx249
1 files changed, 249 insertions, 0 deletions
diff --git a/framework/inc/uielement/toolbarmanager.hxx b/framework/inc/uielement/toolbarmanager.hxx
new file mode 100644
index 000000000..1cfddd99e
--- /dev/null
+++ b/framework/inc/uielement/toolbarmanager.hxx
@@ -0,0 +1,249 @@
+/* -*- 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 <uielement/commandinfo.hxx>
+
+#include <com/sun/star/container/XIndexAccess.hpp>
+#include <com/sun/star/frame/XFrame.hpp>
+#include <com/sun/star/frame/XStatusListener.hpp>
+#include <com/sun/star/frame/XUIControllerFactory.hpp>
+#include <com/sun/star/frame/XSubToolbarController.hpp>
+#include <com/sun/star/frame/XLayoutManager.hpp>
+#include <com/sun/star/frame/XToolbarController.hpp>
+#include <com/sun/star/lang/XComponent.hpp>
+#include <com/sun/star/ui/XImageManager.hpp>
+#include <com/sun/star/uno/XComponentContext.hpp>
+#include <com/sun/star/util/XURLTransformer.hpp>
+
+#include <framework/addonsoptions.hxx>
+
+#include <rtl/ustring.hxx>
+#include <cppuhelper/implbase.hxx>
+#include <comphelper/interfacecontainer4.hxx>
+
+#include <tools/link.hxx>
+#include <vcl/weld.hxx>
+#include <vcl/window.hxx>
+#include <vcl/timer.hxx>
+#include <vcl/toolbox.hxx>
+
+#include <mutex>
+#include <unordered_map>
+
+class PopupMenu;
+class ToolBox;
+class Menu;
+
+namespace framework
+{
+
+class ToolBarManager;
+
+class ToolBarManagerImpl
+{
+public:
+ virtual ~ToolBarManagerImpl() = default;
+ virtual void Init() = 0;
+ virtual void Destroy() = 0;
+ virtual css::uno::Reference<css::awt::XWindow> GetInterface() = 0;
+ virtual css::uno::Reference<css::frame::XStatusListener> CreateToolBoxController(
+ const css::uno::Reference<css::frame::XFrame>& rFrame,
+ ToolBoxItemId nId,
+ const OUString& aCommandURL ) = 0;
+ virtual void InsertItem(ToolBoxItemId nId,
+ const OUString& rString,
+ const OUString& rCommandURL,
+ const OUString& rTooltip,
+ const OUString& rLabel,
+ ToolBoxItemBits nItemBits) = 0;
+ virtual void InsertSeparator() = 0;
+ virtual void InsertSpace() = 0;
+ virtual void InsertBreak() = 0;
+ virtual ToolBoxItemId GetItemId(sal_uInt16 nPos) = 0;
+ virtual ToolBoxItemId GetCurItemId() = 0;
+ virtual OUString GetItemCommand(ToolBoxItemId nId) = 0;
+ virtual sal_uInt16 GetItemCount() = 0;
+ virtual void SetItemCheckable(ToolBoxItemId nId) = 0;
+ virtual void HideItem(ToolBoxItemId nId, const OUString& rCommandURL) = 0;
+ virtual bool IsItemVisible(ToolBoxItemId nId, const OUString& rCommandURL) = 0;
+ virtual void Clear() = 0;
+ virtual void SetName(const OUString& rName) = 0;
+ virtual void SetHelpId(const OString& rHelpId) = 0;
+ virtual bool WillUsePopupMode() = 0;
+ virtual bool IsReallyVisible() = 0;
+ virtual void SetIconSize(ToolBoxButtonSize eSize) = 0;
+ virtual vcl::ImageType GetImageSize() = 0;
+ virtual void ConnectCallbacks(ToolBarManager* pManager) = 0;
+ virtual void SetMenuType(ToolBoxMenuType eType) = 0;
+ virtual void MergeToolbar(ToolBoxItemId & rItemId,
+ const OUString& rModuleIdentifier,
+ CommandToInfoMap& rCommandMap,
+ MergeToolbarInstruction& rInstruction) = 0;
+ virtual void SetItemImage(ToolBoxItemId nId,
+ const OUString& rCommandURL,
+ const Image& rImage) = 0;
+ virtual void UpdateSize() = 0;
+ virtual void SetItemWindow(ToolBoxItemId nItemId, vcl::Window* pNewWindow) = 0;
+};
+
+typedef ::cppu::WeakImplHelper<
+ css::frame::XFrameActionListener,
+ css::lang::XComponent,
+ css::ui::XUIConfigurationListener
+ > ToolbarManager_Base;
+
+class ToolBarManager final : public ToolbarManager_Base
+{
+ public:
+ ToolBarManager( const css::uno::Reference< css::uno::XComponentContext >& rxContext,
+ const css::uno::Reference< css::frame::XFrame >& rFrame,
+ OUString aResourceName,
+ ToolBox* pToolBar );
+ ToolBarManager( const css::uno::Reference< css::uno::XComponentContext >& rxContext,
+ const css::uno::Reference< css::frame::XFrame >& rFrame,
+ OUString aResourceName,
+ weld::Toolbar* pToolBar,
+ weld::Builder* pBuilder );
+ virtual ~ToolBarManager() override;
+
+ ToolBox* GetToolBar() const;
+
+ // XFrameActionListener
+ virtual void SAL_CALL frameAction( const css::frame::FrameActionEvent& Action ) override;
+
+ // XEventListener
+ virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
+
+ // XUIConfigurationListener
+ virtual void SAL_CALL elementInserted( const css::ui::ConfigurationEvent& Event ) override;
+ virtual void SAL_CALL elementRemoved( const css::ui::ConfigurationEvent& Event ) override;
+ virtual void SAL_CALL elementReplaced( const css::ui::ConfigurationEvent& Event ) override;
+
+ // XComponent
+ void SAL_CALL dispose() override;
+ void SAL_CALL addEventListener( const css::uno::Reference< XEventListener >& xListener ) override;
+ void SAL_CALL removeEventListener( const css::uno::Reference< XEventListener >& xListener ) override;
+
+ void CheckAndUpdateImages();
+ void RequestImages();
+ void FillToolbar( const css::uno::Reference< css::container::XIndexAccess >& rToolBarData );
+ void FillAddonToolbar( const css::uno::Sequence< css::uno::Sequence< css::beans::PropertyValue > >& rAddonToolbar );
+ void FillOverflowToolbar( ToolBox const * pParent );
+ void notifyRegisteredControllers( const OUString& aUIElementName, const OUString& aCommand );
+ void Destroy();
+
+ enum ExecuteCommand
+ {
+ EXEC_CMD_CLOSETOOLBAR,
+ EXEC_CMD_UNDOCKTOOLBAR,
+ EXEC_CMD_DOCKTOOLBAR,
+ EXEC_CMD_DOCKALLTOOLBARS
+ };
+
+ enum ClickAction
+ {
+ Click,
+ DblClick,
+ Execute
+ };
+
+ struct ExecuteInfo
+ {
+ OUString aToolbarResName;
+ ExecuteCommand nCmd;
+ css::uno::Reference< css::frame::XLayoutManager > xLayoutManager;
+ css::uno::Reference< css::awt::XWindow > xWindow;
+ };
+
+ public:
+ void OnClick(bool bUseExecute = false);
+ void OnDropdownClick(bool bCreatePopupWindow = true);
+
+ DECL_LINK(DropdownClick, ToolBox *, void);
+ DECL_LINK(DoubleClick, ToolBox *, void);
+ DECL_LINK(Select, ToolBox *, void);
+ DECL_LINK( StateChanged, StateChangedType const *, void );
+ DECL_LINK( DataChanged, DataChangedEvent const *, void );
+ DECL_LINK( MiscOptionsChanged, LinkParamNone*, void );
+
+ DECL_LINK( MenuButton, ToolBox *, void );
+ DECL_LINK( MenuPreExecute, ToolBox *, void );
+ DECL_LINK( MenuSelect, Menu *, bool );
+ DECL_LINK(AsyncUpdateControllersHdl, Timer *, void);
+ DECL_LINK( OverflowEventListener, VclWindowEvent&, void );
+ DECL_STATIC_LINK( ToolBarManager, ExecuteHdl_Impl, void*, void );
+
+ private:
+ void Init();
+ void AddCustomizeMenuItems(ToolBox const * pToolBar);
+ void InitImageManager();
+ void RemoveControllers();
+ void CreateControllers();
+ void UpdateControllers();
+ //for update controller via Support Visible
+ void UpdateController( const css::uno::Reference< css::frame::XToolbarController >& xController);
+ //end
+ void AddFrameActionListener();
+ void RefreshImages();
+ ToolBoxItemBits ConvertStyleToToolboxItemBits( sal_Int32 nStyle );
+ css::uno::Reference< css::frame::XModel > GetModelFromFrame() const;
+ bool IsPluginMode() const;
+ void HandleClick(ClickAction eAction);
+ void setToolBarImage(const Image& _aImage,const CommandToInfoMap::const_iterator& _pIter);
+ void impl_elementChanged(bool _bRemove,const css::ui::ConfigurationEvent& Event );
+
+ typedef std::unordered_map< ToolBoxItemId, css::uno::Reference< css::frame::XStatusListener > > ToolBarControllerMap;
+ typedef ::std::vector< css::uno::Reference< css::frame::XSubToolbarController > > SubToolBarControllerVector;
+ typedef std::unordered_map<OUString, SubToolBarControllerVector> SubToolBarToSubToolBarControllerMap;
+
+ bool m_bDisposed : 1,
+ m_bFrameActionRegistered : 1,
+ m_bUpdateControllers : 1;
+
+ sal_Int16 m_eSymbolSize;
+
+ std::unique_ptr<ToolBarManagerImpl> m_pImpl;
+ VclPtr<ToolBox> m_pToolBar;
+
+ OUString m_aModuleIdentifier;
+ OUString m_aResourceName;
+
+ css::uno::Reference< css::util::XURLTransformer > m_xURLTransformer;
+ css::uno::Reference< css::frame::XFrame > m_xFrame;
+ ToolBarControllerMap m_aControllerMap;
+ std::mutex m_mutex;
+ comphelper::OInterfaceContainerHelper4<XEventListener> m_aListenerContainer;
+ css::uno::Reference< css::uno::XComponentContext > m_xContext;
+ css::uno::Reference< css::frame::XUIControllerFactory > m_xToolbarControllerFactory;
+ css::uno::Reference< css::ui::XImageManager > m_xModuleImageManager;
+ css::uno::Reference< css::ui::XImageManager > m_xDocImageManager;
+
+ CommandToInfoMap m_aCommandMap;
+ SubToolBarToSubToolBarControllerMap m_aSubToolBarControllerMap;
+ Timer m_aAsyncUpdateControllersTimer;
+ OUString m_sIconTheme;
+
+ rtl::Reference< ToolBarManager > m_aOverflowManager;
+};
+
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */