new uno sidebar api tdf#91806

the entry point is SfxBaseController::getSidebar()

the Decks and panels are now per SidebarController and not global anymore

' macro example
Sub testSidebarApi

controller =  thisComponent.currentcontroller
frameIni =  thisComponent.currentcontroller.frame
sidebar =  thisComponent.currentcontroller.getSidebar()

sidebar.setVisible(true)

frame = sidebar.getFrame()

decks = sidebar.getdecks()

c = decks.count

h = decks.hasElements()

e = decks.getElementNames()

a =  decks.hasByName("MyDeck")

deck = decks.getByName("MyDeck")
deck.activate(true)

t = deck.getTitle()
deck.setTitle("new deck title")

deck.moveFirst()
deck.moveLast()
deck.moveUp()
deck.moveDown()

index = deck.getOrderIndex()

panels = deck.getPanels()
ep = panels.getElementnames()

ap = panels.hasByName("aPanelName")

panel = panels.getByName("aPanelName")
panel.setTitle("new panel title")

panel.collapse()

panel.expand(true) ' expand and collapse other

index = panel.getOrderIndex()

panel.moveLast()
panel.moveFirst()
panel.moveDown()
panel.moveUp()

End Sub

Change-Id: I7a4b953f2277dea483bb296ba6ead35de7205ace
Reviewed-on: https://gerrit.libreoffice.org/15856
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Tomaž Vajngerl <quikee@gmail.com>
Tested-by: Tomaž Vajngerl <quikee@gmail.com>

1 files changed, 150 insertions, 0 deletions

diff --git a/include/sfx2/sidebar/FocusManager.hxx b/include/sfx2/sidebar/FocusManager.hxx
new file mode 100644
index 000000000000..f93f9e82c368
--- /dev/null
+++ b/include/sfx2/sidebar/FocusManager.hxx
@@ -0,0 +1,150 @@
+/* -*- 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_SFX2_SOURCE_SIDEBAR_FOCUSMANAGER_HXX
+#define INCLUDED_SFX2_SOURCE_SIDEBAR_FOCUSMANAGER_HXX
+
+#include "Panel.hxx"
+#include <tools/link.hxx>
+#include <vcl/keycod.hxx>
+
+class Button;
+class VclSimpleEvent;
+
+namespace sfx2 { namespace sidebar {
+
+class DeckTitleBar;
+
+/** Concentrate all focus handling in this class.
+
+    There is one ring of windows that accept the input focus which are
+    cycled through with the arrow keys:
+    - the closer in the deck title (present only when docked)
+    - the panel title bars
+    - the tab bar items
+
+    When the focus is in a panel title then focus travels over
+    - the panel title
+    - the panel closer
+    - the panel content
+
+    Once the focus is in the panel content then focus cycles through
+    all controls inside the panel but not back to the title bar of
+    the panel.  Escape places the focus back in the panel title.
+*/
+class FocusManager
+{
+public:
+    FocusManager(const std::function<void(const Panel&)>& rShowPanelFunctor);
+    ~FocusManager();
+
+    /** Forget all panels and buttons.  Remove all window listeners.
+    */
+    void Clear();
+
+    /** Transfer the focus into the sidebar tree of windows.  This is
+        typically called from the SidebarChildWindow as result of
+        pressing the F6 key.
+    */
+    void GrabFocus();
+
+    void SetDeckTitle(DeckTitleBar* pDeckTitleBar);
+    void SetPanels(const SharedPanelContainer& rPanels);
+    void SetButtons(const ::std::vector<Button*>& rButtons);
+
+private:
+    VclPtr<DeckTitleBar> mpDeckTitleBar;
+    std::vector<VclPtr<Panel> > maPanels;
+    std::vector<VclPtr<Button> > maButtons;
+    const std::function<void(const Panel&)> maShowPanelFunctor;
+    bool mbObservingContentControlFocus;
+    VclPtr<vcl::Window> mpFirstFocusedContentControl;
+    VclPtr<vcl::Window> mpLastFocusedWindow;
+
+    enum PanelComponent
+    {
+        PC_DeckTitle,
+        PC_DeckToolBox,
+        PC_PanelTitle,
+        PC_PanelToolBox,
+        PC_PanelContent,
+        PC_TabBar,
+        PC_None
+    };
+    class FocusLocation
+    {
+    public:
+        PanelComponent meComponent;
+        sal_Int32 mnIndex;
+        FocusLocation(const PanelComponent eComponent, const sal_Int32 nIndex);
+    };
+
+    /** Listen for key events for panels and buttons.
+    */
+    DECL_LINK(WindowEventListener, VclSimpleEvent*);
+    DECL_LINK(ChildEventListener, VclSimpleEvent*);
+
+    void ClearPanels();
+    void ClearButtons();
+
+    /** Let the focus manager listen for window events for the given
+        window.
+    */
+    void RegisterWindow(vcl::Window& rWindow);
+    void UnregisterWindow(vcl::Window& rWindow);
+
+    /** Remove the window from the panel or the button container.
+    */
+    void RemoveWindow(vcl::Window& rWindow);
+
+    void FocusDeckTitle();
+    bool IsDeckTitleVisible() const;
+    bool IsPanelTitleVisible(const sal_Int32 nPanelIndex) const;
+
+    /** Set the focus to the title bar of the panel or, if the
+        title bar is not visible, directly to the panel.
+        @param nPanelIndex
+            Index of the panel to focus.
+        @param bFallbackToDeckTitle
+            When the panel title bar is not visible then The fallback
+            bias defines whether to focus the deck (true) or the panel
+            content (false) will be focused instead.
+    */
+    void FocusPanel(const sal_Int32 nPanelIndex,
+                    const bool bFallbackToDeckTitle);
+
+    void FocusPanelContent(const sal_Int32 nPanelIndex);
+    void FocusButton(const sal_Int32 nButtonIndex);
+    void ClickButton(const sal_Int32 nButtonIndex);
+    bool MoveFocusInsidePanel(const FocusLocation& rLocation,
+                              const sal_Int32 nDirection);
+    bool MoveFocusInsideDeckTitle(const FocusLocation& rLocation,
+                                  const sal_Int32 nDirection);
+
+    void HandleKeyEvent(const vcl::KeyCode& rKeyCode,
+                         const vcl::Window& rWindow);
+
+    FocusLocation GetFocusLocation(const vcl::Window& rWindow) const;
+
+};
+
+} } // end of namespace sfx2::sidebar
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */