sd/source/ui/slideshow/showwin.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 #include <com/sun/star/awt/Key.hpp>
  21
  22 #include "showwindow.hxx"
  23
  24 #include <unotools/syslocale.hxx>
  25 #include <sfx2/viewfrm.hxx>
  26
  27
  28 #include <slideshow.hxx>
  29 #include <ViewShellBase.hxx>
  30 #include <sdresid.hxx>
  31 #include <helpids.h>
  32 #include <strings.hrc>
  33
  34 #include <vcl/settings.hxx>
  35 #include <vcl/virdev.hxx>
  36
  37 using namespace ::com::sun::star;
  38
  39 namespace sd {
  40
  41 static const sal_uInt64 HIDE_MOUSE_TIMEOUT = 10000;
  42 static const sal_uInt64 SHOW_MOUSE_TIMEOUT = 1000;
  43
  44 ShowWindow::ShowWindow( const ::rtl::Reference< SlideshowImpl >& xController, vcl::Window* pParent )
  45 : ::sd::Window( pParent )
  46 , mnPauseTimeout( SLIDE_NO_TIMEOUT )
  47 , mnRestartPageIndex( PAGE_NO_END )
  48 , meShowWindowMode(SHOWWINDOWMODE_NORMAL)
  49 , mbShowNavigatorAfterSpecialMode( false )
  50 , mbMouseAutoHide(true)
  51 , mbMouseCursorHidden(false)
  52 , mnFirstMouseMove(0)
  53 , mxController( xController )
  54 {
  55     SetOutDevViewType( OutDevViewType::SlideShow );
  56
  57     // Do never mirror the preview window.  This explicitly includes right
  58     // to left writing environments.
  59     EnableRTL (false);
  60
  61     MapMode aMap(GetMapMode());
  62     aMap.SetMapUnit(MapUnit::Map100thMM);
  63     SetMapMode(aMap);
  64
  65     // set HelpId
  66     SetHelpId( HID_SD_WIN_PRESENTATION );
  67
  68     maPauseTimer.SetInvokeHandler( LINK( this, ShowWindow, PauseTimeoutHdl ) );
  69     maPauseTimer.SetTimeout( 1000 );
  70     maMouseTimer.SetInvokeHandler( LINK( this, ShowWindow, MouseTimeoutHdl ) );
  71     maMouseTimer.SetTimeout( HIDE_MOUSE_TIMEOUT );
  72
  73     maShowBackground = Wallpaper( COL_BLACK );
  74     SetBackground(); // avoids that VCL paints any background!
  75     GetParent()->Show();
  76     AddEventListener( LINK( this, ShowWindow, EventHdl ) );
  77 }
  78
  79 ShowWindow::~ShowWindow()
  80 {
  81     disposeOnce();
  82 }
  83
  84 void ShowWindow::dispose()
  85 {
  86     maPauseTimer.Stop();
  87     maMouseTimer.Stop();
  88     ::sd::Window::dispose();
  89 }
  90
  91 void ShowWindow::KeyInput(const KeyEvent& rKEvt)
  92 {
  93     bool bReturn = false;
  94
  95     if( SHOWWINDOWMODE_PREVIEW == meShowWindowMode )
  96     {
  97         TerminateShow();
  98         bReturn = true;
  99     }
 100     else if( SHOWWINDOWMODE_END == meShowWindowMode )
 101     {
 102         const int nKeyCode = rKEvt.GetKeyCode().GetCode();
 103         switch( nKeyCode )
 104         {
 105         case KEY_PAGEUP:
 106         case KEY_LEFT:
 107         case KEY_UP:
 108         case KEY_P:
 109         case KEY_HOME:
 110         case KEY_END:
 111         case awt::Key::CONTEXTMENU:
 112             // these keys will be handled by the slide show even
 113             // while in end mode
 114             break;
 115         default:
 116             TerminateShow();
 117             bReturn = true;
 118         }
 119     }
 120     else if( SHOWWINDOWMODE_BLANK == meShowWindowMode )
 121     {
 122         RestartShow();
 123         bReturn = true;
 124     }
 125     else if( SHOWWINDOWMODE_PAUSE == meShowWindowMode )
 126     {
 127         const int nKeyCode = rKEvt.GetKeyCode().GetCode();
 128         switch( nKeyCode )
 129         {
 130         case KEY_ESCAPE:
 131             TerminateShow();
 132             bReturn = true;
 133             break;
 134         case KEY_PAGEUP:
 135         case KEY_RIGHT:
 136         case KEY_UP:
 137         case KEY_P:
 138         case KEY_HOME:
 139         case KEY_END:
 140         case awt::Key::CONTEXTMENU:
 141             // these keys will be handled by the slide show even
 142             // while in end mode
 143             break;
 144         default:
 145             RestartShow();
 146             bReturn = true;
 147             break;
 148         }
 149     }
 150
 151     if( !bReturn )
 152     {
 153         if( mxController.is() )
 154             bReturn = mxController->keyInput(rKEvt);
 155
 156         if( !bReturn )
 157         {
 158             if( mpViewShell )
 159             {
 160                 mpViewShell->KeyInput(rKEvt,this);
 161             }
 162             else
 163             {
 164                 Window::KeyInput(rKEvt);
 165             }
 166         }
 167     }
 168
 169     if( mpViewShell )
 170         mpViewShell->SetActiveWindow( this );
 171 }
 172
 173 void ShowWindow::MouseButtonDown(const MouseEvent& /*rMEvt*/)
 174 {
 175     if( SHOWWINDOWMODE_PREVIEW == meShowWindowMode )
 176     {
 177         TerminateShow();
 178     }
 179     else if( mpViewShell )
 180     {
 181         mpViewShell->SetActiveWindow( this );
 182     }
 183 }
 184
 185 void ShowWindow::MouseMove(const MouseEvent& /*rMEvt*/)
 186 {
 187     if( mbMouseAutoHide )
 188     {
 189         if( mbMouseCursorHidden )
 190         {
 191             if( mnFirstMouseMove )
 192             {
 193                 // if this is not the first mouse move while hidden, see if
 194                 // enough time has pasted to show mouse pointer again
 195                 sal_uInt64 nTime = ::tools::Time::GetSystemTicks();
 196                 if( (nTime - mnFirstMouseMove) >= SHOW_MOUSE_TIMEOUT )
 197                 {
 198                     ShowPointer( true );
 199                     mnFirstMouseMove = 0;
 200                     mbMouseCursorHidden = false;
 201                     maMouseTimer.SetTimeout( HIDE_MOUSE_TIMEOUT );
 202                     maMouseTimer.Start();
 203                 }
 204             }
 205             else
 206             {
 207                 // if this is the first mouse move, note current
 208                 // time and start idle timer to cancel show mouse pointer
 209                 // again if not enough mouse movement is measured
 210                 mnFirstMouseMove = ::tools::Time::GetSystemTicks();
 211                 maMouseTimer.SetTimeout( 2*SHOW_MOUSE_TIMEOUT );
 212                 maMouseTimer.Start();
 213             }
 214         }
 215         else
 216         {
 217             // current mousemove restarts the idle timer to hide the mouse
 218             maMouseTimer.Start();
 219         }
 220     }
 221
 222     if( mpViewShell )
 223         mpViewShell->SetActiveWindow( this );
 224 }
 225
 226 void ShowWindow::MouseButtonUp(const MouseEvent& rMEvt)
 227 {
 228     if( SHOWWINDOWMODE_PREVIEW == meShowWindowMode )
 229     {
 230         TerminateShow();
 231     }
 232     else if( (SHOWWINDOWMODE_END == meShowWindowMode) && !rMEvt.IsRight() )
 233     {
 234         TerminateShow();
 235     }
 236     else if( (( SHOWWINDOWMODE_BLANK == meShowWindowMode ) || ( SHOWWINDOWMODE_PAUSE == meShowWindowMode ))
 237              && !rMEvt.IsRight() )
 238     {
 239         RestartShow();
 240     }
 241     else
 242     {
 243         if( mxController.is() )
 244             mxController->mouseButtonUp( rMEvt );
 245     }
 246 }
 247
 248 /**
 249  * if FuSlideShow is still available, forward it
 250  */
 251 void ShowWindow::Paint(vcl::RenderContext& /*rRenderContext*/, const ::tools::Rectangle& rRect)
 252 {
 253     if( (meShowWindowMode == SHOWWINDOWMODE_NORMAL) || (meShowWindowMode == SHOWWINDOWMODE_PREVIEW) )
 254     {
 255         if( mxController.is() )
 256         {
 257             mxController->paint();
 258         }
 259         else if(mpViewShell )
 260         {
 261             mpViewShell->Paint(rRect, this);
 262         }
 263     }
 264     else
 265     {
 266         DrawWallpaper( rRect, maShowBackground );
 267
 268         if( SHOWWINDOWMODE_END == meShowWindowMode )
 269         {
 270             DrawEndScene();
 271         }
 272         else if( SHOWWINDOWMODE_PAUSE == meShowWindowMode )
 273         {
 274             DrawPauseScene( false );
 275         }
 276         else if( SHOWWINDOWMODE_BLANK == meShowWindowMode )
 277         {
 278             // just blank through background color => nothing to be done here
 279         }
 280     }
 281 }
 282
 283 void ShowWindow::LoseFocus()
 284 {
 285     Window::LoseFocus();
 286
 287     if( SHOWWINDOWMODE_PREVIEW == meShowWindowMode)
 288         TerminateShow();
 289 }
 290
 291 void ShowWindow::SetEndMode()
 292 {
 293     if( ( SHOWWINDOWMODE_NORMAL == meShowWindowMode ) && mpViewShell && mpViewShell->GetView() )
 294     {
 295         DeleteWindowFromPaintView();
 296         meShowWindowMode = SHOWWINDOWMODE_END;
 297         maShowBackground = Wallpaper( COL_BLACK );
 298
 299         // hide navigator if it is visible
 300         if( mpViewShell->GetViewFrame()->GetChildWindow( SID_NAVIGATOR ) )
 301         {
 302             mpViewShell->GetViewFrame()->ShowChildWindow( SID_NAVIGATOR, false );
 303             mbShowNavigatorAfterSpecialMode = true;
 304         }
 305
 306         Invalidate();
 307     }
 308 }
 309
 310 bool ShowWindow::SetPauseMode( sal_Int32 nTimeout, Graphic const * pLogo )
 311 {
 312     rtl::Reference< SlideShow > xSlideShow;
 313
 314     if( mpViewShell )
 315         xSlideShow = SlideShow::GetSlideShow( mpViewShell->GetViewShellBase() );
 316
 317     if( xSlideShow.is() && !nTimeout )
 318     {
 319         xSlideShow->jumpToPageIndex( 0 );
 320     }
 321     else if( ( SHOWWINDOWMODE_NORMAL == meShowWindowMode ) && mpViewShell && mpViewShell->GetView() )
 322     {
 323         DeleteWindowFromPaintView();
 324         mnPauseTimeout = nTimeout;
 325         mnRestartPageIndex = 0;
 326         meShowWindowMode = SHOWWINDOWMODE_PAUSE;
 327         maShowBackground = Wallpaper( COL_BLACK );
 328
 329         // hide navigator if it is visible
 330         if( mpViewShell->GetViewFrame()->GetChildWindow( SID_NAVIGATOR ) )
 331         {
 332             mpViewShell->GetViewFrame()->ShowChildWindow( SID_NAVIGATOR, false );
 333             mbShowNavigatorAfterSpecialMode = true;
 334         }
 335
 336         if( pLogo )
 337             maLogo = *pLogo;
 338
 339         Invalidate();
 340
 341         if( SLIDE_NO_TIMEOUT != mnPauseTimeout )
 342             maPauseTimer.Start();
 343     }
 344
 345     return( SHOWWINDOWMODE_PAUSE == meShowWindowMode );
 346 }
 347
 348 bool ShowWindow::SetBlankMode( sal_Int32 nPageIndexToRestart, const Color& rBlankColor )
 349 {
 350     if( ( SHOWWINDOWMODE_NORMAL == meShowWindowMode ) && mpViewShell && mpViewShell->GetView() )
 351     {
 352         DeleteWindowFromPaintView();
 353         mnRestartPageIndex = nPageIndexToRestart;
 354         meShowWindowMode = SHOWWINDOWMODE_BLANK;
 355         maShowBackground = Wallpaper( rBlankColor );
 356
 357         // hide navigator if it is visible
 358         if( mpViewShell->GetViewFrame()->GetChildWindow( SID_NAVIGATOR ) )
 359         {
 360             mpViewShell->GetViewFrame()->ShowChildWindow( SID_NAVIGATOR, false );
 361             mbShowNavigatorAfterSpecialMode = true;
 362         }
 363
 364         Invalidate();
 365     }
 366
 367     return( SHOWWINDOWMODE_BLANK == meShowWindowMode );
 368 }
 369
 370 void ShowWindow::SetPreviewMode()
 371 {
 372     meShowWindowMode = SHOWWINDOWMODE_PREVIEW;
 373 }
 374
 375 void ShowWindow::TerminateShow()
 376 {
 377     maLogo.Clear();
 378     maPauseTimer.Stop();
 379     maMouseTimer.Stop();
 380     Erase();
 381     maShowBackground = Wallpaper( COL_BLACK );
 382     meShowWindowMode = SHOWWINDOWMODE_NORMAL;
 383     mnPauseTimeout = SLIDE_NO_TIMEOUT;
 384
 385     if( mpViewShell )
 386     {
 387         // show navigator?
 388         if( mbShowNavigatorAfterSpecialMode )
 389         {
 390             mpViewShell->GetViewFrame()->ShowChildWindow( SID_NAVIGATOR );
 391             mbShowNavigatorAfterSpecialMode = false;
 392         }
 393     }
 394
 395     if( mxController.is() )
 396         mxController->endPresentation();
 397
 398     mnRestartPageIndex = PAGE_NO_END;
 399 }
 400
 401 void ShowWindow::RestartShow()
 402 {
 403     RestartShow( mnRestartPageIndex );
 404 }
 405
 406 void ShowWindow::RestartShow( sal_Int32 nPageIndexToRestart )
 407
 408 {
 409     ShowWindowMode eOldShowWindowMode = meShowWindowMode;
 410
 411     maLogo.Clear();
 412     maPauseTimer.Stop();
 413     Erase();
 414     maShowBackground = Wallpaper( COL_BLACK );
 415     meShowWindowMode = SHOWWINDOWMODE_NORMAL;
 416     mnPauseTimeout = SLIDE_NO_TIMEOUT;
 417
 418     if( mpViewShell )
 419     {
 420         rtl::Reference< SlideShow > xSlideShow( SlideShow::GetSlideShow( mpViewShell->GetViewShellBase() ) );
 421
 422          if( xSlideShow.is() )
 423         {
 424             AddWindowToPaintView();
 425
 426             if( SHOWWINDOWMODE_BLANK == eOldShowWindowMode )
 427             {
 428                 xSlideShow->pause(false);
 429                 Invalidate();
 430             }
 431             else
 432             {
 433                 xSlideShow->jumpToPageIndex( nPageIndexToRestart );
 434             }
 435         }
 436     }
 437
 438     mnRestartPageIndex = PAGE_NO_END;
 439
 440     // show navigator?
 441     if( mbShowNavigatorAfterSpecialMode )
 442     {
 443         if (mpViewShell)
 444             mpViewShell->GetViewFrame()->ShowChildWindow( SID_NAVIGATOR );
 445         mbShowNavigatorAfterSpecialMode = false;
 446     }
 447 }
 448
 449 void ShowWindow::DrawPauseScene( bool bTimeoutOnly )
 450 {
 451     const MapMode&  rMap = GetMapMode();
 452     const Point     aOutOrg( PixelToLogic( Point() ) );
 453     const Size      aOutSize( GetOutputSize() );
 454     const Size      aTextSize(LogicToLogic(Size(0, 14), MapMode(MapUnit::MapPoint), rMap));
 455     const Size      aOffset(LogicToLogic(Size(1000, 1000), MapMode(MapUnit::Map100thMM), rMap));
 456     OUString        aText( SdResId( STR_PRES_PAUSE ) );
 457     bool            bDrawn = false;
 458
 459     vcl::Font       aFont( GetSettings().GetStyleSettings().GetMenuFont() );
 460     const vcl::Font aOldFont( GetFont() );
 461
 462     aFont.SetFontSize( aTextSize );
 463     aFont.SetColor( COL_WHITE );
 464     aFont.SetCharSet( aOldFont.GetCharSet() );
 465     aFont.SetLanguage( aOldFont.GetLanguage() );
 466
 467     if( !bTimeoutOnly && ( maLogo.GetType() != GraphicType::NONE ) )
 468     {
 469         Size aGrfSize;
 470
 471         if (maLogo.GetPrefMapMode().GetMapUnit() == MapUnit::MapPixel)
 472             aGrfSize = PixelToLogic( maLogo.GetPrefSize() );
 473         else
 474             aGrfSize = LogicToLogic( maLogo.GetPrefSize(), maLogo.GetPrefMapMode(), rMap );
 475
 476         const Point aGrfPos( std::max( aOutOrg.X() + aOutSize.Width() - aGrfSize.Width() - aOffset.Width(), aOutOrg.X() ),
 477                              std::max( aOutOrg.Y() + aOutSize.Height() - aGrfSize.Height() - aOffset.Height(), aOutOrg.Y() ) );
 478
 479         if( maLogo.IsAnimated() )
 480             maLogo.StartAnimation( this, aGrfPos, aGrfSize, reinterpret_cast<sal_IntPtr>(this) );
 481         else
 482             maLogo.Draw( this, aGrfPos, aGrfSize );
 483     }
 484
 485     if( SLIDE_NO_TIMEOUT != mnPauseTimeout )
 486     {
 487         MapMode         aVMap( rMap );
 488         ScopedVclPtrInstance< VirtualDevice > pVDev( *this );
 489
 490         aVMap.SetOrigin( Point() );
 491         pVDev->SetMapMode( aVMap );
 492         pVDev->SetBackground( Wallpaper( COL_BLACK ) );
 493
 494         // set font first, to determine real output height
 495         pVDev->SetFont( aFont );
 496
 497         const Size aVDevSize( aOutSize.Width(), pVDev->GetTextHeight() );
 498
 499         if( pVDev->SetOutputSize( aVDevSize ) )
 500         {
 501             // Note: if performance gets an issue here, we can use NumberFormatter directly
 502             SvtSysLocale                aSysLocale;
 503             const LocaleDataWrapper&    aLocaleData = aSysLocale.GetLocaleData();
 504
 505             aText += " ( ";
 506             aText += aLocaleData.getDuration( ::tools::Time( 0, 0, mnPauseTimeout ) );
 507             aText += " )";
 508             pVDev->DrawText( Point( aOffset.Width(), 0 ), aText );
 509             DrawOutDev( Point( aOutOrg.X(), aOffset.Height() ), aVDevSize, Point(), aVDevSize, *pVDev.get() );
 510             bDrawn = true;
 511         }
 512     }
 513
 514     if( !bDrawn )
 515     {
 516         SetFont( aFont );
 517         DrawText( Point( aOutOrg.X() + aOffset.Width(), aOutOrg.Y() + aOffset.Height() ), aText );
 518         SetFont( aOldFont );
 519     }
 520 }
 521
 522 void ShowWindow::DrawEndScene()
 523 {
 524     const vcl::Font aOldFont( GetFont() );
 525     vcl::Font       aFont( GetSettings().GetStyleSettings().GetMenuFont() );
 526
 527     const Point     aOutOrg( PixelToLogic( Point() ) );
 528     const Size      aTextSize(LogicToLogic(Size(0, 14), MapMode(MapUnit::MapPoint), GetMapMode()));
 529     const OUString  aText( SdResId( STR_PRES_SOFTEND ) );
 530
 531     aFont.SetFontSize( aTextSize );
 532     aFont.SetColor( COL_WHITE );
 533     aFont.SetCharSet( aOldFont.GetCharSet() );
 534     aFont.SetLanguage( aOldFont.GetLanguage() );
 535     SetFont( aFont );
 536     DrawText( Point( aOutOrg.X() + aTextSize.Height(), aOutOrg.Y() + aTextSize.Height() ), aText );
 537     SetFont( aOldFont );
 538 }
 539
 540 IMPL_LINK( ShowWindow, PauseTimeoutHdl, Timer*, pTimer, void )
 541 {
 542     if( !( --mnPauseTimeout ) )
 543         RestartShow();
 544     else
 545     {
 546         DrawPauseScene( true );
 547         pTimer->Start();
 548     }
 549 }
 550
 551 IMPL_LINK_NOARG(ShowWindow, MouseTimeoutHdl, Timer *, void)
 552 {
 553     if( mbMouseCursorHidden )
 554     {
 555         // not enough mouse movements since first recording so
 556         // cancel show mouse pointer for now
 557         mnFirstMouseMove = 0;
 558     }
 559     else
 560     {
 561         // mouse has been idle to long, hide pointer
 562         ShowPointer( false );
 563         mbMouseCursorHidden = true;
 564     }
 565 }
 566
 567 IMPL_LINK( ShowWindow, EventHdl, VclWindowEvent&, rEvent, void )
 568 {
 569     if( mbMouseAutoHide )
 570     {
 571         if (rEvent.GetId() == VclEventId::WindowShow)
 572         {
 573             maMouseTimer.SetTimeout( HIDE_MOUSE_TIMEOUT );
 574             maMouseTimer.Start();
 575         }
 576     }
 577 }
 578
 579 void ShowWindow::SetPresentationArea( const ::tools::Rectangle& rPresArea )
 580 {
 581     maPresArea = rPresArea;
 582 }
 583
 584 void ShowWindow::DeleteWindowFromPaintView()
 585 {
 586     if( mpViewShell->GetView() )
 587         mpViewShell->GetView()->DeleteWindowFromPaintView( this );
 588
 589     sal_uInt16 nChild = GetChildCount();
 590     while( nChild-- )
 591         GetChild( nChild )->Show( false );
 592 }
 593
 594 void ShowWindow::AddWindowToPaintView()
 595 {
 596     if( mpViewShell->GetView() )
 597         mpViewShell->GetView()->AddWindowToPaintView( this, nullptr );
 598
 599     sal_uInt16 nChild = GetChildCount();
 600     while( nChild-- )
 601         GetChild( nChild )->Show();
 602 }
 603
 604 // Override the sd::Window's CreateAccessible to create a different accessible object
 605 css::uno::Reference<css::accessibility::XAccessible>
 606     ShowWindow::CreateAccessible()
 607 {
 608     css::uno::Reference< css::accessibility::XAccessible > xAcc = GetAccessible(false);
 609     if (xAcc.get())
 610     {
 611         return xAcc;
 612     }
 613     if (mpViewShell != nullptr)
 614     {
 615         xAcc = mpViewShell->CreateAccessibleDocumentView (this);
 616         SetAccessible(xAcc);
 617         return xAcc;
 618     }
 619     else
 620     {
 621         SAL_WARN("sd", "::sd::Window::CreateAccessible: no view shell");
 622         return vcl::Window::CreateAccessible ();
 623     }
 624 }
 625 } // end of namespace sd
 626
 627 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */