svtools/source/toolpanel/toolpaneldeck.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 "dummypanel.hxx"
  22 #include "toolpanelcollection.hxx"
  23 #include "paneldecklisteners.hxx"
  24 #include "toolpaneldeckpeer.hxx"
  25 #include <svtools/toolpanel/toolpaneldeck.hxx>
  26 #include <svtools/toolpanel/tablayouter.hxx>
  27 #include <svtools/toolpanel/drawerlayouter.hxx>
  28
  29 #include <com/sun/star/accessibility/XAccessible.hpp>
  30 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  31
  32 #include <tools/diagnose_ex.h>
  33 #include <vcl/vclptr.hxx>
  34
  35 #include <boost/optional.hpp>
  36
  37
  38 namespace svt
  39 {
  40
  41
  42     using ::com::sun::star::uno::Reference;
  43     using ::com::sun::star::accessibility::XAccessible;
  44     using ::com::sun::star::awt::XWindowPeer;
  45     using ::com::sun::star::uno::UNO_SET_THROW;
  46
  47     namespace AccessibleRole = ::com::sun::star::accessibility::AccessibleRole;
  48
  49     enum DeckAction
  50     {
  51         /// activates the first panel
  52         ACTION_ACTIVATE_FIRST,
  53         // activates the panel after the currently active panel
  54         ACTION_ACTIVATE_NEXT,
  55         // activates the panel before the currently active panel
  56         ACTION_ACTIVATE_PREV,
  57         // activates the last panel
  58         ACTION_ACTIVATE_LAST,
  59
  60         // toggles the focus between the active panel and the panel selector
  61         ACTION_TOGGLE_FOCUS,
  62     };
  63
  64
  65     //= ToolPanelDeck_Impl
  66
  67     class ToolPanelDeck_Impl : public IToolPanelDeckListener
  68     {
  69     public:
  70         ToolPanelDeck_Impl( ToolPanelDeck& i_rDeck )
  71             :m_rDeck( i_rDeck )
  72             ,m_aPanelAnchor( VclPtr<vcl::Window>::Create(&i_rDeck, WB_DIALOGCONTROL | WB_CHILDDLGCTRL) )
  73             ,m_aPanels()
  74             ,m_pDummyPanel( new DummyPanel )
  75             ,m_pLayouter()
  76             ,m_bInDtor( false )
  77         {
  78             m_aPanels.AddListener( *this );
  79             m_aPanelAnchor->Show();
  80             m_aPanelAnchor->SetAccessibleRole( AccessibleRole::PANEL );
  81         }
  82
  83         virtual ~ToolPanelDeck_Impl()
  84         {
  85             m_bInDtor = true;
  86         }
  87
  88         PDeckLayouter       GetLayouter() const { return m_pLayouter; }
  89         void                SetLayouter( const PDeckLayouter& i_pNewLayouter );
  90
  91         vcl::Window&             GetPanelWindowAnchor()       { return *m_aPanelAnchor.get(); }
  92
  93         bool                IsDead() const { return m_bInDtor; }
  94
  95         /// notifies our listeners that we're going to die. Only to be called from with our anti-impl's destructor
  96         void                NotifyDying()
  97         {
  98             m_aPanels.RemoveListener( *this );
  99             m_aListeners.Dying();
 100         }
 101
 102         // IToolPanelDeck equivalents
 103         size_t              GetPanelCount() const;
 104         PToolPanel          GetPanel( const size_t i_nPos ) const;
 105         ::boost::optional< size_t >
 106                             GetActivePanel() const;
 107         void                ActivatePanel( const ::boost::optional< size_t >& i_rPanel );
 108         size_t              InsertPanel( const PToolPanel& i_pPanel, const size_t i_nPosition );
 109         PToolPanel          RemovePanel( const size_t i_nPosition );
 110         void                AddListener( IToolPanelDeckListener& i_rListener );
 111         void                RemoveListener( IToolPanelDeckListener& i_rListener );
 112
 113         /// re-layouts everything
 114         void                LayoutAll() { ImplDoLayout(); }
 115
 116         void                DoAction( const DeckAction i_eAction );
 117
 118         bool                FocusActivePanel();
 119
 120     protected:
 121         // IToolPanelDeckListener
 122         virtual void        PanelInserted( const PToolPanel& i_pPanel, const size_t i_nPosition ) SAL_OVERRIDE;
 123         virtual void        PanelRemoved( const size_t i_nPosition ) SAL_OVERRIDE;
 124         virtual void        ActivePanelChanged( const ::boost::optional< size_t >& i_rOldActive, const ::boost::optional< size_t >& i_rNewActive ) SAL_OVERRIDE;
 125         virtual void        LayouterChanged( const PDeckLayouter& i_rNewLayouter ) SAL_OVERRIDE;
 126         virtual void        Dying() SAL_OVERRIDE;
 127
 128     private:
 129         void                ImplDoLayout();
 130         PToolPanel          GetActiveOrDummyPanel_Impl();
 131
 132     private:
 133         ToolPanelDeck&      m_rDeck;
 134         VclPtr<vcl::Window> m_aPanelAnchor;
 135         ToolPanelCollection m_aPanels;
 136         PToolPanel          m_pDummyPanel;
 137         PanelDeckListeners  m_aListeners;
 138         PDeckLayouter       m_pLayouter;
 139         bool                m_bInDtor;
 140     };
 141
 142
 143     PToolPanel ToolPanelDeck_Impl::GetActiveOrDummyPanel_Impl()
 144     {
 145         ::boost::optional< size_t > aActivePanel( m_aPanels.GetActivePanel() );
 146         if ( !aActivePanel )
 147             return m_pDummyPanel;
 148         return m_aPanels.GetPanel( *aActivePanel );
 149     }
 150
 151
 152     void ToolPanelDeck_Impl::SetLayouter( const PDeckLayouter& i_pNewLayouter )
 153     {
 154         ENSURE_OR_RETURN_VOID( i_pNewLayouter.get(), "invalid layouter" );
 155
 156         if ( m_pLayouter.get() )
 157             m_pLayouter->Destroy();
 158
 159         m_pLayouter = i_pNewLayouter;
 160
 161         ImplDoLayout();
 162
 163         m_aListeners.LayouterChanged( m_pLayouter );
 164     }
 165
 166
 167     size_t ToolPanelDeck_Impl::GetPanelCount() const
 168     {
 169         return m_aPanels.GetPanelCount();
 170     }
 171
 172
 173     PToolPanel ToolPanelDeck_Impl::GetPanel( const size_t i_nPos ) const
 174     {
 175         return m_aPanels.GetPanel( i_nPos );
 176     }
 177
 178
 179     ::boost::optional< size_t > ToolPanelDeck_Impl::GetActivePanel() const
 180     {
 181         return m_aPanels.GetActivePanel();
 182     }
 183
 184
 185     void ToolPanelDeck_Impl::ActivatePanel( const ::boost::optional< size_t >& i_rPanel )
 186     {
 187         m_aPanels.ActivatePanel( i_rPanel );
 188     }
 189
 190
 191     size_t ToolPanelDeck_Impl::InsertPanel( const PToolPanel& i_pPanel, const size_t i_nPosition )
 192     {
 193         return m_aPanels.InsertPanel( i_pPanel, i_nPosition );
 194     }
 195
 196
 197     PToolPanel ToolPanelDeck_Impl::RemovePanel( const size_t i_nPosition )
 198     {
 199         return m_aPanels.RemovePanel( i_nPosition );
 200     }
 201
 202
 203     void ToolPanelDeck_Impl::ImplDoLayout()
 204     {
 205         const Rectangle aDeckPlayground( Point(), m_rDeck.GetOutputSizePixel() );
 206
 207         // ask the layouter what is left for our panel, and position the panel container window appropriately
 208         Rectangle aPlaygroundArea( aDeckPlayground );
 209         OSL_ENSURE( m_pLayouter.get(), "ToolPanelDeck_Impl::ImplDoLayout: no layouter!" );
 210         if ( m_pLayouter.get() )
 211         {
 212             aPlaygroundArea = m_pLayouter->Layout( aDeckPlayground );
 213         }
 214         m_aPanelAnchor->SetPosSizePixel( aPlaygroundArea.TopLeft(), aPlaygroundArea.GetSize() );
 215
 216         // position the active panel
 217         const PToolPanel pActive( GetActiveOrDummyPanel_Impl() );
 218         pActive->SetSizePixel( m_aPanelAnchor->GetOutputSizePixel() );
 219     }
 220
 221
 222     void ToolPanelDeck_Impl::AddListener( IToolPanelDeckListener& i_rListener )
 223     {
 224         m_aListeners.AddListener( i_rListener );
 225     }
 226
 227
 228     void ToolPanelDeck_Impl::RemoveListener( IToolPanelDeckListener& i_rListener )
 229     {
 230         m_aListeners.RemoveListener( i_rListener );
 231     }
 232
 233
 234     void ToolPanelDeck_Impl::DoAction( const DeckAction i_eAction )
 235     {
 236         const size_t nPanelCount( m_aPanels.GetPanelCount() );
 237         ::boost::optional< size_t > aActivatePanel;
 238         ::boost::optional< size_t > aCurrentPanel( GetActivePanel() );
 239
 240         switch ( i_eAction )
 241         {
 242         case ACTION_ACTIVATE_FIRST:
 243             if ( nPanelCount > 0 )
 244                 aActivatePanel = 0;
 245             break;
 246         case ACTION_ACTIVATE_PREV:
 247             if ( !aCurrentPanel && ( nPanelCount > 0 ) )
 248                 aActivatePanel = nPanelCount - 1;
 249             else if ( !!aCurrentPanel && ( *aCurrentPanel > 0 ) )
 250                 aActivatePanel = *aCurrentPanel - 1;
 251             break;
 252         case ACTION_ACTIVATE_NEXT:
 253             if ( !aCurrentPanel && ( nPanelCount > 0 ) )
 254                 aActivatePanel = 0;
 255             else if ( !!aCurrentPanel && ( *aCurrentPanel < nPanelCount - 1 ) )
 256                 aActivatePanel = *aCurrentPanel + 1;
 257             break;
 258         case ACTION_ACTIVATE_LAST:
 259             if ( nPanelCount > 0 )
 260                 aActivatePanel = nPanelCount - 1;
 261             break;
 262         case ACTION_TOGGLE_FOCUS:
 263             {
 264                 PToolPanel pActivePanel( GetActiveOrDummyPanel_Impl() );
 265                 if ( !m_aPanelAnchor->HasChildPathFocus() )
 266                     pActivePanel->GrabFocus();
 267                 else
 268                     GetLayouter()->SetFocusToPanelSelector();
 269             }
 270             break;
 271         }
 272
 273         if ( !!aActivatePanel )
 274         {
 275             ActivatePanel( aActivatePanel );
 276         }
 277     }
 278
 279
 280     bool ToolPanelDeck_Impl::FocusActivePanel()
 281     {
 282         ::boost::optional< size_t > aActivePanel( m_aPanels.GetActivePanel() );
 283         if ( !aActivePanel )
 284             return false;
 285
 286         PToolPanel pActivePanel( m_aPanels.GetPanel( *aActivePanel ) );
 287         pActivePanel->GrabFocus();
 288         return true;
 289     }
 290
 291
 292     void ToolPanelDeck_Impl::PanelInserted( const PToolPanel& i_pPanel, const size_t i_nPosition )
 293     {
 294         // multiplex to our own listeners
 295         m_aListeners.PanelInserted( i_pPanel, i_nPosition );
 296     }
 297
 298
 299     void ToolPanelDeck_Impl::PanelRemoved( const size_t i_nPosition )
 300     {
 301         // multiplex to our own listeners
 302         m_aListeners.PanelRemoved( i_nPosition );
 303     }
 304
 305
 306     void ToolPanelDeck_Impl::ActivePanelChanged( const ::boost::optional< size_t >& i_rOldActive, const ::boost::optional< size_t >& i_rNewActive )
 307     {
 308         // hide the old panel
 309         if ( !!i_rOldActive )
 310         {
 311             const PToolPanel pOldActive( m_aPanels.GetPanel( *i_rOldActive ) );
 312             pOldActive->Deactivate();
 313         }
 314
 315         // position and show the new panel
 316         const PToolPanel pNewActive( !i_rNewActive ? m_pDummyPanel : m_aPanels.GetPanel( *i_rNewActive ) );
 317         pNewActive->Activate( *m_aPanelAnchor.get() );
 318         pNewActive->GrabFocus();
 319
 320         // resize the panel (cannot guarantee it has ever been resized before
 321         pNewActive->SetSizePixel( m_aPanelAnchor->GetOutputSizePixel() );
 322
 323         // multiplex to our own listeners
 324         m_aListeners.ActivePanelChanged( i_rOldActive, i_rNewActive );
 325     }
 326
 327
 328     void ToolPanelDeck_Impl::LayouterChanged( const PDeckLayouter& i_rNewLayouter )
 329     {
 330         // not interested in
 331         (void)i_rNewLayouter;
 332     }
 333
 334
 335     void ToolPanelDeck_Impl::Dying()
 336     {
 337         // not interested in. Since the ToolPanelCollection is our member, this just means we ourself
 338         // are dying, and we already sent this notification in our dtor.
 339     }
 340
 341
 342     //= ToolPanelDeck
 343
 344
 345     ToolPanelDeck::ToolPanelDeck( vcl::Window& i_rParent, const WinBits i_nStyle )
 346         :Control( &i_rParent, i_nStyle )
 347         ,m_pImpl( new ToolPanelDeck_Impl( *this ) )
 348     {
 349         // use a default layouter
 350 //        SetLayouter( PDeckLayouter( new TabDeckLayouter( *this, *this, TABS_RIGHT, TABITEM_IMAGE_AND_TEXT ) ) );
 351         SetLayouter( PDeckLayouter( new DrawerDeckLayouter( *this, *this ) ) );
 352     }
 353
 354
 355     ToolPanelDeck::~ToolPanelDeck()
 356     {
 357         disposeOnce();
 358     }
 359
 360     void ToolPanelDeck::dispose()
 361     {
 362         m_pImpl->NotifyDying();
 363         GetLayouter()->Destroy();
 364
 365         Hide();
 366         for ( size_t i=0; i<GetPanelCount(); ++i )
 367         {
 368             PToolPanel pPanel( GetPanel( i ) );
 369             pPanel->Dispose();
 370         }
 371         Control::dispose();
 372     }
 373
 374
 375     size_t ToolPanelDeck::GetPanelCount() const
 376     {
 377         return m_pImpl->GetPanelCount();
 378     }
 379
 380
 381     PToolPanel ToolPanelDeck::GetPanel( const size_t i_nPos ) const
 382     {
 383         return m_pImpl->GetPanel( i_nPos );
 384     }
 385
 386
 387     ::boost::optional< size_t > ToolPanelDeck::GetActivePanel() const
 388     {
 389         return m_pImpl->GetActivePanel();
 390     }
 391
 392
 393     void ToolPanelDeck::ActivatePanel( const ::boost::optional< size_t >& i_rPanel )
 394     {
 395         m_pImpl->ActivatePanel( i_rPanel );
 396     }
 397
 398
 399     size_t ToolPanelDeck::InsertPanel( const PToolPanel& i_pPanel, const size_t i_nPosition )
 400     {
 401         return m_pImpl->InsertPanel( i_pPanel, i_nPosition );
 402     }
 403
 404
 405     PToolPanel ToolPanelDeck::RemovePanel( const size_t i_nPosition )
 406     {
 407         return m_pImpl->RemovePanel( i_nPosition );
 408     }
 409
 410
 411     PDeckLayouter ToolPanelDeck::GetLayouter() const
 412     {
 413         return m_pImpl->GetLayouter();
 414     }
 415
 416
 417     void ToolPanelDeck::SetLayouter( const PDeckLayouter& i_pNewLayouter )
 418     {
 419         return m_pImpl->SetLayouter( i_pNewLayouter );
 420     }
 421
 422
 423     void ToolPanelDeck::AddListener( IToolPanelDeckListener& i_rListener )
 424     {
 425         m_pImpl->AddListener( i_rListener );
 426     }
 427
 428
 429     void ToolPanelDeck::RemoveListener( IToolPanelDeckListener& i_rListener )
 430     {
 431         m_pImpl->RemoveListener( i_rListener );
 432     }
 433
 434
 435     vcl::Window& ToolPanelDeck::GetPanelWindowAnchor()
 436     {
 437         return m_pImpl->GetPanelWindowAnchor();
 438     }
 439
 440
 441     const vcl::Window& ToolPanelDeck::GetPanelWindowAnchor() const
 442     {
 443         return m_pImpl->GetPanelWindowAnchor();
 444     }
 445
 446
 447     void ToolPanelDeck::Resize()
 448     {
 449         Control::Resize();
 450         m_pImpl->LayoutAll();
 451     }
 452
 453
 454     bool ToolPanelDeck::Notify( NotifyEvent& i_rNotifyEvent )
 455     {
 456         bool bHandled = false;
 457         if ( i_rNotifyEvent.GetType() == MouseNotifyEvent::KEYINPUT )
 458         {
 459             const KeyEvent* pEvent = i_rNotifyEvent.GetKeyEvent();
 460             const vcl::KeyCode& rKeyCode = pEvent->GetKeyCode();
 461             if ( rKeyCode.GetModifier() == KEY_MOD1 )
 462             {
 463                 bHandled = true;
 464                 switch ( rKeyCode.GetCode() )
 465                 {
 466                 case KEY_HOME:
 467                     m_pImpl->DoAction( ACTION_ACTIVATE_FIRST );
 468                     break;
 469                 case KEY_PAGEUP:
 470                     m_pImpl->DoAction( ACTION_ACTIVATE_PREV );
 471                     break;
 472                 case KEY_PAGEDOWN:
 473                     m_pImpl->DoAction( ACTION_ACTIVATE_NEXT );
 474                     break;
 475                 case KEY_END:
 476                     m_pImpl->DoAction( ACTION_ACTIVATE_LAST );
 477                     break;
 478                 default:
 479                     bHandled = false;
 480                     break;
 481                 }
 482             }
 483             else if ( rKeyCode.GetModifier() == ( KEY_MOD1 | KEY_SHIFT ) )
 484             {
 485                 if ( rKeyCode.GetCode() == KEY_E )
 486                 {
 487                     m_pImpl->DoAction( ACTION_TOGGLE_FOCUS );
 488                     bHandled = true;
 489                 }
 490             }
 491         }
 492
 493         if ( bHandled )
 494             return true;
 495
 496         return Control::Notify( i_rNotifyEvent );
 497     }
 498
 499
 500     void ToolPanelDeck::GetFocus()
 501     {
 502         Control::GetFocus();
 503         if ( m_pImpl->IsDead() )
 504             return;
 505         if ( !m_pImpl->FocusActivePanel() )
 506         {
 507             PDeckLayouter pLayouter( GetLayouter() );
 508             ENSURE_OR_RETURN_VOID( pLayouter.get(), "ToolPanelDeck::GetFocus: no layouter?!" );
 509             pLayouter->SetFocusToPanelSelector();
 510         }
 511     }
 512
 513
 514     Reference< XWindowPeer > ToolPanelDeck::GetComponentInterface( bool i_bCreate )
 515     {
 516         Reference< XWindowPeer > xWindowPeer( Control::GetComponentInterface( false ) );
 517         if ( !xWindowPeer.is() && i_bCreate )
 518         {
 519             xWindowPeer.set( new ToolPanelDeckPeer( *this ) );
 520             SetComponentInterface( xWindowPeer );
 521         }
 522         return xWindowPeer;
 523     }
 524
 525
 526 } // namespace svt
 527
 528
 529 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */