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