svtools/source/toolpanel/drawerlayouter.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 #include <svtools/toolpanel/drawerlayouter.hxx>
  22 #include "toolpaneldrawer.hxx"
  23
  24 #include <com/sun/star/accessibility/XAccessible.hpp>
  25
  26 #include <comphelper/accimplaccess.hxx>
  27 #include <tools/diagnose_ex.h>
  28
  29
  30 namespace svt
  31 {
  32
  33
  34     using ::com::sun::star::uno::Reference;
  35     using ::com::sun::star::accessibility::XAccessible;
  36
  37
  38     //= DrawerDeckLayouter
  39
  40
  41     DrawerDeckLayouter::DrawerDeckLayouter( vcl::Window& i_rParentWindow, IToolPanelDeck& i_rPanels )
  42         :m_rParentWindow( i_rParentWindow )
  43         ,m_rPanelDeck( i_rPanels )
  44         ,m_aDrawers()
  45         ,m_aLastKnownActivePanel()
  46     {
  47         m_rPanelDeck.AddListener( *this );
  48
  49         // simulate PanelInserted events for the panels which are already there
  50         for ( size_t i=0; i<m_rPanelDeck.GetPanelCount(); ++i )
  51             PanelInserted( m_rPanelDeck.GetPanel( i ), i );
  52     }
  53
  54
  55     DrawerDeckLayouter::~DrawerDeckLayouter()
  56     {
  57     }
  58
  59
  60     Rectangle DrawerDeckLayouter::Layout( const Rectangle& i_rDeckPlayground )
  61     {
  62         const size_t nPanelCount( m_rPanelDeck.GetPanelCount() );
  63         if ( nPanelCount == 0 )
  64             return i_rDeckPlayground;
  65
  66         const int nWidth( i_rDeckPlayground.GetWidth() );
  67         ::boost::optional< size_t > aActivePanel( m_rPanelDeck.GetActivePanel() );
  68         if ( !aActivePanel )
  69             aActivePanel = m_aLastKnownActivePanel;
  70
  71         // arrange the title bars which are *above* the active panel (or *all* if there is no active panel), plus
  72         // the title bar of the active panel itself
  73         Point aUpperDrawerPos( i_rDeckPlayground.TopLeft() );
  74         const size_t nUpperBound = !!aActivePanel ? *aActivePanel : nPanelCount - 1;
  75         for ( size_t i=0; i<=nUpperBound; ++i )
  76         {
  77             long const nDrawerHeight = m_aDrawers[i]->GetPreferredHeightPixel();
  78             m_aDrawers[i]->SetPosSizePixel(
  79                 aUpperDrawerPos, Size( nWidth, nDrawerHeight ) );
  80             aUpperDrawerPos.Move( 0, nDrawerHeight );
  81         }
  82
  83         // arrange title bars which are below the active panel (or *none* if there is no active panel)
  84         Point aLowerDrawerPos( i_rDeckPlayground.BottomLeft() );
  85         for ( size_t j = nPanelCount - 1; j > nUpperBound; --j )
  86         {
  87             long const nDrawerHeight = m_aDrawers[j]->GetPreferredHeightPixel();
  88             m_aDrawers[j]->SetPosSizePixel(
  89                 Point( aLowerDrawerPos.X(), aLowerDrawerPos.Y() - nDrawerHeight + 1 ),
  90                 Size( nWidth, nDrawerHeight )
  91             );
  92             aLowerDrawerPos.Move( 0, -nDrawerHeight );
  93         }
  94
  95         // fincally calculate the rectangle for the active panel
  96         return Rectangle(
  97             aUpperDrawerPos,
  98             Size( nWidth, aLowerDrawerPos.Y() - aUpperDrawerPos.Y() + 1 )
  99         );
 100     }
 101
 102
 103     void DrawerDeckLayouter::Destroy()
 104     {
 105         while ( !m_aDrawers.empty() )
 106             impl_removeDrawer( 0 );
 107         m_rPanelDeck.RemoveListener( *this );
 108     }
 109
 110
 111     void DrawerDeckLayouter::SetFocusToPanelSelector()
 112     {
 113         const size_t nPanelCount( m_rPanelDeck.GetPanelCount() );
 114         if ( !nPanelCount )
 115             // nothing to focus
 116             return;
 117         ::boost::optional< size_t > aActivePanel( m_rPanelDeck.GetActivePanel() );
 118         if ( !aActivePanel )
 119             aActivePanel = 0;
 120         ENSURE_OR_RETURN_VOID( *aActivePanel < m_aDrawers.size(), "DrawerDeckLayouter::SetFocusToPanelSelector: invalid active panel, or inconsistent drawers!" );
 121         m_aDrawers[ *aActivePanel ]->GrabFocus();
 122     }
 123
 124
 125     size_t DrawerDeckLayouter::GetAccessibleChildCount() const
 126     {
 127         return m_aDrawers.size();
 128     }
 129
 130
 131     Reference< XAccessible > DrawerDeckLayouter::GetAccessibleChild( const size_t i_nChildIndex, const Reference< XAccessible >& i_rParentAccessible )
 132     {
 133         ENSURE_OR_RETURN( i_nChildIndex < m_aDrawers.size(), "illegal index", NULL );
 134
 135         VclPtr<ToolPanelDrawer> pDrawer( m_aDrawers[ i_nChildIndex ] );
 136
 137         Reference< XAccessible > xItemAccessible = pDrawer->GetAccessible( false );
 138         if ( !xItemAccessible.is() )
 139         {
 140             xItemAccessible = pDrawer->GetAccessible( true );
 141             ENSURE_OR_RETURN( xItemAccessible.is(), "illegal accessible provided by the drawer implementation!", NULL );
 142             OSL_VERIFY( ::comphelper::OAccessibleImplementationAccess::setAccessibleParent( xItemAccessible->getAccessibleContext(),
 143                 i_rParentAccessible ) );
 144         }
 145
 146         return xItemAccessible;
 147     }
 148
 149
 150     void DrawerDeckLayouter::PanelInserted( const PToolPanel& i_pPanel, const size_t i_nPosition )
 151     {
 152         OSL_PRECOND( i_nPosition <= m_aDrawers.size(), "DrawerDeckLayouter::PanelInserted: inconsistency!" );
 153
 154         VclPtrInstance<ToolPanelDrawer> pDrawer( m_rParentWindow, i_pPanel->GetDisplayName() );
 155         pDrawer->SetHelpId( i_pPanel->GetHelpID() );
 156         // proper Z-Order
 157         if ( i_nPosition == 0 )
 158         {
 159             pDrawer->SetZOrder( NULL, WINDOW_ZORDER_FIRST );
 160         }
 161         else
 162         {
 163             ToolPanelDrawer* pFirstDrawer( m_aDrawers[ i_nPosition - 1 ] );
 164             pDrawer->SetZOrder( pFirstDrawer, WINDOW_ZORDER_BEHIND );
 165         }
 166
 167         pDrawer->Show();
 168         pDrawer->AddEventListener( LINK( this, DrawerDeckLayouter, OnWindowEvent ) );
 169         m_aDrawers.insert( m_aDrawers.begin() + i_nPosition, pDrawer );
 170         impl_triggerRearrange();
 171     }
 172
 173
 174     void DrawerDeckLayouter::PanelRemoved( const size_t i_nPosition )
 175     {
 176         impl_removeDrawer( i_nPosition );
 177         impl_triggerRearrange();
 178     }
 179
 180
 181     void DrawerDeckLayouter::impl_triggerRearrange() const
 182     {
 183         // this is somewhat hacky, it assumes that the parent of our panels is a tool panel deck, which, in its
 184         // Resize implementation, rearrances all elements.
 185         m_rParentWindow.Resize();
 186     }
 187
 188
 189     void DrawerDeckLayouter::ActivePanelChanged( const ::boost::optional< size_t >& i_rOldActive, const ::boost::optional< size_t >& i_rNewActive )
 190     {
 191         if ( !!i_rOldActive )
 192         {
 193             OSL_ENSURE( *i_rOldActive < m_aDrawers.size(), "DrawerDeckLayouter::ActivePanelChanged: illegal old index!" );
 194             m_aDrawers[ *i_rOldActive ]->SetExpanded( false );
 195         }
 196
 197         if ( !!i_rNewActive )
 198         {
 199             OSL_ENSURE( *i_rNewActive < m_aDrawers.size(), "DrawerDeckLayouter::ActivePanelChanged: illegal new index!" );
 200             m_aDrawers[ *i_rNewActive ]->SetExpanded( true );
 201         }
 202
 203         impl_triggerRearrange();
 204     }
 205
 206
 207     void DrawerDeckLayouter::LayouterChanged( const PDeckLayouter& i_rNewLayouter )
 208     {
 209         // not interested in
 210         (void)i_rNewLayouter;
 211     }
 212
 213
 214     size_t DrawerDeckLayouter::impl_getPanelPositionFromWindow( const vcl::Window* i_pDrawerWindow ) const
 215     {
 216         for ( auto drawerPos = m_aDrawers.begin(); drawerPos != m_aDrawers.end(); ++drawerPos )
 217         {
 218             if ( drawerPos->get() == i_pDrawerWindow )
 219                 return drawerPos - m_aDrawers.begin();
 220         }
 221         return m_aDrawers.size();
 222     }
 223
 224
 225     void DrawerDeckLayouter::impl_removeDrawer( const size_t i_nPosition )
 226     {
 227         OSL_PRECOND( i_nPosition < m_aDrawers.size(), "DrawerDeckLayouter::impl_removeDrawer: invalid panel position!" );
 228         m_aDrawers[ i_nPosition ]->RemoveEventListener( LINK( this, DrawerDeckLayouter, OnWindowEvent ) );
 229         m_aDrawers.erase( m_aDrawers.begin() + i_nPosition );
 230     }
 231
 232
 233     IMPL_LINK( DrawerDeckLayouter, OnWindowEvent, VclSimpleEvent*, i_pEvent )
 234     {
 235         const VclWindowEvent* pWindowEvent = PTR_CAST( VclWindowEvent, i_pEvent );
 236         ENSURE_OR_RETURN( pWindowEvent, "no WindowEvent", 0L );
 237
 238         bool bActivatePanel = false;
 239         switch ( pWindowEvent->GetId() )
 240         {
 241             case VCLEVENT_WINDOW_MOUSEBUTTONUP:
 242             {
 243                 const MouseEvent* pMouseEvent = static_cast< const MouseEvent* >( pWindowEvent->GetData() );
 244                 ENSURE_OR_RETURN( pMouseEvent, "no mouse event with MouseButtonUp", 0L );
 245                 if ( pMouseEvent->GetButtons() == MOUSE_LEFT )
 246                 {
 247                     bActivatePanel = true;
 248                 }
 249             }
 250             break;
 251             case VCLEVENT_WINDOW_KEYINPUT:
 252             {
 253                 const KeyEvent* pKeyEvent = static_cast< const KeyEvent* >( pWindowEvent->GetData() );
 254                 ENSURE_OR_RETURN( pKeyEvent, "no key event with KeyInput", 0L );
 255                 const vcl::KeyCode& rKeyCode( pKeyEvent->GetKeyCode() );
 256                 if ( ( rKeyCode.GetModifier() == 0 ) && ( rKeyCode.GetCode() == KEY_RETURN ) )
 257                 {
 258                     bActivatePanel = true;
 259                 }
 260             }
 261             break;
 262         }
 263         if ( bActivatePanel )
 264         {
 265             const size_t nPanelPos = impl_getPanelPositionFromWindow( pWindowEvent->GetWindow() );
 266             if ( nPanelPos != m_rPanelDeck.GetActivePanel() )
 267             {
 268                 m_rPanelDeck.ActivatePanel( nPanelPos );
 269             }
 270             else
 271             {
 272                 PToolPanel pPanel( m_rPanelDeck.GetPanel( nPanelPos ) );
 273                 pPanel->GrabFocus();
 274             }
 275             return 1L;
 276         }
 277         return 0L;
 278     }
 279
 280
 281     void DrawerDeckLayouter::Dying()
 282     {
 283         Destroy();
 284     }
 285
 286
 287 } // namespace svt
 288
 289
 290 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */