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 <comphelper/diagnose_ex.hxx>
  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     ImplGetSVHelpData().mbContextHelp = true;
  80 }
  81
  82 void Help::DisableContextHelp()
  83 {
  84     ImplGetSVHelpData().mbContextHelp = false;
  85 }
  86
  87 bool Help::IsContextHelpEnabled()
  88 {
  89     return ImplGetSVHelpData().mbContextHelp;
  90 }
  91
  92 void Help::EnableExtHelp()
  93 {
  94     ImplGetSVHelpData().mbExtHelp = true;
  95 }
  96
  97 void Help::DisableExtHelp()
  98 {
  99     ImplGetSVHelpData().mbExtHelp = false;
 100 }
 101
 102 bool Help::IsExtHelpEnabled()
 103 {
 104     return ImplGetSVHelpData().mbExtHelp;
 105 }
 106
 107 bool Help::StartExtHelp()
 108 {
 109     ImplSVData* pSVData = ImplGetSVData();
 110     ImplSVHelpData& aHelpData = ImplGetSVHelpData();
 111
 112     if ( aHelpData.mbExtHelp && !aHelpData.mbExtHelpMode )
 113     {
 114         aHelpData.mbExtHelpMode = true;
 115         aHelpData.mbOldBalloonMode = aHelpData.mbBalloonHelp;
 116         aHelpData.mbBalloonHelp = true;
 117         if (pSVData->maFrameData.mpAppWin)
 118             pSVData->maFrameData.mpAppWin->ImplGenerateMouseMove();
 119         return true;
 120     }
 121
 122     return false;
 123 }
 124
 125 bool Help::EndExtHelp()
 126 {
 127     ImplSVData* pSVData = ImplGetSVData();
 128     ImplSVHelpData& aHelpData = ImplGetSVHelpData();
 129
 130     if ( aHelpData.mbExtHelp && aHelpData.mbExtHelpMode )
 131     {
 132         aHelpData.mbExtHelpMode = false;
 133         aHelpData.mbBalloonHelp = aHelpData.mbOldBalloonMode;
 134         if (pSVData->maFrameData.mpAppWin)
 135             pSVData->maFrameData.mpAppWin->ImplGenerateMouseMove();
 136         return true;
 137     }
 138
 139     return false;
 140 }
 141
 142 void Help::EnableBalloonHelp()
 143 {
 144     ImplGetSVHelpData().mbBalloonHelp = true;
 145 }
 146
 147 void Help::DisableBalloonHelp()
 148 {
 149     ImplGetSVHelpData().mbBalloonHelp = false;
 150 }
 151
 152 bool Help::IsBalloonHelpEnabled()
 153 {
 154     return ImplGetSVHelpData().mbBalloonHelp;
 155 }
 156
 157 void Help::ShowBalloon( vcl::Window* pParent,
 158                         const Point& rScreenPos, const tools::Rectangle& rRect,
 159                         const OUString& rHelpText )
 160 {
 161     ImplShowHelpWindow( pParent, HELPWINSTYLE_BALLOON, QuickHelpFlags::NONE,
 162                         rHelpText, rScreenPos, rRect );
 163 }
 164
 165 void Help::EnableQuickHelp()
 166 {
 167     ImplGetSVHelpData().mbQuickHelp = true;
 168 }
 169
 170 void Help::DisableQuickHelp()
 171 {
 172     ImplGetSVHelpData().mbQuickHelp = false;
 173 }
 174
 175 bool Help::IsQuickHelpEnabled()
 176 {
 177     return ImplGetSVHelpData().mbQuickHelp;
 178 }
 179
 180 void Help::ShowQuickHelp( vcl::Window* pParent,
 181                           const tools::Rectangle& rScreenRect,
 182                           const OUString& rHelpText,
 183                           QuickHelpFlags nStyle )
 184 {
 185     sal_uInt16 nHelpWinStyle = ( nStyle & QuickHelpFlags::TipStyleBalloon ) ? HELPWINSTYLE_BALLOON : HELPWINSTYLE_QUICK;
 186     ImplShowHelpWindow( pParent, nHelpWinStyle, nStyle,
 187                         rHelpText,
 188                         pParent->OutputToScreenPixel( pParent->GetPointerPosPixel() ), rScreenRect );
 189 }
 190
 191 void Help::HideBalloonAndQuickHelp()
 192 {
 193     HelpTextWindow const * pHelpWin = ImplGetSVHelpData().mpHelpWin;
 194     bool const bIsVisible = ( pHelpWin != nullptr ) && pHelpWin->IsVisible();
 195     ImplDestroyHelpWindow( bIsVisible );
 196 }
 197
 198 void* Help::ShowPopover(vcl::Window* pParent, const tools::Rectangle& rScreenRect,
 199                               const OUString& rText, QuickHelpFlags nStyle)
 200 {
 201     void* nId = pParent->ImplGetFrame()->ShowPopover(rText, pParent, rScreenRect, nStyle);
 202     if (nId)
 203     {
 204         //popovers are handled natively, return early
 205         return nId;
 206     }
 207
 208     sal_uInt16 nHelpWinStyle = ( nStyle & QuickHelpFlags::TipStyleBalloon ) ? HELPWINSTYLE_BALLOON : HELPWINSTYLE_QUICK;
 209     VclPtrInstance<HelpTextWindow> pHelpWin( pParent, rText, nHelpWinStyle, nStyle );
 210
 211     nId = pHelpWin.get();
 212     UpdatePopover(nId, pParent, rScreenRect, rText);
 213
 214     pHelpWin->ShowHelp(true);
 215     return nId;
 216 }
 217
 218 void Help::UpdatePopover(void* nId, vcl::Window* pParent, const tools::Rectangle& rScreenRect,
 219                          const OUString& rText)
 220 {
 221     if (pParent->ImplGetFrame()->UpdatePopover(nId, rText, pParent, rScreenRect))
 222     {
 223         //popovers are handled natively, return early
 224         return;
 225     }
 226
 227     HelpTextWindow* pHelpWin = static_cast< HelpTextWindow* >( nId );
 228     ENSURE_OR_RETURN_VOID( pHelpWin != nullptr, "Help::UpdatePopover: invalid ID!" );
 229
 230     Size aSz = pHelpWin->CalcOutSize();
 231     pHelpWin->SetOutputSizePixel( aSz );
 232     ImplSetHelpWindowPos( pHelpWin, pHelpWin->GetWinStyle(), pHelpWin->GetStyle(),
 233         pParent->OutputToScreenPixel( pParent->GetPointerPosPixel() ), rScreenRect );
 234
 235     pHelpWin->SetHelpText( rText );
 236     pHelpWin->Invalidate();
 237 }
 238
 239 void Help::HidePopover(vcl::Window const * pParent, void* nId)
 240 {
 241     if (pParent->ImplGetFrame()->HidePopover(nId))
 242     {
 243         //popovers are handled natively, return early
 244         return;
 245     }
 246
 247     VclPtr<HelpTextWindow> pHelpWin = static_cast<HelpTextWindow*>(nId);
 248     vcl::Window* pFrameWindow = pHelpWin->ImplGetFrameWindow();
 249     pHelpWin->Hide();
 250     // trigger update, so that a Paint is instantly triggered since we do not save the background
 251     pFrameWindow->ImplUpdateAll();
 252     pHelpWin.disposeAndClear();
 253     ImplGetSVHelpData().mnLastHelpHideTime = tools::Time::GetSystemTicks();
 254 }
 255
 256 HelpTextWindow::HelpTextWindow( vcl::Window* pParent, const OUString& rText, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle ) :
 257     FloatingWindow( pParent, WB_SYSTEMWINDOW|WB_TOOLTIPWIN ), // #105827# if we change the parent, mirroring will not work correctly when positioning this window
 258     maHelpText( rText ),
 259     maShowTimer( "vcl::HelpTextWindow maShowTimer" ),
 260     maHideTimer( "vcl::HelpTextWindow maHideTimer" )
 261 {
 262     SetType( WindowType::HELPTEXTWINDOW );
 263     ImplSetMouseTransparent( true );
 264     mnHelpWinStyle = nHelpWinStyle;
 265     mnStyle = nStyle;
 266
 267     if( mnStyle & QuickHelpFlags::BiDiRtl )
 268     {
 269         vcl::text::ComplexTextLayoutFlags nLayoutMode = GetOutDev()->GetLayoutMode();
 270         nLayoutMode |= vcl::text::ComplexTextLayoutFlags::BiDiRtl | vcl::text::ComplexTextLayoutFlags::TextOriginLeft;
 271         GetOutDev()->SetLayoutMode( nLayoutMode );
 272     }
 273     SetHelpText( rText );
 274     Window::SetHelpText( rText );
 275
 276     if ( ImplGetSVHelpData().mbSetKeyboardHelp )
 277         ImplGetSVHelpData().mbKeyboardHelp = true;
 278
 279
 280     maShowTimer.SetInvokeHandler( LINK( this, HelpTextWindow, TimerHdl ) );
 281
 282     const HelpSettings& rHelpSettings = pParent->GetSettings().GetHelpSettings();
 283     maHideTimer.SetTimeout( rHelpSettings.GetTipTimeout() );
 284     maHideTimer.SetInvokeHandler( LINK( this, HelpTextWindow, TimerHdl ) );
 285 }
 286
 287 void HelpTextWindow::ApplySettings(vcl::RenderContext& rRenderContext)
 288 {
 289     const StyleSettings& rStyleSettings = rRenderContext.GetSettings().GetStyleSettings();
 290     SetPointFont(rRenderContext, rStyleSettings.GetHelpFont());
 291     rRenderContext.SetTextColor(rStyleSettings.GetHelpTextColor());
 292     rRenderContext.SetTextAlign(ALIGN_TOP);
 293
 294     if (rRenderContext.IsNativeControlSupported(ControlType::Tooltip, ControlPart::Entire))
 295     {
 296         EnableChildTransparentMode();
 297         SetParentClipMode(ParentClipMode::NoClip);
 298         SetPaintTransparent(true);
 299         rRenderContext.SetBackground();
 300     }
 301     else
 302         rRenderContext.SetBackground(Wallpaper(rStyleSettings.GetHelpColor()));
 303
 304     if (rStyleSettings.GetHelpColor().IsDark())
 305         rRenderContext.SetLineColor(COL_WHITE);
 306     else
 307         rRenderContext.SetLineColor(COL_BLACK);
 308     rRenderContext.SetFillColor();
 309 }
 310
 311 HelpTextWindow::~HelpTextWindow()
 312 {
 313     disposeOnce();
 314 }
 315
 316 void HelpTextWindow::dispose()
 317 {
 318     maShowTimer.Stop();
 319     maHideTimer.Stop();
 320
 321     if( this == ImplGetSVHelpData().mpHelpWin )
 322         ImplGetSVHelpData().mpHelpWin = nullptr;
 323     FloatingWindow::dispose();
 324 }
 325
 326 void HelpTextWindow::SetHelpText( const OUString& rHelpText )
 327 {
 328     maHelpText = rHelpText;
 329     ApplySettings(*GetOutDev());
 330     if ( mnHelpWinStyle == HELPWINSTYLE_QUICK && maHelpText.getLength() < HELPTEXTMAXLEN && maHelpText.indexOf('\n') < 0)
 331     {
 332         Size aSize;
 333         aSize.setHeight( GetTextHeight() );
 334         if ( mnStyle & QuickHelpFlags::CtrlText )
 335             aSize.setWidth( GetOutDev()->GetCtrlTextWidth( maHelpText ) );
 336         else
 337             aSize.setWidth( GetTextWidth( maHelpText ) );
 338         maTextRect = tools::Rectangle( Point( HELPTEXTMARGIN_QUICK, HELPTEXTMARGIN_QUICK ), aSize );
 339     }
 340     else // HELPWINSTYLE_BALLOON
 341     {
 342         sal_Int32 nCharsInLine = 35 + ((maHelpText.getLength()/100)*5);
 343         // average width to have all windows consistent
 344         OUStringBuffer aBuf(nCharsInLine);
 345         comphelper::string::padToLength(aBuf, nCharsInLine, 'x');
 346         tools::Long nWidth = GetTextWidth( OUString::unacquired(aBuf) );
 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         PaintImmediately();
 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         return;
 406
 407     Size aSz = GetOutputSizePixel();
 408     rRenderContext.DrawRect(tools::Rectangle(Point(), aSz));
 409     if (mnHelpWinStyle == HELPWINSTYLE_BALLOON)
 410     {
 411         aSz.AdjustWidth( -2 );
 412         aSz.AdjustHeight( -2 );
 413         Color aColor(rRenderContext.GetLineColor());
 414         rRenderContext.SetLineColor(COL_GRAY);
 415         rRenderContext.DrawRect(tools::Rectangle(Point(1, 1), aSz));
 416         rRenderContext.SetLineColor(aColor);
 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 ( ImplGetSVHelpData().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             if ( this == ImplGetSVHelpData().mpHelpWin )
 449                 maHideTimer.Start();
 450         }
 451         ImplShow();
 452     }
 453     else
 454     {
 455         SAL_WARN_IF( pTimer != &maHideTimer, "vcl", "HelpTextWindow::TimerHdl with bad Timer" );
 456         ImplDestroyHelpWindow( true );
 457     }
 458 }
 459
 460 Size HelpTextWindow::CalcOutSize() const
 461 {
 462     Size aSz = maTextRect.GetSize();
 463     aSz.AdjustWidth(2*maTextRect.Left() );
 464     aSz.AdjustHeight(2*maTextRect.Top() );
 465     return aSz;
 466 }
 467
 468 void HelpTextWindow::RequestHelp( const HelpEvent& /*rHEvt*/ )
 469 {
 470     // Just to assure that Window::RequestHelp() is not called by
 471     // ShowQuickHelp/ShowBalloonHelp in the HelpTextWindow.
 472 }
 473
 474 OUString HelpTextWindow::GetText() const
 475 {
 476     return maHelpText;
 477 }
 478
 479 void ImplShowHelpWindow( vcl::Window* pParent, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
 480                          const OUString& rHelpText,
 481                          const Point& rScreenPos, const tools::Rectangle& rHelpArea )
 482 {
 483     if (pParent->ImplGetFrame()->ShowTooltip(rHelpText, rHelpArea))
 484     {
 485         //tooltips are handled natively, return early
 486         return;
 487     }
 488
 489     ImplSVHelpData& aHelpData = ImplGetSVHelpData();
 490
 491     if (rHelpText.isEmpty() && !aHelpData.mbRequestingHelp)
 492         return;
 493
 494     VclPtr<HelpTextWindow> pHelpWin = aHelpData.mpHelpWin;
 495     bool bNoDelay = false;
 496     if ( pHelpWin )
 497     {
 498         SAL_WARN_IF( pHelpWin == pParent, "vcl", "HelpInHelp ?!" );
 499
 500         bool bRemoveHelp = (rHelpText.isEmpty() || (pHelpWin->GetWinStyle() != nHelpWinStyle))
 501                             && aHelpData.mbRequestingHelp;
 502
 503         if (!bRemoveHelp && pHelpWin->GetParent() == pParent)
 504         {
 505             bool const bUpdate = (pHelpWin->GetHelpText() != rHelpText) ||
 506                 ((pHelpWin->GetHelpArea() != rHelpArea) && aHelpData.mbRequestingHelp);
 507             if (bUpdate)
 508             {
 509                 pHelpWin->SetHelpText( rHelpText );
 510                 // approach mouse position
 511                 ImplSetHelpWindowPos( pHelpWin, nHelpWinStyle, nStyle, rScreenPos, rHelpArea );
 512                 if( pHelpWin->IsVisible() )
 513                     pHelpWin->Invalidate();
 514             }
 515         }
 516         else
 517         {
 518             // remove help window if no HelpText or
 519             // other help mode. but keep it if we are scrolling, ie not requesting help
 520             bool bWasVisible = pHelpWin->IsVisible();
 521             if ( bWasVisible )
 522                 bNoDelay = true; // display it quickly if we were already in quick help mode
 523             pHelpWin = nullptr;
 524             ImplDestroyHelpWindow( bWasVisible );
 525         }
 526     }
 527
 528     if (pHelpWin || rHelpText.isEmpty())
 529         return;
 530
 531     sal_uInt64 nCurTime = tools::Time::GetSystemTicks();
 532     if ( ( nCurTime - aHelpData.mnLastHelpHideTime ) < o3tl::make_unsigned(HelpSettings::GetTipDelay()) )
 533         bNoDelay = true;
 534
 535     pHelpWin = VclPtr<HelpTextWindow>::Create( pParent, rHelpText, nHelpWinStyle, nStyle );
 536     aHelpData.mpHelpWin = pHelpWin;
 537     pHelpWin->SetHelpArea( rHelpArea );
 538
 539     //  positioning
 540     Size aSz = pHelpWin->CalcOutSize();
 541     pHelpWin->SetOutputSizePixel( aSz );
 542     ImplSetHelpWindowPos( pHelpWin, nHelpWinStyle, nStyle, rScreenPos, rHelpArea );
 543     // if not called from Window::RequestHelp, then without delay...
 544     if ( !aHelpData.mbRequestingHelp )
 545         bNoDelay = true;
 546     pHelpWin->ShowHelp(bNoDelay);
 547
 548 }
 549
 550 void ImplDestroyHelpWindow( bool bUpdateHideTime )
 551 {
 552     ImplDestroyHelpWindow(ImplGetSVHelpData(), bUpdateHideTime);
 553 }
 554
 555 void ImplDestroyHelpWindow(ImplSVHelpData& rHelpData, bool bUpdateHideTime)
 556 {
 557     VclPtr<HelpTextWindow> pHelpWin = rHelpData.mpHelpWin;
 558     if( pHelpWin )
 559     {
 560         rHelpData.mpHelpWin = nullptr;
 561         rHelpData.mbKeyboardHelp = false;
 562         pHelpWin->Hide();
 563         pHelpWin.disposeAndClear();
 564         if( bUpdateHideTime )
 565             rHelpData.mnLastHelpHideTime = tools::Time::GetSystemTicks();
 566     }
 567 }
 568
 569 void ImplSetHelpWindowPos( vcl::Window* pHelpWin, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
 570                            const Point& rPos, const tools::Rectangle& rHelpArea )
 571 {
 572     Point       aPos = rPos;
 573     Size        aSz = pHelpWin->GetSizePixel();
 574     tools::Rectangle   aScreenRect = pHelpWin->ImplGetFrameWindow()->GetDesktopRectPixel();
 575     aPos = pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( aPos );
 576     // get mouse screen coords
 577     Point aMousePos( pHelpWin->GetParent()->ImplGetFrameWindow()->GetPointerPosPixel() );
 578     aMousePos = pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( aMousePos );
 579
 580     if ( nHelpWinStyle == HELPWINSTYLE_QUICK )
 581     {
 582         if ( !(nStyle & QuickHelpFlags::NoAutoPos) )
 583         {
 584             tools::Long nScreenHeight = aScreenRect.GetHeight();
 585             aPos.AdjustX( -4 );
 586             if ( aPos.Y() > aScreenRect.Top()+nScreenHeight-(nScreenHeight/4) )
 587                 aPos.AdjustY( -(aSz.Height()+4) );
 588             else
 589                 aPos.AdjustY(21 );
 590         }
 591     }
 592     else
 593     {
 594         // If it's the mouse position, move the window slightly
 595         // so the mouse pointer does not cover it
 596         if ( aPos == aMousePos )
 597         {
 598             aPos.AdjustX(12 );
 599             aPos.AdjustY(16 );
 600         }
 601     }
 602
 603     if ( nStyle & QuickHelpFlags::NoAutoPos )
 604     {
 605         // convert help area to screen coords
 606         tools::Rectangle devHelpArea(
 607             pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( rHelpArea.TopLeft() ),
 608             pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( rHelpArea.BottomRight() ) );
 609
 610         // which position of the rectangle?
 611         aPos = devHelpArea.Center();
 612
 613         if ( nStyle & QuickHelpFlags::Left )
 614             aPos.setX( devHelpArea.Left() );
 615         else if ( nStyle & QuickHelpFlags::Right )
 616             aPos.setX( devHelpArea.Right() );
 617
 618         if ( nStyle & QuickHelpFlags::Top )
 619             aPos.setY( devHelpArea.Top() );
 620         else if ( nStyle & QuickHelpFlags::Bottom )
 621             aPos.setY( devHelpArea.Bottom() );
 622
 623         // which direction?
 624         if ( nStyle & QuickHelpFlags::Left )
 625             ;
 626         else if ( nStyle & QuickHelpFlags::Right )
 627             aPos.AdjustX( -(aSz.Width()) );
 628         else
 629             aPos.AdjustX( -(aSz.Width()/2) );
 630
 631         if ( nStyle & QuickHelpFlags::Top )
 632             ;
 633         else if ( nStyle & QuickHelpFlags::Bottom )
 634             aPos.AdjustY( -(aSz.Height()) );
 635         else
 636             aPos.AdjustY( -(aSz.Height()/2) );
 637     }
 638
 639     if ( aPos.X() < aScreenRect.Left() )
 640         aPos.setX( aScreenRect.Left() );
 641     else if ( ( aPos.X() + aSz.Width() ) > aScreenRect.Right() )
 642         aPos.setX( aScreenRect.Right() - aSz.Width() );
 643     if ( aPos.Y() < aScreenRect.Top() )
 644         aPos.setY( aScreenRect.Top() );
 645     else if ( ( aPos.Y() + aSz.Height() ) > aScreenRect.Bottom() )
 646         aPos.setY( aScreenRect.Bottom() - aSz.Height() );
 647
 648     if( ! (nStyle & QuickHelpFlags::NoEvadePointer) )
 649     {
 650         /* the remark below should be obsolete by now as the helpwindow should
 651         not be focusable, leaving it as a hint. However it is sensible in most
 652         conditions to evade the mouse pointer so the content window is fully visible.
 653
 654         // the popup must not appear under the mouse
 655         // otherwise it would directly be closed due to a focus change...
 656         */
 657         tools::Rectangle aHelpRect( aPos, aSz );
 658         if( aHelpRect.Contains( aMousePos ) )
 659         {
 660             Point delta(2,2);
 661             Point aSize( aSz.Width(), aSz.Height() );
 662             Point aTest( aMousePos - aSize - delta );
 663             if( aTest.X() > aScreenRect.Left() && aTest.Y() > aScreenRect.Top() )
 664                 aPos = aTest;
 665             else
 666                 aPos = aMousePos + delta;
 667         }
 668     }
 669
 670     vcl::Window* pWindow = pHelpWin->GetParent()->ImplGetFrameWindow();
 671     aPos = pWindow->AbsoluteScreenToOutputPixel( aPos );
 672     pHelpWin->SetPosPixel( aPos );
 673 }
 674
 675 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */