Toolbar: Added usage of ImageControl as toolbar control

Reviewed-on: https://gerrit.libreoffice.org/81064
Reviewed-by: Serge Krot (CIB) <Serge.Krot@cib.de>
Tested-by: Serge Krot (CIB) <Serge.Krot@cib.de>
(cherry picked from commit 48f945a3be16ee0eba0c526e51280dc8deafc316)

Change-Id: I2536a505650b6e4c98e79f749c3b237518cc995d
Reviewed-on: https://gerrit.libreoffice.org/81872
Tested-by: Jenkins
Reviewed-by: Thorsten Behrens <Thorsten.Behrens@CIB.de>

5 files changed, 177 insertions, 0 deletions

diff --git a/framework/Library_fwk.mk b/framework/Library_fwk.mk
index 5d59402c2be5..1fe75ccab4b7 100644
--- a/framework/Library_fwk.mk
+++ b/framework/Library_fwk.mk
@@ -132,6 +132,7 @@ $(eval $(call gb_Library_add_exception_objects,fwk,\
     framework/source/uielement/controlmenucontroller \
     framework/source/uielement/dropdownboxtoolbarcontroller \
     framework/source/uielement/edittoolbarcontroller \
+    framework/source/uielement/FixedImageToolbarController \
     framework/source/uielement/FixedTextToolbarController \
     framework/source/uielement/genericstatusbarcontroller \
     framework/source/uielement/generictoolbarcontroller \
diff --git a/framework/inc/uielement/FixedImageToolbarController.hxx b/framework/inc/uielement/FixedImageToolbarController.hxx
new file mode 100644
index 000000000000..2fa55e4e8cc5
--- /dev/null
+++ b/framework/inc/uielement/FixedImageToolbarController.hxx
@@ -0,0 +1,59 @@
+/* -*- 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 .
+ */
+
+#ifndef INCLUDED_FRAMEWORK_INC_UIELEMENT_FIXEDIMAGETOOLBARCONTROLLER_HXX
+#define INCLUDED_FRAMEWORK_INC_UIELEMENT_FIXEDIMAGETOOLBARCONTROLLER_HXX
+
+#include <com/sun/star/beans/NamedValue.hpp>
+#include <com/sun/star/frame/ControlCommand.hpp>
+
+#include <uielement/complextoolbarcontroller.hxx>
+
+class ToolBox;
+class ImageControl;
+
+namespace framework
+{
+class FixedImageToolbarController : public ComplexToolbarController
+{
+public:
+    FixedImageToolbarController(const css::uno::Reference<css::uno::XComponentContext>& rxContext,
+                                const css::uno::Reference<css::frame::XFrame>& rFrame,
+                                ToolBox* pToolBar, sal_uInt16 nID, const OUString& aCommand);
+
+    // XComponent
+    virtual void SAL_CALL dispose() override;
+
+    void CheckAndUpdateImages();
+
+protected:
+    virtual void executeControlCommand(const css::frame::ControlCommand& rControlCommand) override;
+
+protected:
+    DECL_LINK(MiscOptionsChanged, LinkParamNone*, void);
+
+private:
+    VclPtr<ImageControl> m_pFixedImageControl;
+    sal_Int16 m_eSymbolSize;
+};
+} // namespace framework
+
+#endif // INCLUDED_FRAMEWORK_INC_UIELEMENT_FIXEDIMAGETOOLBARCONTROLLER_HXX
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
\ No newline at end of file
diff --git a/framework/inc/uielement/toolbarmerger.hxx b/framework/inc/uielement/toolbarmerger.hxx
index cfe236f8328a..bb41a2bece60 100644
--- a/framework/inc/uielement/toolbarmerger.hxx
+++ b/framework/inc/uielement/toolbarmerger.hxx
@@ -27,6 +27,7 @@
 #include <uielement/spinfieldtoolbarcontroller.hxx>
 #include <uielement/edittoolbarcontroller.hxx>
 #include <uielement/dropdownboxtoolbarcontroller.hxx>
+#include <uielement/FixedImageToolbarController.hxx>
 #include <uielement/FixedTextToolbarController.hxx>
 #include <uielement/commandinfo.hxx>
 
diff --git a/framework/source/uielement/FixedImageToolbarController.cxx b/framework/source/uielement/FixedImageToolbarController.cxx
new file mode 100644
index 000000000000..6338287a8dd9
--- /dev/null
+++ b/framework/source/uielement/FixedImageToolbarController.cxx
@@ -0,0 +1,113 @@
+/* -*- 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 .
+ */
+
+#include <uielement/FixedImageToolbarController.hxx>
+
+#include <com/sun/star/beans/PropertyValue.hpp>
+#include <com/sun/star/beans/XPropertySet.hpp>
+
+#include <vcl/svapp.hxx>
+#include <vcl/window.hxx>
+#include <vcl/toolbox.hxx>
+#include <vcl/toolkit/imgctrl.hxx>
+#include <svtools/miscopt.hxx>
+#include <svtools/imgdef.hxx>
+#include <framework/sfxhelperfunctions.hxx>
+#include <framework/addonsoptions.hxx>
+
+using namespace ::com::sun::star;
+using namespace ::com::sun::star::awt;
+using namespace ::com::sun::star::uno;
+using namespace ::com::sun::star::beans;
+using namespace ::com::sun::star::lang;
+using namespace ::com::sun::star::frame;
+using namespace ::com::sun::star::util;
+
+namespace framework
+{
+FixedImageToolbarController::FixedImageToolbarController(
+    const Reference<XComponentContext>& rxContext, const Reference<XFrame>& rFrame,
+    ToolBox* pToolbar, sal_uInt16 nID, const OUString& aCommand)
+    : ComplexToolbarController(rxContext, rFrame, pToolbar, nID, aCommand)
+    , m_eSymbolSize(SvtMiscOptions().GetCurrentSymbolsSize())
+{
+    m_pFixedImageControl = VclPtr<ImageControl>::Create(m_pToolbar, 0);
+    m_pToolbar->SetItemWindow(m_nID, m_pFixedImageControl);
+
+    bool bBigImages(SvtMiscOptions().AreCurrentSymbolsLarge());
+
+    Image aImage = AddonsOptions().GetImageFromURL(aCommand, bBigImages, true);
+    m_pFixedImageControl->SetImage(aImage);
+    m_pFixedImageControl->SetSizePixel(m_pFixedImageControl->GetOptimalSize());
+
+    SvtMiscOptions().AddListenerLink(LINK(this, FixedImageToolbarController, MiscOptionsChanged));
+}
+
+void SAL_CALL FixedImageToolbarController::dispose()
+{
+    SolarMutexGuard aSolarMutexGuard;
+    SvtMiscOptions().RemoveListenerLink(
+        LINK(this, FixedImageToolbarController, MiscOptionsChanged));
+    m_pToolbar->SetItemWindow(m_nID, nullptr);
+    m_pFixedImageControl.disposeAndClear();
+    ComplexToolbarController::dispose();
+}
+
+void FixedImageToolbarController::executeControlCommand(const css::frame::ControlCommand&) {}
+
+void FixedImageToolbarController::CheckAndUpdateImages()
+{
+    SolarMutexGuard aSolarMutexGuard;
+
+    SvtMiscOptions aMiscOptions;
+    const sal_Int16 eNewSymbolSize = aMiscOptions.GetCurrentSymbolsSize();
+
+    if (m_eSymbolSize != eNewSymbolSize)
+    {
+        m_eSymbolSize = eNewSymbolSize;
+
+        // Refresh images if requested
+        auto aSize(m_pFixedImageControl->GetOptimalSize());
+        if (m_eSymbolSize == SFX_SYMBOLS_SIZE_LARGE)
+        {
+            aSize.setWidth(26);
+            aSize.setHeight(26);
+        }
+        else if (m_eSymbolSize == SFX_SYMBOLS_SIZE_32)
+        {
+            aSize.setWidth(32);
+            aSize.setHeight(32);
+        }
+        else
+        {
+            aSize.setWidth(16);
+            aSize.setHeight(16);
+        }
+        m_pFixedImageControl->SetSizePixel(aSize);
+    }
+}
+
+IMPL_LINK_NOARG(FixedImageToolbarController, MiscOptionsChanged, LinkParamNone*, void)
+{
+    CheckAndUpdateImages();
+}
+
+} // namespace framework
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/framework/source/uielement/toolbarmerger.cxx b/framework/source/uielement/toolbarmerger.cxx
index 22a9169ce73e..b2496cf7a2ca 100644
--- a/framework/source/uielement/toolbarmerger.cxx
+++ b/framework/source/uielement/toolbarmerger.cxx
@@ -50,6 +50,7 @@ static const char TOOLBARCONTROLLER_IMGBUTTON[]   = "ImageButton";
 static const char TOOLBARCONTROLLER_DROPDOWNBOX[] = "Dropdownbox";
 static const char TOOLBARCONTROLLER_DROPDOWNBTN[] = "DropdownButton";
 static const char TOOLBARCONTROLLER_TOGGLEDDBTN[] = "ToggleDropdownButton";
+static const char TOOLBARCONTROLLER_FIXEDIMAGE[]  = "FixedImage";
 static const char TOOLBARCONTROLLER_FIXEDTEXT[]   = "FixedText";
 
 static const char   TOOLBOXITEM_SEPARATOR_STR[]   = "private:separator";
@@ -606,6 +607,8 @@ void ToolBarMerger::RemoveItems(
     else if ( rControlType == TOOLBARCONTROLLER_DROPDOWNBTN )
         pResult = new ToggleButtonToolbarController( rxContext, xFrame, pToolbar, nId,
                                                      ToggleButtonToolbarController::Style::DropDownButton, rCommandURL );
+    else if ( rControlType == TOOLBARCONTROLLER_FIXEDIMAGE )
+        pResult = new FixedImageToolbarController( rxContext, xFrame, pToolbar, nId, rCommandURL );
     else if ( rControlType == TOOLBARCONTROLLER_FIXEDTEXT )
         pResult = new FixedTextToolbarController( rxContext, xFrame, pToolbar, nId, rCommandURL );
     else if ( rControlType == TOOLBARCONTROLLER_TOGGLEDDBTN )