vcl/source/app/help.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 <comphelper/string.hxx>
  21 #include <sal/log.hxx>
  22
  23 #include <tools/diagnose_ex.h>
  24 #include <tools/time.hxx>
  25
  26 #include <vcl/window.hxx>
  27 #include <vcl/event.hxx>
  28 #include <vcl/svapp.hxx>
  29 #include <vcl/wrkwin.hxx>
  30 #include <vcl/help.hxx>
  31 #include <vcl/settings.hxx>
  32
  33 #include <helpwin.hxx>
  34 #include <salframe.hxx>
  35 #include <svdata.hxx>
  36
  37 #define HELPWINSTYLE_QUICK      0
  38 #define HELPWINSTYLE_BALLOON    1
  39
  40 #define HELPTEXTMARGIN_QUICK    3
  41 #define HELPTEXTMARGIN_BALLOON  6
  42
  43 #define HELPTEXTMAXLEN        150
  44
  45 Help::Help()
  46 {
  47 }
  48
  49 Help::~Help()
  50 {
  51 }
  52
  53 bool Help::Start( const OUString&, const vcl::Window* )
  54 {
  55     return false;
  56 }
  57
  58 bool Help::Start(const OUString&, weld::Widget*)
  59 {
  60     return false;
  61 }
  62
  63 void Help::SearchKeyword( const OUString& )
  64 {
  65 }
  66
  67 OUString Help::GetHelpText( const OUString&, const vcl::Window* )
  68 {
  69     return OUString();
  70 }
  71
  72 OUString Help::GetHelpText( const OUString&, const weld::Widget* )
  73 {
  74     return OUString();
  75 }
  76
  77 void Help::EnableContextHelp()
  78 {
  79     ImplGetSVData()->maHelpData.mbContextHelp = true;
  80 }
  81
  82 void Help::DisableContextHelp()
  83 {
  84     ImplGetSVData()->maHelpData.mbContextHelp = false;
  85 }
  86
  87 bool Help::IsContextHelpEnabled()
  88 {
  89     return ImplGetSVData()->maHelpData.mbContextHelp;
  90 }
  91
  92 void Help::EnableExtHelp()
  93 {
  94     ImplGetSVData()->maHelpData.mbExtHelp = true;
  95 }
  96
  97 void Help::DisableExtHelp()
  98 {
  99     ImplGetSVData()->maHelpData.mbExtHelp = false;
 100 }
 101
 102 bool Help::IsExtHelpEnabled()
 103 {
 104     return ImplGetSVData()->maHelpData.mbExtHelp;
 105 }
 106
 107 bool Help::StartExtHelp()
 108 {
 109     ImplSVData* pSVData = ImplGetSVData();
 110
 111     if ( pSVData->maHelpData.mbExtHelp && !pSVData->maHelpData.mbExtHelpMode )
 112     {
 113         pSVData->maHelpData.mbExtHelpMode = true;
 114         pSVData->maHelpData.mbOldBalloonMode = pSVData->maHelpData.mbBalloonHelp;
 115         pSVData->maHelpData.mbBalloonHelp = true;
 116         if ( pSVData->maWinData.mpAppWin )
 117             pSVData->maWinData.mpAppWin->ImplGenerateMouseMove();
 118         return true;
 119     }
 120
 121     return false;
 122 }
 123
 124 bool Help::EndExtHelp()
 125 {
 126     ImplSVData* pSVData = ImplGetSVData();
 127
 128     if ( pSVData->maHelpData.mbExtHelp && pSVData->maHelpData.mbExtHelpMode )
 129     {
 130         pSVData->maHelpData.mbExtHelpMode = false;
 131         pSVData->maHelpData.mbBalloonHelp = pSVData->maHelpData.mbOldBalloonMode;
 132         if ( pSVData->maWinData.mpAppWin )
 133             pSVData->maWinData.mpAppWin->ImplGenerateMouseMove();
 134         return true;
 135     }
 136
 137     return false;
 138 }
 139
 140 void Help::EnableBalloonHelp()
 141 {
 142     ImplGetSVData()->maHelpData.mbBalloonHelp = true;
 143 }
 144
 145 void Help::DisableBalloonHelp()
 146 {
 147     ImplGetSVData()->maHelpData.mbBalloonHelp = false;
 148 }
 149
 150 bool Help::IsBalloonHelpEnabled()
 151 {
 152     return ImplGetSVData()->maHelpData.mbBalloonHelp;
 153 }
 154
 155 void Help::ShowBalloon( vcl::Window* pParent,
 156                         const Point& rScreenPos, const tools::Rectangle& rRect,
 157                         const OUString& rHelpText )
 158 {
 159     ImplShowHelpWindow( pParent, HELPWINSTYLE_BALLOON, QuickHelpFlags::NONE,
 160                         rHelpText, rScreenPos, rRect );
 161 }
 162
 163 void Help::EnableQuickHelp()
 164 {
 165     ImplGetSVData()->maHelpData.mbQuickHelp = true;
 166 }
 167
 168 void Help::DisableQuickHelp()
 169 {
 170     ImplGetSVData()->maHelpData.mbQuickHelp = false;
 171 }
 172
 173 bool Help::IsQuickHelpEnabled()
 174 {
 175     return ImplGetSVData()->maHelpData.mbQuickHelp;
 176 }
 177
 178 void Help::ShowQuickHelp( vcl::Window* pParent,
 179                           const tools::Rectangle& rScreenRect,
 180                           const OUString& rHelpText,
 181                           QuickHelpFlags nStyle )
 182 {
 183     sal_uInt16 nHelpWinStyle = ( nStyle & QuickHelpFlags::TipStyleBalloon ) ? HELPWINSTYLE_BALLOON : HELPWINSTYLE_QUICK;
 184     ImplShowHelpWindow( pParent, nHelpWinStyle, nStyle,
 185                         rHelpText,
 186                         pParent->OutputToScreenPixel( pParent->GetPointerPosPixel() ), rScreenRect );
 187 }
 188
 189 void Help::HideBalloonAndQuickHelp()
 190 {
 191     HelpTextWindow const * pHelpWin = ImplGetSVData()->maHelpData.mpHelpWin;
 192     bool const bIsVisible = ( pHelpWin != nullptr ) && pHelpWin->IsVisible();
 193     ImplDestroyHelpWindow( bIsVisible );
 194 }
 195
 196 void* Help::ShowPopover(vcl::Window* pParent, const tools::Rectangle& rScreenRect,
 197                               const OUString& rText, QuickHelpFlags nStyle)
 198 {
 199     void* nId = pParent->ImplGetFrame()->ShowPopover(rText, pParent, rScreenRect, nStyle);
 200     if (nId)
 201     {
 202         //popovers are handled natively, return early
 203         return nId;
 204     }
 205
 206     sal_uInt16 nHelpWinStyle = ( nStyle & QuickHelpFlags::TipStyleBalloon ) ? HELPWINSTYLE_BALLOON : HELPWINSTYLE_QUICK;
 207     VclPtrInstance<HelpTextWindow> pHelpWin( pParent, rText, nHelpWinStyle, nStyle );
 208
 209     nId = pHelpWin.get();
 210     UpdatePopover(nId, pParent, rScreenRect, rText);
 211
 212     pHelpWin->ShowHelp(true);
 213     return nId;
 214 }
 215
 216 void Help::UpdatePopover(void* nId, vcl::Window* pParent, const tools::Rectangle& rScreenRect,
 217                          const OUString& rText)
 218 {
 219     if (pParent->ImplGetFrame()->UpdatePopover(nId, rText, pParent, rScreenRect))
 220     {
 221         //popovers are handled natively, return early
 222         return;
 223     }
 224
 225     HelpTextWindow* pHelpWin = static_cast< HelpTextWindow* >( nId );
 226     ENSURE_OR_RETURN_VOID( pHelpWin != nullptr, "Help::UpdatePopover: invalid ID!" );
 227
 228     Size aSz = pHelpWin->CalcOutSize();
 229     pHelpWin->SetOutputSizePixel( aSz );
 230     ImplSetHelpWindowPos( pHelpWin, pHelpWin->GetWinStyle(), pHelpWin->GetStyle(),
 231         pParent->OutputToScreenPixel( pParent->GetPointerPosPixel() ), rScreenRect );
 232
 233     pHelpWin->SetHelpText( rText );
 234     pHelpWin->Invalidate();
 235 }
 236
 237 void Help::HidePopover(vcl::Window const * pParent, void* nId)
 238 {
 239     if (pParent->ImplGetFrame()->HidePopover(nId))
 240     {
 241         //popovers are handled natively, return early
 242         return;
 243     }
 244
 245     VclPtr<HelpTextWindow> pHelpWin = static_cast<HelpTextWindow*>(nId);
 246     vcl::Window* pFrameWindow = pHelpWin->ImplGetFrameWindow();
 247     pHelpWin->Hide();
 248     // trigger update, so that a Paint is instantly triggered since we do not save the background
 249     pFrameWindow->ImplUpdateAll();
 250     pHelpWin.disposeAndClear();
 251     ImplGetSVData()->maHelpData.mnLastHelpHideTime = tools::Time::GetSystemTicks();
 252 }
 253
 254 HelpTextWindow::HelpTextWindow( vcl::Window* pParent, const OUString& rText, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle ) :
 255     FloatingWindow( pParent, WB_SYSTEMWINDOW|WB_TOOLTIPWIN ), // #105827# if we change the parent, mirroring will not work correctly when positioning this window
 256     maHelpText( rText )
 257 {
 258     SetType( WindowType::HELPTEXTWINDOW );
 259     ImplSetMouseTransparent( true );
 260     mnHelpWinStyle = nHelpWinStyle;
 261     mnStyle = nStyle;
 262
 263     if( mnStyle & QuickHelpFlags::BiDiRtl )
 264     {
 265         ComplexTextLayoutFlags nLayoutMode = GetLayoutMode();
 266         nLayoutMode |= ComplexTextLayoutFlags::BiDiRtl | ComplexTextLayoutFlags::TextOriginLeft;
 267         SetLayoutMode( nLayoutMode );
 268     }
 269     SetHelpText( rText );
 270     Window::SetHelpText( rText );
 271
 272     ImplSVData* pSVData = ImplGetSVData();
 273     if ( pSVData->maHelpData.mbSetKeyboardHelp )
 274         pSVData->maHelpData.mbKeyboardHelp = true;
 275
 276
 277     maShowTimer.SetInvokeHandler( LINK( this, HelpTextWindow, TimerHdl ) );
 278     maShowTimer.SetDebugName( "vcl::HelpTextWindow maShowTimer" );
 279
 280     const HelpSettings& rHelpSettings = pParent->GetSettings().GetHelpSettings();
 281     maHideTimer.SetTimeout( rHelpSettings.GetTipTimeout() );
 282     maHideTimer.SetInvokeHandler( LINK( this, HelpTextWindow, TimerHdl ) );
 283     maHideTimer.SetDebugName( "vcl::HelpTextWindow maHideTimer" );
 284 }
 285
 286 void HelpTextWindow::ApplySettings(vcl::RenderContext& rRenderContext)
 287 {
 288     const StyleSettings& rStyleSettings = rRenderContext.GetSettings().GetStyleSettings();
 289     SetPointFont(rRenderContext, rStyleSettings.GetHelpFont());
 290     rRenderContext.SetTextColor(rStyleSettings.GetHelpTextColor());
 291     rRenderContext.SetTextAlign(ALIGN_TOP);
 292
 293     if (rRenderContext.IsNativeControlSupported(ControlType::Tooltip, ControlPart::Entire))
 294     {
 295         EnableChildTransparentMode();
 296         SetParentClipMode(ParentClipMode::NoClip);
 297         SetPaintTransparent(true);
 298         rRenderContext.SetBackground();
 299     }
 300     else
 301         rRenderContext.SetBackground(Wallpaper(rStyleSettings.GetHelpColor()));
 302
 303     if (rStyleSettings.GetHelpColor().IsDark())
 304         rRenderContext.SetLineColor(COL_WHITE);
 305     else
 306         rRenderContext.SetLineColor(COL_BLACK);
 307     rRenderContext.SetFillColor();
 308 }
 309
 310 HelpTextWindow::~HelpTextWindow()
 311 {
 312     disposeOnce();
 313 }
 314
 315 void HelpTextWindow::dispose()
 316 {
 317     maShowTimer.Stop();
 318     maHideTimer.Stop();
 319
 320     if( this == ImplGetSVData()->maHelpData.mpHelpWin )
 321         ImplGetSVData()->maHelpData.mpHelpWin = nullptr;
 322     FloatingWindow::dispose();
 323 }
 324
 325 void HelpTextWindow::SetHelpText( const OUString& rHelpText )
 326 {
 327     maHelpText = rHelpText;
 328     ApplySettings(*this);
 329     if ( mnHelpWinStyle == HELPWINSTYLE_QUICK && maHelpText.getLength() < HELPTEXTMAXLEN && maHelpText.indexOf('\n') < 0)
 330     {
 331         Size aSize;
 332         aSize.setHeight( GetTextHeight() );
 333         if ( mnStyle & QuickHelpFlags::CtrlText )
 334             aSize.setWidth( GetCtrlTextWidth( maHelpText ) );
 335         else
 336             aSize.setWidth( GetTextWidth( maHelpText ) );
 337         maTextRect = tools::Rectangle( Point( HELPTEXTMARGIN_QUICK, HELPTEXTMARGIN_QUICK ), aSize );
 338     }
 339     else // HELPWINSTYLE_BALLOON
 340     {
 341         sal_Int32 nCharsInLine = 35 + ((maHelpText.getLength()/100)*5);
 342         // average width to have all windows consistent
 343         OUStringBuffer aBuf;
 344         comphelper::string::padToLength(aBuf, nCharsInLine, 'x');
 345         OUString aXXX = aBuf.makeStringAndClear();
 346         long nWidth = GetTextWidth( aXXX );
 347         Size aTmpSize( nWidth, 0x7FFFFFFF );
 348         tools::Rectangle aTry1( Point(), aTmpSize );
 349         DrawTextFlags nDrawFlags = DrawTextFlags::MultiLine | DrawTextFlags::WordBreak |
 350                             DrawTextFlags::Left | DrawTextFlags::Top;
 351         if ( mnStyle & QuickHelpFlags::CtrlText )
 352             nDrawFlags |= DrawTextFlags::Mnemonic;
 353         tools::Rectangle aTextRect = GetTextRect( aTry1, maHelpText, nDrawFlags );
 354
 355         // get a better width later...
 356         maTextRect = aTextRect;
 357
 358         // safety distance...
 359         maTextRect.SetPos( Point( HELPTEXTMARGIN_BALLOON, HELPTEXTMARGIN_BALLOON ) );
 360     }
 361
 362     Size aSize( CalcOutSize() );
 363     SetOutputSizePixel( aSize );
 364 }
 365
 366 void HelpTextWindow::ImplShow()
 367 {
 368     VclPtr<HelpTextWindow> xWindow( this );
 369     Show( true, ShowFlags::NoActivate );
 370     if( !xWindow->IsDisposed() )
 371         Update();
 372 }
 373
 374 void HelpTextWindow::Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& )
 375 {
 376     // paint native background
 377     bool bNativeOK = false;
 378     if (rRenderContext.IsNativeControlSupported(ControlType::Tooltip, ControlPart::Entire))
 379     {
 380         tools::Rectangle aCtrlRegion(Point(0, 0), GetOutputSizePixel());
 381         ImplControlValue aControlValue;
 382         bNativeOK = rRenderContext.DrawNativeControl(ControlType::Tooltip, ControlPart::Entire, aCtrlRegion,
 383                                                      ControlState::NONE, aControlValue, OUString());
 384     }
 385
 386     // paint text
 387     if (mnHelpWinStyle == HELPWINSTYLE_QUICK && maHelpText.getLength() < HELPTEXTMAXLEN && maHelpText.indexOf('\n') < 0)
 388     {
 389         if ( mnStyle & QuickHelpFlags::CtrlText )
 390             rRenderContext.DrawCtrlText(maTextRect.TopLeft(), maHelpText);
 391         else
 392             rRenderContext.DrawText(maTextRect.TopLeft(), maHelpText);
 393     }
 394     else // HELPWINSTYLE_BALLOON
 395     {
 396         DrawTextFlags nDrawFlags = DrawTextFlags::MultiLine|DrawTextFlags::WordBreak|
 397                                 DrawTextFlags::Left|DrawTextFlags::Top;
 398         if (mnStyle & QuickHelpFlags::CtrlText)
 399             nDrawFlags |= DrawTextFlags::Mnemonic;
 400         rRenderContext.DrawText(maTextRect, maHelpText, nDrawFlags);
 401     }
 402
 403     // border
 404     if (!bNativeOK)
 405     {
 406         Size aSz = GetOutputSizePixel();
 407         rRenderContext.DrawRect(tools::Rectangle(Point(), aSz));
 408         if (mnHelpWinStyle == HELPWINSTYLE_BALLOON)
 409         {
 410             aSz.AdjustWidth( -2 );
 411             aSz.AdjustHeight( -2 );
 412             Color aColor(rRenderContext.GetLineColor());
 413             rRenderContext.SetLineColor(COL_GRAY);
 414             rRenderContext.DrawRect(tools::Rectangle(Point(1, 1), aSz));
 415             rRenderContext.SetLineColor(aColor);
 416         }
 417     }
 418 }
 419
 420 void HelpTextWindow::ShowHelp(bool bNoDelay)
 421 {
 422     sal_uLong nTimeout = 0;
 423     if (!bNoDelay)
 424     {
 425         // In case of ExtendedHelp display help sooner
 426         if ( ImplGetSVData()->maHelpData.mbExtHelpMode )
 427             nTimeout = 15;
 428         else
 429         {
 430             if ( mnHelpWinStyle == HELPWINSTYLE_QUICK )
 431                 nTimeout = HelpSettings::GetTipDelay();
 432             else
 433                 nTimeout = HelpSettings::GetBalloonDelay();
 434         }
 435     }
 436
 437     maShowTimer.SetTimeout( nTimeout );
 438     maShowTimer.Start();
 439 }
 440
 441 IMPL_LINK( HelpTextWindow, TimerHdl, Timer*, pTimer, void)
 442 {
 443     if ( pTimer == &maShowTimer )
 444     {
 445         if ( mnHelpWinStyle == HELPWINSTYLE_QUICK )
 446         {
 447             // start auto-hide-timer for non-ShowTip windows
 448             ImplSVData* pSVData = ImplGetSVData();
 449             if ( this == pSVData->maHelpData.mpHelpWin )
 450                 maHideTimer.Start();
 451         }
 452         ImplShow();
 453     }
 454     else
 455     {
 456         SAL_WARN_IF( pTimer != &maHideTimer, "vcl", "HelpTextWindow::TimerHdl with bad Timer" );
 457         ImplDestroyHelpWindow( true );
 458     }
 459 }
 460
 461 Size HelpTextWindow::CalcOutSize() const
 462 {
 463     Size aSz = maTextRect.GetSize();
 464     aSz.AdjustWidth(2*maTextRect.Left() );
 465     aSz.AdjustHeight(2*maTextRect.Top() );
 466     return aSz;
 467 }
 468
 469 void HelpTextWindow::RequestHelp( const HelpEvent& /*rHEvt*/ )
 470 {
 471     // Just to assure that Window::RequestHelp() is not called by
 472     // ShowQuickHelp/ShowBalloonHelp in the HelpTextWindow.
 473 }
 474
 475 OUString HelpTextWindow::GetText() const
 476 {
 477     return maHelpText;
 478 }
 479
 480 void ImplShowHelpWindow( vcl::Window* pParent, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
 481                          const OUString& rHelpText,
 482                          const Point& rScreenPos, const tools::Rectangle& rHelpArea )
 483 {
 484     if (pParent->ImplGetFrame()->ShowTooltip(rHelpText, rHelpArea))
 485     {
 486         //tooltips are handled natively, return early
 487         return;
 488     }
 489
 490     ImplSVData* pSVData = ImplGetSVData();
 491
 492     if (rHelpText.isEmpty() && !pSVData->maHelpData.mbRequestingHelp)
 493         return;
 494
 495     VclPtr<HelpTextWindow> pHelpWin = pSVData->maHelpData.mpHelpWin;
 496     bool bNoDelay = false;
 497     if ( pHelpWin )
 498     {
 499         SAL_WARN_IF( pHelpWin == pParent, "vcl", "HelpInHelp ?!" );
 500
 501         if  (   (   rHelpText.isEmpty()
 502                 ||  ( pHelpWin->GetWinStyle() != nHelpWinStyle )
 503                 )
 504             &&  pSVData->maHelpData.mbRequestingHelp
 505             )
 506         {
 507             // remove help window if no HelpText or
 508             // other help mode. but keep it if we are scrolling, ie not requesting help
 509             bool bWasVisible = pHelpWin->IsVisible();
 510             if ( bWasVisible )
 511                 bNoDelay = true; // display it quickly if we were already in quick help mode
 512             pHelpWin = nullptr;
 513             ImplDestroyHelpWindow( bWasVisible );
 514         }
 515         else
 516         {
 517             bool const bUpdate = (pHelpWin->GetHelpText() != rHelpText) ||
 518                 ((pHelpWin->GetHelpArea() != rHelpArea) && pSVData->maHelpData.mbRequestingHelp);
 519             if (bUpdate)
 520             {
 521                 vcl::Window * pWindow = pHelpWin->GetParent()->ImplGetFrameWindow();
 522                 tools::Rectangle aInvRect( pHelpWin->GetWindowExtentsRelative( pWindow ) );
 523                 if( pHelpWin->IsVisible() )
 524                     pWindow->Invalidate( aInvRect );
 525
 526                 pHelpWin->SetHelpText( rHelpText );
 527                 // approach mouse position
 528                 ImplSetHelpWindowPos( pHelpWin, nHelpWinStyle, nStyle, rScreenPos, rHelpArea );
 529                 if( pHelpWin->IsVisible() )
 530                     pHelpWin->Invalidate();
 531             }
 532         }
 533     }
 534
 535     if (pHelpWin || rHelpText.isEmpty())
 536         return;
 537
 538     sal_uInt64 nCurTime = tools::Time::GetSystemTicks();
 539     if ( ( nCurTime - pSVData->maHelpData.mnLastHelpHideTime ) < HelpSettings::GetTipDelay() )
 540         bNoDelay = true;
 541
 542     pHelpWin = VclPtr<HelpTextWindow>::Create( pParent, rHelpText, nHelpWinStyle, nStyle );
 543     pSVData->maHelpData.mpHelpWin = pHelpWin;
 544     pHelpWin->SetHelpArea( rHelpArea );
 545
 546     //  positioning
 547     Size aSz = pHelpWin->CalcOutSize();
 548     pHelpWin->SetOutputSizePixel( aSz );
 549     ImplSetHelpWindowPos( pHelpWin, nHelpWinStyle, nStyle, rScreenPos, rHelpArea );
 550     // if not called from Window::RequestHelp, then without delay...
 551     if ( !pSVData->maHelpData.mbRequestingHelp )
 552         bNoDelay = true;
 553     pHelpWin->ShowHelp(bNoDelay);
 554
 555 }
 556
 557 void ImplDestroyHelpWindow( bool bUpdateHideTime )
 558 {
 559     ImplSVData* pSVData = ImplGetSVData();
 560     VclPtr<HelpTextWindow> pHelpWin = pSVData->maHelpData.mpHelpWin;
 561     if ( pHelpWin )
 562     {
 563         vcl::Window * pWindow = pHelpWin->GetParent()->ImplGetFrameWindow();
 564         // find out screen area covered by system help window
 565         tools::Rectangle aInvRect( pHelpWin->GetWindowExtentsRelative( pWindow ) );
 566         if( pHelpWin->IsVisible() )
 567             pWindow->Invalidate( aInvRect );
 568         pSVData->maHelpData.mpHelpWin = nullptr;
 569         pSVData->maHelpData.mbKeyboardHelp = false;
 570         pHelpWin->Hide();
 571         pHelpWin.disposeAndClear();
 572         if( bUpdateHideTime )
 573             pSVData->maHelpData.mnLastHelpHideTime = tools::Time::GetSystemTicks();
 574     }
 575 }
 576
 577 void ImplSetHelpWindowPos( vcl::Window* pHelpWin, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
 578                            const Point& rPos, const tools::Rectangle& rHelpArea )
 579 {
 580     Point       aPos = rPos;
 581     Size        aSz = pHelpWin->GetSizePixel();
 582     tools::Rectangle   aScreenRect = pHelpWin->ImplGetFrameWindow()->GetDesktopRectPixel();
 583     aPos = pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( aPos );
 584     // get mouse screen coords
 585     Point aMousePos( pHelpWin->GetParent()->ImplGetFrameWindow()->GetPointerPosPixel() );
 586     aMousePos = pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( aMousePos );
 587
 588     if ( nHelpWinStyle == HELPWINSTYLE_QUICK )
 589     {
 590         if ( !(nStyle & QuickHelpFlags::NoAutoPos) )
 591         {
 592             long nScreenHeight = aScreenRect.GetHeight();
 593             aPos.AdjustX( -4 );
 594             if ( aPos.Y() > aScreenRect.Top()+nScreenHeight-(nScreenHeight/4) )
 595                 aPos.AdjustY( -(aSz.Height()+4) );
 596             else
 597                 aPos.AdjustY(21 );
 598         }
 599     }
 600     else
 601     {
 602         // If it's the mouse position, move the window slightly
 603         // so the mouse pointer does not cover it
 604         if ( aPos == aMousePos )
 605         {
 606             aPos.AdjustX(12 );
 607             aPos.AdjustY(16 );
 608         }
 609     }
 610
 611     if ( nStyle & QuickHelpFlags::NoAutoPos )
 612     {
 613         // convert help area to screen coords
 614         tools::Rectangle devHelpArea(
 615             pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( rHelpArea.TopLeft() ),
 616             pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( rHelpArea.BottomRight() ) );
 617
 618         // which position of the rectangle?
 619         aPos = devHelpArea.Center();
 620
 621         if ( nStyle & QuickHelpFlags::Left )
 622             aPos.setX( devHelpArea.Left() );
 623         else if ( nStyle & QuickHelpFlags::Right )
 624             aPos.setX( devHelpArea.Right() );
 625
 626         if ( nStyle & QuickHelpFlags::Top )
 627             aPos.setY( devHelpArea.Top() );
 628         else if ( nStyle & QuickHelpFlags::Bottom )
 629             aPos.setY( devHelpArea.Bottom() );
 630
 631         // which direction?
 632         if ( nStyle & QuickHelpFlags::Left )
 633             ;
 634         else if ( nStyle & QuickHelpFlags::Right )
 635             aPos.AdjustX( -(aSz.Width()) );
 636         else
 637             aPos.AdjustX( -(aSz.Width()/2) );
 638
 639         if ( nStyle & QuickHelpFlags::Top )
 640             ;
 641         else if ( nStyle & QuickHelpFlags::Bottom )
 642             aPos.AdjustY( -(aSz.Height()) );
 643         else
 644             aPos.AdjustY( -(aSz.Height()/2) );
 645     }
 646
 647     if ( aPos.X() < aScreenRect.Left() )
 648         aPos.setX( aScreenRect.Left() );
 649     else if ( ( aPos.X() + aSz.Width() ) > aScreenRect.Right() )
 650         aPos.setX( aScreenRect.Right() - aSz.Width() );
 651     if ( aPos.Y() < aScreenRect.Top() )
 652         aPos.setY( aScreenRect.Top() );
 653     else if ( ( aPos.Y() + aSz.Height() ) > aScreenRect.Bottom() )
 654         aPos.setY( aScreenRect.Bottom() - aSz.Height() );
 655
 656     if( ! (nStyle & QuickHelpFlags::NoEvadePointer) )
 657     {
 658         /* the remark below should be obsolete by now as the helpwindow should
 659         not be focusable, leaving it as a hint. However it is sensible in most
 660         conditions to evade the mouse pointer so the content window is fully visible.
 661
 662         // the popup must not appear under the mouse
 663         // otherwise it would directly be closed due to a focus change...
 664         */
 665         tools::Rectangle aHelpRect( aPos, aSz );
 666         if( aHelpRect.IsInside( aMousePos ) )
 667         {
 668             Point delta(2,2);
 669             Point aSize( aSz.Width(), aSz.Height() );
 670             Point aTest( aMousePos - aSize - delta );
 671             if( aTest.X() > aScreenRect.Left() && aTest.Y() > aScreenRect.Top() )
 672                 aPos = aTest;
 673             else
 674                 aPos = aMousePos + delta;
 675         }
 676     }
 677
 678     vcl::Window* pWindow = pHelpWin->GetParent()->ImplGetFrameWindow();
 679     aPos = pWindow->AbsoluteScreenToOutputPixel( aPos );
 680     pHelpWin->SetPosPixel( aPos );
 681 }
 682
 683 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */