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