Add custom widget class: CommandCategoryListBox

It now lists all command categories which can be
added based on the current module (writer, calc etc.)

This class will be expanded later with macros and styles
handling stuff. It will also update the commands listbox
when it is added.

Change-Id: I4f50408641db067118f63fe0e9a1ee755873412f
Reviewed-on: https://gerrit.libreoffice.org/40833
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Katarina Behrens <Katarina.Behrens@cib.de>

1 files changed, 113 insertions, 0 deletions

diff --git a/cui/source/customize/CommandCategoryListBox.cxx b/cui/source/customize/CommandCategoryListBox.cxx
new file mode 100644
index 000000000000..fac557fcf210
--- /dev/null
+++ b/cui/source/customize/CommandCategoryListBox.cxx
@@ -0,0 +1,113 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
+/*
+ * 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 "CommandCategoryListBox.hxx"
+
+#include <com/sun/star/frame/XDispatchInformationProvider.hpp>
+#include <com/sun/star/frame/theUICommandDescription.hpp>
+#include <com/sun/star/ui/theUICategoryDescription.hpp>
+#include <vcl/builderfactory.hxx>
+
+#include "dialmgr.hxx"
+#include "strings.hrc"
+#include <o3tl/make_unique.hxx>
+
+CommandCategoryListBox::CommandCategoryListBox(vcl::Window* pParent, WinBits nStyle)
+    : ListBox( pParent, nStyle)
+{
+    SetDropDownLineCount(25);
+}
+
+VCL_BUILDER_FACTORY(CommandCategoryListBox);
+
+void CommandCategoryListBox::Init(
+        const css::uno::Reference< css::uno::XComponentContext >& xContext,
+        const css::uno::Reference< css::frame::XFrame >& xFrame,
+        const OUString& sModuleLongName)
+{
+    SetUpdateMode(false);
+    ClearAll();
+
+    m_xContext = xContext;
+    m_xFrame = xFrame;
+
+    m_sModuleLongName = sModuleLongName;
+    m_xGlobalCategoryInfo = css::ui::theUICategoryDescription::get( m_xContext );
+    m_xModuleCategoryInfo.set(m_xGlobalCategoryInfo->getByName(m_sModuleLongName), css::uno::UNO_QUERY_THROW);
+
+/**** InitModule Start ****/
+    try
+    {
+        css::uno::Reference< css::frame::XDispatchInformationProvider > xProvider(m_xFrame, css::uno::UNO_QUERY_THROW);
+        css::uno::Sequence< sal_Int16 > lGroups = xProvider->getSupportedCommandGroups();
+
+        sal_Int32 nGroupsLength = lGroups.getLength();
+        sal_Int32 nEntryPos;
+
+        if ( nGroupsLength > 0 )
+        {
+            // Add the category of "All commands"
+            nEntryPos = InsertEntry( CuiResId(RID_SVXSTR_ALLFUNCTIONS) );
+            m_aGroupInfo.push_back( o3tl::make_unique<SfxGroupInfo_Impl>( SfxCfgKind::GROUP_ALLFUNCTIONS, 0 ) );
+            SetEntryData( nEntryPos, m_aGroupInfo.back().get() );
+        }
+
+        // Add the actual categories
+        for (sal_Int32 i = 0; i < nGroupsLength; ++i)
+        {
+            sal_Int16&  rGroupID = lGroups[i];
+            OUString    sGroupID = OUString::number(rGroupID);
+            OUString    sGroupName;
+
+            try
+            {
+                m_xModuleCategoryInfo->getByName(sGroupID) >>= sGroupName;
+                if (sGroupName.isEmpty())
+                    continue;
+            }
+            catch(const css::container::NoSuchElementException&)
+            {
+                continue;
+            }
+
+            nEntryPos = InsertEntry( sGroupName );
+            m_aGroupInfo.push_back( o3tl::make_unique<SfxGroupInfo_Impl>( SfxCfgKind::GROUP_FUNCTION, rGroupID ) );
+            SetEntryData( nEntryPos, m_aGroupInfo.back().get() );
+        }
+
+
+    }
+    catch(const css::uno::RuntimeException&)
+        { throw; }
+    catch(const css::uno::Exception&)
+    {}
+/**** InitModule End ****/
+
+    SetUpdateMode(true);
+    SelectEntryPos(0);
+}
+
+void CommandCategoryListBox::ClearAll()
+{
+    //TODO: Handle SfxCfgKind::GROUP_SCRIPTCONTAINER when it gets added to Init
+    m_aGroupInfo.clear();
+    Clear();
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */