Resolves: #i122230# Fixed focus traveling in the sidebar

(cherry picked from commit bab3ddce)

Conflicts:
	sfx2/source/sidebar/FocusManager.cxx

Change-Id: I8853a92da3c4fe41a0110c630cc6af556ffc2ce4

sfx2/source/sidebar/Deck.cxx

@@ -260,6 +260,39 @@ void Deck::RequestLayout (void)
 
 
 
+void Deck::ShowPanel (const Panel& rPanel)
+{
+    if (mpVerticalScrollBar && mpVerticalScrollBar->IsVisible())
+    {
+        // Get vertical extent of the panel.
+        sal_Int32 nPanelTop (rPanel.GetPosPixel().Y());
+        const sal_Int32 nPanelBottom (nPanelTop + rPanel.GetSizePixel().Height() - 1);
+        // Add the title bar into the extent.
+        if (rPanel.GetTitleBar() != NULL && rPanel.GetTitleBar()->IsVisible())
+            nPanelTop = rPanel.GetTitleBar()->GetPosPixel().Y();
+
+
+        // Determine what the new thumb position should be like.
+        // When the whole panel does not fit then make its top visible
+        // and it off at the bottom.
+        sal_Int32 nNewThumbPos (mpVerticalScrollBar->GetThumbPos());
+        if (nPanelBottom >= nNewThumbPos+mpVerticalScrollBar->GetVisibleSize())
+            nNewThumbPos = nPanelBottom - mpVerticalScrollBar->GetVisibleSize();
+        if (nPanelTop < nNewThumbPos)
+            nNewThumbPos = nPanelTop;
+
+        mpVerticalScrollBar->SetThumbPos(nNewThumbPos);
+        mpScrollContainer->SetPosPixel(
+            Point(
+                mpScrollContainer->GetPosPixel().X(),
+                -nNewThumbPos));
+
+    }
+}
+
+
+
+
 const char* GetWindowClassification (const Window* pWindow)
 {
     const String& rsName (pWindow->GetText());

sfx2/source/sidebar/Deck.hxx

@@ -61,6 +61,12 @@ public:
     void RequestLayout (void);
     ::Window* GetPanelParentWindow (void);
 
+    /** Try to make the panel completely visible.
+        When the whole panel does not fit then make its top visible
+        and it off at the bottom.
+    */
+    void ShowPanel (const Panel& rPanel);
+
     virtual void Paint (const Rectangle& rUpdateArea);
     virtual void DataChanged (const DataChangedEvent& rEvent);
 

sfx2/source/sidebar/FocusManager.hxx

@@ -25,17 +25,32 @@ class Button;
 class KeyCode;
 class VclSimpleEvent;
 
+
 namespace sfx2 { namespace sidebar {
 
+class DeckTitleBar;
+
 /** Concentrate all focus handling in this class.
-    There are two rings of windows that accept the input focus: panels
-    and tab bar buttons.
-    Arrow keys move the focus between them.  Tab moves focus between rings.
+
+    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 (void);
+    FocusManager (const ::boost::function<void(const Panel&)>& rShowPanelFunctor);
     ~FocusManager (void);
 
     /** Forget all panels and buttons.  Remove all window listeners.
@@ -48,22 +63,38 @@ public:
     */
     void GrabFocus (void);
 
-    /** Handle the key event that was sent to the docking window.
-    */
-    long NotifyDockingWindowEvent (const KeyEvent& rKeyEvent);
-
+    void SetDeckTitle (DeckTitleBar* pDeckTitleBar);
     void SetPanels (const SharedPanelContainer& rPanels);
-
     void SetButtons (const ::std::vector<Button*>& rButtons);
 
 private:
+    DeckTitleBar* mpDeckTitleBar;
     ::std::vector<Panel*> maPanels;
     ::std::vector<Button*> maButtons;
-    Window* mpTopLevelWindow;
+    const ::boost::function<void(const Panel&)> maShowPanelFunctor;
+
+    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);
     void ClearButtons (void);
@@ -73,17 +104,17 @@ private:
     */
     void RegisterWindow (Window& rWindow);
     void UnregisterWindow (Window& rWindow);
-    void RegisterTopLevelListener (void);
 
     /** Remove the window from the panel or the button container.
     */
     void RemoveWindow (Window& rWindow);
 
-    sal_Int32 GetPanelIndex (const Window& rWindow) const;
-    sal_Int32 GetButtonIndex (const Window& rWindow) const;
     bool IsAnyPanelFocused (void) const;
     bool IsAnyButtonFocused (void) const;
 
+    void FocusDeckTitle (void);
+    bool IsDeckTitleVisible (void) const;
+
     /** Set the focus to the title bar of the panel or, if the the
         title bar is not visible, directly to the panel.
     */
@@ -92,15 +123,15 @@ private:
     void FocusButton (const sal_Int32 nButtonIndex);
     void ClickButton (const sal_Int32 nButtonIndex);
     bool MoveFocusInsidePanel (
-        const sal_Int32 nPanelIndex,
+        const FocusLocation aLocation,
         const sal_Int32 nDirection);
 
     void HandleKeyEvent (
         const KeyCode& rKeyCode,
         const Window& rWindow);
 
-    void SetTopLevelWindow (Window* pWindow);
-    void HandleTopLevelEvent (VclWindowEvent& rEvent);
+    FocusLocation GetFocusLocation (const Window& rWindow) const;
+
 };
 
 } } // end of namespace sfx2::sidebar

sfx2/source/sidebar/Panel.cxx

@@ -47,7 +47,7 @@ namespace sfx2 { namespace sidebar {
 Panel::Panel (
     const PanelDescriptor& rPanelDescriptor,
     Window* pParentWindow,
-    const ::boost::function<void(void)>& rDeckLayoutTrigger )
+    const ::boost::function<void(void)>& rDeckLayoutTrigger)
     : Window(pParentWindow),
       msPanelId(rPanelDescriptor.msId),
       mpTitleBar(new PanelTitleBar(
@@ -63,7 +63,6 @@ Panel::Panel (
     SetBackground(Theme::GetPaint(Theme::Paint_PanelBackground).GetWallpaper());
 
 #ifdef DEBUG
-    OSL_TRACE("creating Panel at %x", this);
     SetText(A2S("Panel"));
 #endif
 }
@@ -73,7 +72,6 @@ Panel::Panel (
 
 Panel::~Panel (void)
 {
-    OSL_TRACE("destroying Panel at %x", this);
     Dispose();
 }
 

sfx2/source/sidebar/SidebarController.cxx

@@ -100,13 +100,16 @@ SidebarController::SidebarController (
               ::boost::bind(&SidebarController::ShowPopupMenu, this, _1,_2,_3))),
       mxFrame(rxFrame),
       maCurrentContext(OUString(), OUString()),
+      maRequestedContext(),
       msCurrentDeckId(A2S("PropertyDeck")),
+      msCurrentDeckTitle(),
       maPropertyChangeForwarder(::boost::bind(&SidebarController::BroadcastPropertyChange, this)),
       maContextChangeUpdate(::boost::bind(&SidebarController::UpdateConfigurations, this)),
       mbIsDeckRequestedOpen(),
       mbIsDeckOpen(),
       mbCanDeckBeOpened(true),
       mnSavedSidebarWidth(pParentWindow->GetSizePixel().Width()),
+      maFocusManager(::boost::bind(&SidebarController::ShowPanel, this, _1)),
       mxReadOnlyModeDispatch(),
       mbIsDocumentReadOnly(false),
       mpSplitWindow(NULL),
@@ -603,6 +606,7 @@ void SidebarController::SwitchToDeck (
 
     // Tell the focus manager about the new panels and tab bar
     // buttons.
+    maFocusManager.SetDeckTitle(mpCurrentDeck->GetTitleBar());
     maFocusManager.SetPanels(aNewPanels);
     mpTabBar->UpdateFocusManager(maFocusManager);
     UpdateTitleBarIcons();
@@ -1154,4 +1158,13 @@ void SidebarController::UpdateTitleBarIcons (void)
 }
 
 
+
+
+void SidebarController::ShowPanel (const Panel& rPanel)
+{
+    if (mpCurrentDeck)
+        mpCurrentDeck->ShowPanel(rPanel);
+}
+
+
 } } // end of namespace sfx2::sidebar

sfx2/source/sidebar/SidebarController.hxx

@@ -206,6 +206,12 @@ private:
     void ProcessNewWidth (const sal_Int32 nNewWidth);
     void UpdateCloseIndicator (const bool bIsIndicatorVisible);
 
+    /** Typically called when a panel is focused via keyboard.
+        Tries to scroll the deck up or down to make the given panel
+        completely visible.
+    */
+    void ShowPanel (const Panel& rPanel);
+
     virtual void SAL_CALL disposing (void);
 };
 

sfx2/source/sidebar/SidebarDockingWindow.cxx

@@ -78,31 +78,6 @@ void SidebarDockingWindow::GetFocus()
 
 
 
-long SidebarDockingWindow::PreNotify (NotifyEvent& rEvent)
-{
-    switch (rEvent.GetType())
-    {
-        case EVENT_KEYINPUT:
-        {
-            const KeyEvent* pKeyEvent = rEvent.GetKeyEvent();
-            if (pKeyEvent != NULL)
-                return mpSidebarController->GetFocusManager().NotifyDockingWindowEvent(*pKeyEvent);
-            else
-                break;
-        }
-
-        case EVENT_GETFOCUS:
-            OSL_TRACE("");
-            break;
-
-    }
-
-    return SfxDockingWindow::PreNotify(rEvent);
-}
-
-
-
-
 SfxChildWindow* SidebarDockingWindow::GetChildWindow (void)
 {
     return GetChildWindow_Impl();

sfx2/source/sidebar/SidebarDockingWindow.hxx

@@ -48,7 +48,6 @@ public:
 protected:
     // Window overridables
     virtual void GetFocus (void);
-    virtual long PreNotify (NotifyEvent& rEvent);
 
 private:
     ::rtl::Reference<sfx2::sidebar::SidebarController> mpSidebarController;

sfx2/source/sidebar/SidebarToolBox.cxx

@@ -150,4 +150,21 @@ void SidebarToolBox::setPosSizePixel (
 
 
 
+
+long SidebarToolBox::Notify (NotifyEvent& rEvent)
+{
+    if (rEvent.GetType() == EVENT_KEYINPUT)
+    {
+        if (rEvent.GetKeyEvent()->GetKeyCode().GetCode() == KEY_TAB)
+        {
+            // Special handling for transferring handling of KEY_TAB
+            // that becomes necessary because of our parent that is
+            // not the dialog but a background control.
+            return DockingWindow::Notify(rEvent);
+        }
+    }
+    return ToolBox::Notify(rEvent);
+}
+
+
 } } // end of namespace sfx2::sidebar

sfx2/source/sidebar/SidebarToolBox.hxx

@@ -40,6 +40,7 @@ public:
         long nWidth,
         long nHeight,
         sal_uInt16 nFlags);
+    virtual long Notify (NotifyEvent& rEvent);
 
 private:
     bool mbParentIsBorder;

sfx2/source/sidebar/TitleBar.cxx

@@ -134,6 +134,14 @@ ToolBox& TitleBar::GetToolBox (void)
 
 
 
+const ToolBox& TitleBar::GetToolBox (void) const
+{
+    return maToolBox;
+}
+
+
+
+
 void TitleBar::HandleToolBoxItemClick (const sal_uInt16 nItemIndex)
 {
     (void)nItemIndex;
@@ -182,6 +190,10 @@ void TitleBar::PaintFocus (const Rectangle& rFocusBox)
 {
     Push(PUSH_FONT | PUSH_TEXTCOLOR | PUSH_LINECOLOR | PUSH_FILLCOLOR);
 
+    Font aFont(GetFont());
+    aFont.SetWeight(WEIGHT_BOLD);
+    SetFont(aFont);
+
     const Rectangle aTextBox (
         GetTextRect(
             rFocusBox,

sfx2/source/sidebar/TitleBar.hxx

@@ -49,6 +49,7 @@ public:
         sal_uInt16 nFlags = WINDOW_POSSIZE_ALL);
 
     ToolBox& GetToolBox (void);
+    const ToolBox& GetToolBox (void) const;
 
 protected:
     ToolBox maToolBox;

svx/source/sidebar/paragraph/ParaPropertyPanel.cxx

@@ -1548,18 +1548,22 @@ ParaPropertyPanel::ParaPropertyPanel(Window* pParent,
       maFTUL (new FixedText(this, SVX_RES(FT_SPACING))),
       maTbxUL_IncDecBackground(ControlFactory::CreateToolBoxBackground(this)),
       maTbxUL_IncDec (ControlFactory::CreateToolBox(maTbxUL_IncDecBackground.get(),SVX_RES(TBX_UL_INC_DEC))),
-      maTopDist (new SvxRelativeField(this, SVX_RES(MF_ABOVE_PARASPACING))),
-      maBottomDist (new SvxRelativeField(this, SVX_RES(MF_BELOW_PARASPACING))),
-      maLineSPTbxBackground(ControlFactory::CreateToolBoxBackground(this)),
-      maLineSPTbx (ControlFactory::CreateToolBox(maLineSPTbxBackground.get(),SVX_RES(TBX_LINESP))),
       maFTIndent (new FixedText(this, SVX_RES(FT_INDENT))),
       maTbxIndent_IncDecBackground(ControlFactory::CreateToolBoxBackground(this)),
       maTbxIndent_IncDec (ControlFactory::CreateToolBox(maTbxIndent_IncDecBackground.get(),SVX_RES(TBX_INDENT_INC_DEC))),
-      maTbxProDemoteBackground(ControlFactory::CreateToolBoxBackground(this)),
-      maTbxProDemote (ControlFactory::CreateToolBox(maTbxProDemoteBackground.get(),SVX_RES(TBX_INDENT_PRO_DEMOTE))),
+
+      maTopDist (new SvxRelativeField(this, SVX_RES(MF_ABOVE_PARASPACING))),
       maLeftIndent (new SvxRelativeField(this, SVX_RES(MF_BEFORE_INDENT))),
+
+      maBottomDist (new SvxRelativeField(this, SVX_RES(MF_BELOW_PARASPACING))),
       maRightIndent (new SvxRelativeField(this, SVX_RES(MF_AFTER_INDENT))),
+
+      maLineSPTbxBackground(ControlFactory::CreateToolBoxBackground(this)),
+      maLineSPTbx (ControlFactory::CreateToolBox(maLineSPTbxBackground.get(),SVX_RES(TBX_LINESP))),
       maFLineIndent (new SvxRelativeField(this, SVX_RES(MF_FL_INDENT))),
+
+      maTbxProDemoteBackground(ControlFactory::CreateToolBoxBackground(this)),
+      maTbxProDemote (ControlFactory::CreateToolBox(maTbxProDemoteBackground.get(),SVX_RES(TBX_INDENT_PRO_DEMOTE))),
       mpColorUpdater (),
       maFISpace1 ( this, SVX_RES( FI_SPACE1)),
       maFISpace2 ( this, SVX_RES( FI_SPACE2)),

svx/source/sidebar/paragraph/ParaPropertyPanel.hxx

@@ -108,20 +108,20 @@ private:
     ::boost::scoped_ptr<FixedText>          maFTUL;
     ::boost::scoped_ptr<Window>             maTbxUL_IncDecBackground;
     ::boost::scoped_ptr<ToolBox>            maTbxUL_IncDec;
+    ::boost::scoped_ptr<FixedText>          maFTIndent;
+    ::boost::scoped_ptr<Window>             maTbxIndent_IncDecBackground;
+    ::boost::scoped_ptr<ToolBox>            maTbxIndent_IncDec;
     ::boost::scoped_ptr<SvxRelativeField>   maTopDist;
+    ::boost::scoped_ptr<SvxRelativeField>   maLeftIndent;
     ::boost::scoped_ptr<SvxRelativeField>   maBottomDist;
+    ::boost::scoped_ptr<SvxRelativeField>   maRightIndent;
     //Line spacing
     ::boost::scoped_ptr<Window>             maLineSPTbxBackground;
     ::boost::scoped_ptr<ToolBox>            maLineSPTbx;
+    ::boost::scoped_ptr<SvxRelativeField>   maFLineIndent;
     //Indent
-    ::boost::scoped_ptr<FixedText>          maFTIndent;
-    ::boost::scoped_ptr<Window>             maTbxIndent_IncDecBackground;
-    ::boost::scoped_ptr<ToolBox>            maTbxIndent_IncDec;
     ::boost::scoped_ptr<Window>             maTbxProDemoteBackground;
     ::boost::scoped_ptr<ToolBox>            maTbxProDemote;
-    ::boost::scoped_ptr<SvxRelativeField>   maLeftIndent;
-    ::boost::scoped_ptr<SvxRelativeField>   maRightIndent;
-    ::boost::scoped_ptr<SvxRelativeField>   maFLineIndent;
     ::boost::scoped_ptr< ::svx::ToolboxButtonColorUpdater > mpColorUpdater;
 
     /**********************************************************

svx/source/sidebar/text/TextPropertyPanel.cxx

@@ -160,18 +160,14 @@ TextPropertyPanel::TextPropertyPanel (
     :   Control(pParent, SVX_RES(RID_SIDEBAR_TEXT_PANEL)),
         mpFontNameBox (new SvxSBFontNameBox(this, SVX_RES(CB_SBFONT_FONT))),
         maFontSizeBox       (this, SVX_RES(MB_SBFONT_FONTSIZE)),
-        mpToolBoxIncDecBackground(ControlFactory::CreateToolBoxBackground(this)),
-        mpToolBoxIncDec(ControlFactory::CreateToolBox(
-                mpToolBoxIncDecBackground.get(),
-                SVX_RES(TB_INCREASE_DECREASE))),
         mpToolBoxFontBackground(ControlFactory::CreateToolBoxBackground(this)),
         mpToolBoxFont(ControlFactory::CreateToolBox(
                 mpToolBoxFontBackground.get(),
                 SVX_RES(TB_FONT))),
-        mpToolBoxFontColorBackground(ControlFactory::CreateToolBoxBackground(this)),
-        mpToolBoxFontColor(ControlFactory::CreateToolBox(
-                mpToolBoxFontColorBackground.get(),
-                SVX_RES(TB_FONTCOLOR))),
+        mpToolBoxIncDecBackground(ControlFactory::CreateToolBoxBackground(this)),
+        mpToolBoxIncDec(ControlFactory::CreateToolBox(
+                mpToolBoxIncDecBackground.get(),
+                SVX_RES(TB_INCREASE_DECREASE))),
         mpToolBoxScriptBackground(ControlFactory::CreateToolBoxBackground(this)),
         mpToolBoxScript(ControlFactory::CreateToolBox(
                 mpToolBoxScriptBackground.get(),
@@ -184,6 +180,10 @@ TextPropertyPanel::TextPropertyPanel (
         mpToolBoxSpacing(ControlFactory::CreateToolBox(
                 mpToolBoxSpacingBackground.get(),
                 SVX_RES(TB_SPACING))),
+        mpToolBoxFontColorBackground(ControlFactory::CreateToolBoxBackground(this)),
+        mpToolBoxFontColor(ControlFactory::CreateToolBox(
+                mpToolBoxFontColorBackground.get(),
+                SVX_RES(TB_FONTCOLOR))),
         mpToolBoxHighlightBackground(ControlFactory::CreateToolBoxBackground(this)),
         mpToolBoxHighlight(ControlFactory::CreateToolBox(
                 mpToolBoxHighlightBackground.get(),

svx/source/sidebar/text/TextPropertyPanel.hxx

@@ -83,18 +83,18 @@ private:
     //ui controls
     ::boost::scoped_ptr<SvxSBFontNameBox> mpFontNameBox;
     FontSizeBox maFontSizeBox;
-    ::boost::scoped_ptr<Window> mpToolBoxIncDecBackground;
-    ::boost::scoped_ptr<ToolBox> mpToolBoxIncDec;
     ::boost::scoped_ptr<Window> mpToolBoxFontBackground;
     ::boost::scoped_ptr<ToolBox> mpToolBoxFont;
-    ::boost::scoped_ptr<Window> mpToolBoxFontColorBackground;
-    ::boost::scoped_ptr<ToolBox> mpToolBoxFontColor;
+    ::boost::scoped_ptr<Window> mpToolBoxIncDecBackground;
+    ::boost::scoped_ptr<ToolBox> mpToolBoxIncDec;
     ::boost::scoped_ptr<Window> mpToolBoxScriptBackground;
     ::boost::scoped_ptr<ToolBox> mpToolBoxScript;
     ::boost::scoped_ptr<Window> mpToolBoxScriptSwBackground;
     ::boost::scoped_ptr<ToolBox> mpToolBoxScriptSw;
     ::boost::scoped_ptr<Window> mpToolBoxSpacingBackground;
     ::boost::scoped_ptr<ToolBox> mpToolBoxSpacing;
+    ::boost::scoped_ptr<Window> mpToolBoxFontColorBackground;
+    ::boost::scoped_ptr<ToolBox> mpToolBoxFontColor;
     ::boost::scoped_ptr<Window> mpToolBoxHighlightBackground;
     ::boost::scoped_ptr<ToolBox> mpToolBoxHighlight;
     ::boost::scoped_ptr<ToolboxButtonColorUpdater> mpFontColorUpdater;