vcl/source/app/help.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: help.cxx,v $
  10  * $Revision: 1.40 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_vcl.hxx"
  33
  34 #include "vcl/svdata.hxx"
  35 #include "vcl/window.hxx"
  36 #include "vcl/event.hxx"
  37 #include "vcl/svapp.hxx"
  38 #include "vcl/wrkwin.hxx"
  39 #include "vcl/help.hxx"
  40 #include "vcl/helpwin.hxx"
  41 #include "tools/debug.hxx"
  42 #include "tools/time.hxx"
  43
  44 // =======================================================================
  45
  46 #define HELPWINSTYLE_QUICK              0
  47 #define HELPWINSTYLE_BALLOON    1
  48
  49 #define HELPTEXTMARGIN_QUICK    3
  50 #define HELPTEXTMARGIN_BALLOON  6
  51
  52 #define HELPDELAY_NORMAL                1
  53 #define HELPDELAY_SHORT                 2
  54 #define HELPDELAY_NONE                  3
  55
  56 // =======================================================================
  57
  58 Help::Help()
  59 {
  60 }
  61
  62 Help::~Help()
  63 {
  64 }
  65
  66 // -----------------------------------------------------------------------
  67
  68 BOOL Help::Start( ULONG, const Window* )
  69 {
  70     return FALSE;
  71 }
  72
  73 // -----------------------------------------------------------------------
  74
  75 BOOL Help::Start( const XubString&, const Window* )
  76 {
  77     return FALSE;
  78 }
  79
  80 // -----------------------------------------------------------------------
  81
  82 XubString Help::GetHelpText( ULONG, const Window* )
  83 {
  84     return ImplGetSVEmptyStr();
  85 }
  86
  87 // -----------------------------------------------------------------------
  88
  89 XubString Help::GetHelpText( const String&, const Window* )
  90 {
  91     return ImplGetSVEmptyStr();
  92 }
  93
  94 // -----------------------------------------------------------------------
  95
  96 void Help::EnableContextHelp()
  97 {
  98     ImplGetSVData()->maHelpData.mbContextHelp = TRUE;
  99 }
 100
 101 // -----------------------------------------------------------------------
 102
 103 void Help::DisableContextHelp()
 104 {
 105     ImplGetSVData()->maHelpData.mbContextHelp = FALSE;
 106 }
 107
 108 // -----------------------------------------------------------------------
 109
 110 BOOL Help::IsContextHelpEnabled()
 111 {
 112     return ImplGetSVData()->maHelpData.mbContextHelp;
 113 }
 114
 115 // -----------------------------------------------------------------------
 116
 117 BOOL Help::StartContextHelp()
 118 {
 119     ImplSVData* pSVData = ImplGetSVData();
 120
 121     if ( pSVData->maHelpData.mbContextHelp )
 122     {
 123         Window* pWindow = pSVData->maWinData.mpFocusWin;
 124         if ( pWindow )
 125         {
 126             Point               aMousePos = pWindow->OutputToScreenPixel( pWindow->GetPointerPosPixel() );
 127             HelpEvent   aHelpEvent( aMousePos, HELPMODE_CONTEXT );
 128             pWindow->RequestHelp( aHelpEvent );
 129             return TRUE;
 130         }
 131     }
 132
 133     return FALSE;
 134 }
 135
 136 // -----------------------------------------------------------------------
 137
 138 void Help::EnableExtHelp()
 139 {
 140     ImplGetSVData()->maHelpData.mbExtHelp = TRUE;
 141 }
 142
 143 // -----------------------------------------------------------------------
 144
 145 void Help::DisableExtHelp()
 146 {
 147     ImplGetSVData()->maHelpData.mbExtHelp = FALSE;
 148 }
 149
 150 // -----------------------------------------------------------------------
 151
 152 BOOL Help::IsExtHelpEnabled()
 153 {
 154     return ImplGetSVData()->maHelpData.mbExtHelp;
 155 }
 156
 157 // -----------------------------------------------------------------------
 158
 159 BOOL Help::StartExtHelp()
 160 {
 161     ImplSVData* pSVData = ImplGetSVData();
 162
 163     if ( pSVData->maHelpData.mbExtHelp && !pSVData->maHelpData.mbExtHelpMode )
 164     {
 165         pSVData->maHelpData.mbExtHelpMode = TRUE;
 166         pSVData->maHelpData.mbOldBalloonMode = pSVData->maHelpData.mbBalloonHelp;
 167         pSVData->maHelpData.mbBalloonHelp = TRUE;
 168         if ( pSVData->maWinData.mpAppWin )
 169             pSVData->maWinData.mpAppWin->ImplGenerateMouseMove();
 170         return TRUE;
 171     }
 172
 173     return FALSE;
 174 }
 175
 176 // -----------------------------------------------------------------------
 177
 178 BOOL Help::EndExtHelp()
 179 {
 180     ImplSVData* pSVData = ImplGetSVData();
 181
 182     if ( pSVData->maHelpData.mbExtHelp && pSVData->maHelpData.mbExtHelpMode )
 183     {
 184         pSVData->maHelpData.mbExtHelpMode = FALSE;
 185         pSVData->maHelpData.mbBalloonHelp = pSVData->maHelpData.mbOldBalloonMode;
 186         if ( pSVData->maWinData.mpAppWin )
 187             pSVData->maWinData.mpAppWin->ImplGenerateMouseMove();
 188         return TRUE;
 189     }
 190
 191     return FALSE;
 192 }
 193
 194 // -----------------------------------------------------------------------
 195
 196 BOOL Help::IsExtHelpActive()
 197 {
 198     return ImplGetSVData()->maHelpData.mbExtHelpMode;
 199 }
 200
 201 // -----------------------------------------------------------------------
 202
 203 void Help::EnableBalloonHelp()
 204 {
 205     ImplGetSVData()->maHelpData.mbBalloonHelp = TRUE;
 206 }
 207
 208 // -----------------------------------------------------------------------
 209
 210 void Help::DisableBalloonHelp()
 211 {
 212     ImplGetSVData()->maHelpData.mbBalloonHelp = FALSE;
 213 }
 214
 215 // -----------------------------------------------------------------------
 216
 217 BOOL Help::IsBalloonHelpEnabled()
 218 {
 219     return ImplGetSVData()->maHelpData.mbBalloonHelp;
 220 }
 221
 222 // -----------------------------------------------------------------------
 223
 224 BOOL Help::ShowBalloon( Window* pParent,
 225                         const Point& rScreenPos,
 226                         const XubString& rHelpText )
 227 {
 228     ImplShowHelpWindow( pParent, HELPWINSTYLE_BALLOON, 0,
 229                         rHelpText, ImplGetSVEmptyStr(), rScreenPos );
 230
 231     return TRUE;
 232 }
 233
 234 // -----------------------------------------------------------------------
 235
 236 BOOL Help::ShowBalloon( Window* pParent,
 237                         const Point& rScreenPos, const Rectangle& rRect,
 238                         const XubString& rHelpText )
 239 {
 240     ImplShowHelpWindow( pParent, HELPWINSTYLE_BALLOON, 0,
 241                         rHelpText, ImplGetSVEmptyStr(), rScreenPos, &rRect );
 242
 243     return TRUE;
 244 }
 245
 246 // -----------------------------------------------------------------------
 247
 248 void Help::EnableQuickHelp()
 249 {
 250     ImplGetSVData()->maHelpData.mbQuickHelp = TRUE;
 251 }
 252
 253 // -----------------------------------------------------------------------
 254
 255 void Help::DisableQuickHelp()
 256 {
 257     ImplGetSVData()->maHelpData.mbQuickHelp = FALSE;
 258 }
 259
 260 // -----------------------------------------------------------------------
 261
 262 BOOL Help::IsQuickHelpEnabled()
 263 {
 264     return ImplGetSVData()->maHelpData.mbQuickHelp;
 265 }
 266
 267 // -----------------------------------------------------------------------
 268
 269 BOOL Help::ShowQuickHelp( Window* pParent,
 270                           const Rectangle& rScreenRect,
 271                           const XubString& rHelpText,
 272                           const XubString& rLongHelpText,
 273                           USHORT nStyle )
 274 {
 275     ImplShowHelpWindow( pParent, HELPWINSTYLE_QUICK, nStyle,
 276                         rHelpText, rLongHelpText,
 277                         pParent->OutputToScreenPixel( pParent->GetPointerPosPixel() ), &rScreenRect );
 278     return TRUE;
 279 }
 280
 281 // -----------------------------------------------------------------------
 282
 283 ULONG Help::ShowTip( Window* pParent, const Rectangle& rRect,
 284                      const XubString& rText, USHORT nStyle )
 285 {
 286     USHORT nHelpWinStyle = HELPWINSTYLE_QUICK;
 287     HelpTextWindow* pHelpWin = new HelpTextWindow( pParent, rText, nHelpWinStyle, nStyle );
 288
 289     Size aSz = pHelpWin->CalcOutSize();
 290     pHelpWin->SetOutputSizePixel( aSz );
 291     ImplSetHelpWindowPos( pHelpWin, nHelpWinStyle, nStyle,
 292         pParent->OutputToScreenPixel( pParent->GetPointerPosPixel() ), &rRect );
 293     pHelpWin->ShowHelp( HELPDELAY_NONE );
 294     return (ULONG)pHelpWin;
 295 }
 296
 297 // -----------------------------------------------------------------------
 298
 299 void Help::HideTip( ULONG nId )
 300 {
 301     HelpTextWindow* pHelpWin = (HelpTextWindow*)nId;
 302     Window* pFrameWindow = pHelpWin->ImplGetFrameWindow();
 303     pHelpWin->Hide();
 304     // Update ausloesen, damit ein Paint sofort ausgeloest wird, da
 305     // wir den Hintergrund nicht sichern
 306     pFrameWindow->ImplUpdateAll();
 307     delete pHelpWin;
 308     ImplGetSVData()->maHelpData.mnLastHelpHideTime = Time::GetSystemTicks();
 309 }
 310
 311 // =======================================================================
 312
 313 HelpTextWindow::HelpTextWindow( Window* pParent, const XubString& rText, USHORT nHelpWinStyle, USHORT nStyle ) :
 314     //FloatingWindow( pParent->ImplGetFrameWindow(), WB_SYSTEMWINDOW ),
 315     FloatingWindow( pParent, WB_SYSTEMWINDOW|WB_TOOLTIPWIN ), // #105827# if we change the parent, mirroring will not work correctly when positioning this window
 316     maHelpText( rText )
 317 {
 318     SetType( WINDOW_HELPTEXTWINDOW );
 319     ImplSetMouseTransparent( TRUE );
 320     mnHelpWinStyle = nHelpWinStyle;
 321     mnStyle = nStyle;
 322 //  on windows this will raise the application window, because help windows are system windows now
 323 //      EnableAlwaysOnTop();
 324     EnableSaveBackground();
 325
 326     const StyleSettings& rStyleSettings = GetSettings().GetStyleSettings();
 327     SetPointFont( rStyleSettings.GetHelpFont() );
 328     SetTextColor( rStyleSettings.GetHelpTextColor() );
 329     SetTextAlign( ALIGN_TOP );
 330     if ( IsNativeControlSupported( CTRL_TOOLTIP, PART_ENTIRE_CONTROL ) )
 331     {
 332         EnableChildTransparentMode( TRUE );
 333         SetParentClipMode( PARENTCLIPMODE_NOCLIP );
 334         SetPaintTransparent( TRUE );
 335         SetBackground();
 336     }
 337     else
 338         SetBackground( Wallpaper( rStyleSettings.GetHelpColor() ) );
 339     if( rStyleSettings.GetHelpColor().IsDark() )
 340         SetLineColor( COL_WHITE );
 341     else
 342         SetLineColor( COL_BLACK );
 343     SetFillColor();
 344
 345     if( mnStyle & QUICKHELP_BIDI_RTL )
 346     {
 347         ULONG nLayoutMode = GetLayoutMode();
 348         nLayoutMode |= TEXT_LAYOUT_BIDI_RTL | TEXT_LAYOUT_TEXTORIGIN_LEFT;
 349         SetLayoutMode( nLayoutMode );
 350     }
 351     SetHelpText( rText );
 352     Window::SetHelpText( rText );
 353
 354     ImplSVData* pSVData = ImplGetSVData();
 355     if ( pSVData->maHelpData.mbSetKeyboardHelp )
 356         pSVData->maHelpData.mbKeyboardHelp = TRUE;
 357
 358     const HelpSettings& rHelpSettings = pParent->GetSettings().GetHelpSettings();
 359     maShowTimer.SetTimeoutHdl( LINK( this, HelpTextWindow, TimerHdl ) );
 360     maHideTimer.SetTimeoutHdl( LINK( this, HelpTextWindow, TimerHdl ) );
 361     maHideTimer.SetTimeout( rHelpSettings.GetTipTimeout() );
 362 }
 363
 364 // -----------------------------------------------------------------------
 365
 366 HelpTextWindow::~HelpTextWindow()
 367 {
 368     maShowTimer.Stop();
 369     maHideTimer.Stop();
 370
 371     if( this == ImplGetSVData()->maHelpData.mpHelpWin )
 372         ImplGetSVData()->maHelpData.mpHelpWin = NULL;
 373
 374     if ( maStatusText.Len() )
 375     {
 376         ImplSVData* pSVData = ImplGetSVData();
 377         pSVData->mpApp->HideHelpStatusText();
 378     }
 379 }
 380
 381 // -----------------------------------------------------------------------
 382
 383 void HelpTextWindow::SetHelpText( const String& rHelpText )
 384 {
 385     maHelpText = rHelpText;
 386     if ( mnHelpWinStyle == HELPWINSTYLE_QUICK )
 387     {
 388         Size aSize;
 389         aSize.Height() = GetTextHeight();
 390         if ( mnStyle & QUICKHELP_CTRLTEXT )
 391             aSize.Width() = GetCtrlTextWidth( maHelpText );
 392         else
 393             aSize.Width() = GetTextWidth( maHelpText );
 394         maTextRect = Rectangle( Point( HELPTEXTMARGIN_QUICK, HELPTEXTMARGIN_QUICK ), aSize );
 395     }
 396     else // HELPWINSTYLE_BALLOON
 397     {
 398         Point           aTmpPoint;
 399         USHORT          nCharsInLine = 35 + ((maHelpText.Len()/100)*5);
 400         XubString       aXXX;
 401         aXXX.Fill( nCharsInLine, 'x' );   // Durchschnittliche Breite, damit nicht jedes Fenster anders.
 402         long nWidth = GetTextWidth( aXXX );
 403         Size aTmpSize( nWidth, 0x7FFFFFFF );
 404         Rectangle aTry1( aTmpPoint, aTmpSize );
 405         USHORT nDrawFlags = TEXT_DRAW_MULTILINE | TEXT_DRAW_WORDBREAK |
 406                             TEXT_DRAW_LEFT | TEXT_DRAW_TOP;
 407         if ( mnStyle & QUICKHELP_CTRLTEXT )
 408             nDrawFlags |= TEXT_DRAW_MNEMONIC;
 409         Rectangle aTextRect = GetTextRect( aTry1, maHelpText, nDrawFlags );
 410
 411         // Spaeter mal eine geeignete Breite ermitteln...
 412         maTextRect = aTextRect;
 413
 414         // Sicherheitsabstand...
 415         maTextRect.SetPos( Point( HELPTEXTMARGIN_BALLOON, HELPTEXTMARGIN_BALLOON ) );
 416     }
 417
 418     Size aSize( CalcOutSize() );
 419     SetOutputSizePixel( aSize );
 420 }
 421
 422 // -----------------------------------------------------------------------
 423
 424 void HelpTextWindow::ImplShow()
 425 {
 426     ImplDelData aDogTag( this );
 427     if ( maStatusText.Len() )
 428     {
 429         ImplSVData* pSVData = ImplGetSVData();
 430         pSVData->mpApp->ShowHelpStatusText( maStatusText );
 431     }
 432     Show( TRUE, SHOW_NOACTIVATE );
 433     if( !aDogTag.IsDelete() )
 434     Update();
 435 }
 436
 437 // -----------------------------------------------------------------------
 438
 439 void HelpTextWindow::Paint( const Rectangle& )
 440 {
 441     // paint native background
 442     bool bNativeOK = false;
 443     if ( IsNativeControlSupported( CTRL_TOOLTIP, PART_ENTIRE_CONTROL ) )
 444     {
 445         // #i46472# workaround gcc3.3 temporary problem
 446         Region aCtrlRegion = Region( Rectangle( Point( 0, 0 ), GetOutputSizePixel() ) );
 447         ImplControlValue    aControlValue;
 448         bNativeOK = DrawNativeControl( CTRL_TOOLTIP, PART_ENTIRE_CONTROL, aCtrlRegion,
 449                                        0, aControlValue, rtl::OUString() );
 450     }
 451
 452     // paint text
 453     if ( mnHelpWinStyle == HELPWINSTYLE_QUICK )
 454     {
 455         if ( mnStyle & QUICKHELP_CTRLTEXT )
 456             DrawCtrlText( maTextRect.TopLeft(), maHelpText );
 457         else
 458             DrawText( maTextRect.TopLeft(), maHelpText );
 459     }
 460     else // HELPWINSTYLE_BALLOON
 461     {
 462         USHORT nDrawFlags = TEXT_DRAW_MULTILINE|TEXT_DRAW_WORDBREAK|
 463                                 TEXT_DRAW_LEFT|TEXT_DRAW_TOP;
 464         if ( mnStyle & QUICKHELP_CTRLTEXT )
 465             nDrawFlags |= TEXT_DRAW_MNEMONIC;
 466         DrawText( maTextRect, maHelpText, nDrawFlags );
 467     }
 468
 469     // border
 470     if( ! bNativeOK )
 471     {
 472         Size aSz = GetOutputSizePixel();
 473         DrawRect( Rectangle( Point(), aSz ) );
 474         if ( mnHelpWinStyle == HELPWINSTYLE_BALLOON )
 475         {
 476             aSz.Width() -= 2;
 477             aSz.Height() -= 2;
 478             Color aColor( GetLineColor() );
 479             SetLineColor( ( COL_GRAY ) );
 480             DrawRect( Rectangle( Point( 1, 1 ), aSz ) );
 481             SetLineColor( aColor );
 482         }
 483     }
 484 }
 485
 486 // -----------------------------------------------------------------------
 487
 488 void HelpTextWindow::ShowHelp( USHORT nDelayMode )
 489 {
 490     ULONG nTimeout = 0;
 491     if ( nDelayMode != HELPDELAY_NONE )
 492     {
 493         // Im ExtendedHelp-Fall die Hilfe schneller anzeigen
 494         if ( ImplGetSVData()->maHelpData.mbExtHelpMode )
 495             nTimeout = 15;
 496         else
 497         {
 498             const HelpSettings& rHelpSettings = GetSettings().GetHelpSettings();
 499             if ( mnHelpWinStyle == HELPWINSTYLE_QUICK )
 500                 nTimeout = rHelpSettings.GetTipDelay();
 501             else
 502                 nTimeout = rHelpSettings.GetBalloonDelay();
 503         }
 504
 505         if ( nDelayMode == HELPDELAY_SHORT )
 506             nTimeout /= 3;
 507     }
 508
 509     maShowTimer.SetTimeout( nTimeout );
 510     maShowTimer.Start();
 511 }
 512
 513 // -----------------------------------------------------------------------
 514
 515 IMPL_LINK( HelpTextWindow, TimerHdl, Timer*, pTimer)
 516 {
 517     if ( pTimer == &maShowTimer )
 518     {
 519         if ( mnHelpWinStyle == HELPWINSTYLE_QUICK )
 520         {
 521             // start auto-hide-timer for non-ShowTip windows
 522             ImplSVData* pSVData = ImplGetSVData();
 523             if ( this == pSVData->maHelpData.mpHelpWin )
 524                 maHideTimer.Start();
 525         }
 526         ImplShow();
 527     }
 528     else
 529     {
 530         DBG_ASSERT( pTimer == &maHideTimer, "HelpTextWindow::TimerHdl with bad Timer" );
 531           ImplDestroyHelpWindow( true );
 532     }
 533
 534     return 1;
 535 }
 536
 537 // -----------------------------------------------------------------------
 538
 539 Size HelpTextWindow::CalcOutSize() const
 540 {
 541     Size aSz = maTextRect.GetSize();
 542     aSz.Width() += 2*maTextRect.Left();
 543     aSz.Height() += 2*maTextRect.Top();
 544     return aSz;
 545 }
 546
 547 // -----------------------------------------------------------------------
 548
 549 void HelpTextWindow::RequestHelp( const HelpEvent& /*rHEvt*/ )
 550 {
 551     // Nur damit nicht von Window::RequestHelp() ein
 552     // ShowQuickHelp/ShowBalloonHelp am HelpTextWindow aufgerufen wird.
 553 }
 554
 555 // -----------------------------------------------------------------------
 556
 557 String HelpTextWindow::GetText() const
 558 {
 559     return maHelpText;
 560 }
 561
 562 // -----------------------------------------------------------------------
 563
 564 ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > HelpTextWindow::CreateAccessible()
 565 {
 566     return FloatingWindow::CreateAccessible();
 567 }
 568
 569 // -----------------------------------------------------------------------
 570
 571 BOOL HelpTextWindow::RegisterAccessibleParent()
 572 {
 573         return FALSE;
 574 }
 575
 576 // -----------------------------------------------------------------------
 577
 578 void HelpTextWindow::RevokeAccessibleParent()
 579 {
 580 }
 581
 582 // =======================================================================
 583
 584 void ImplShowHelpWindow( Window* pParent, USHORT nHelpWinStyle, USHORT nStyle,
 585                          const XubString& rHelpText, const XubString& rStatusText,
 586                          const Point& rScreenPos, const Rectangle* pHelpArea )
 587 {
 588     ImplSVData* pSVData = ImplGetSVData();
 589
 590     if( !rHelpText.Len() && !pSVData->maHelpData.mbRequestingHelp )
 591         return;
 592
 593     HelpTextWindow* pHelpWin = pSVData->maHelpData.mpHelpWin;
 594     USHORT nDelayMode = HELPDELAY_NORMAL;
 595     if ( pHelpWin )
 596     {
 597         DBG_ASSERT( pHelpWin != pParent, "HelpInHelp ?!" );
 598
 599             if ( (( pHelpWin->GetHelpText() != rHelpText ) ||
 600                  ( pHelpWin->GetWinStyle() != nHelpWinStyle ) ||
 601                  ( pHelpArea && ( pHelpWin->GetHelpArea() != *pHelpArea ) ) )
 602                  && pSVData->maHelpData.mbRequestingHelp )
 603         {
 604             // remove help window if no HelpText or other HelpText or
 605             // other help mode. but keep it if we are scrolling, ie not requesting help
 606             bool bWasVisible = pHelpWin->IsVisible();
 607             if ( bWasVisible )
 608                 nDelayMode = HELPDELAY_NONE; // display it quickly if we were already in quick help mode
 609             pHelpWin = NULL;
 610             ImplDestroyHelpWindow( bWasVisible );
 611         }
 612         else
 613         {
 614             bool bTextChanged = rHelpText != pHelpWin->GetHelpText();
 615             if( bTextChanged )
 616             {
 617                 Window * pWindow = pHelpWin->GetParent()->ImplGetFrameWindow();
 618                 Rectangle aInvRect( pHelpWin->GetWindowExtentsRelative( pWindow ) );
 619                 if( pHelpWin->IsVisible() )
 620                     pWindow->Invalidate( aInvRect );
 621
 622                 pHelpWin->SetHelpText( rHelpText );
 623                 // approach mouse position
 624                 ImplSetHelpWindowPos( pHelpWin, nHelpWinStyle, nStyle, rScreenPos, pHelpArea );
 625                 if( pHelpWin->IsVisible() )
 626                     pHelpWin->Invalidate();
 627             }
 628         }
 629     }
 630
 631     if ( !pHelpWin && rHelpText.Len() )
 632     {
 633         ULONG nCurTime = Time::GetSystemTicks();
 634         if( (nCurTime - pSVData->maHelpData.mnLastHelpHideTime) < pParent->GetSettings().GetHelpSettings().GetTipDelay() )
 635             nDelayMode = HELPDELAY_NONE;
 636
 637         DBG_ASSERT( !pHelpWin, "Noch ein HelpWin ?!" );
 638         pHelpWin = new HelpTextWindow( pParent, rHelpText, nHelpWinStyle, nStyle );
 639         pSVData->maHelpData.mpHelpWin = pHelpWin;
 640         pHelpWin->SetStatusText( rStatusText );
 641         if ( pHelpArea )
 642             pHelpWin->SetHelpArea( *pHelpArea );
 643
 644         //      positioning
 645         Size aSz = pHelpWin->CalcOutSize();
 646         pHelpWin->SetOutputSizePixel( aSz );
 647         ImplSetHelpWindowPos( pHelpWin, nHelpWinStyle, nStyle, rScreenPos, pHelpArea );
 648         // if not called from Window::RequestHelp, then without delay...
 649         if ( !pSVData->maHelpData.mbRequestingHelp )
 650             nDelayMode = HELPDELAY_NONE;
 651         pHelpWin->ShowHelp( nDelayMode );
 652     }
 653 }
 654
 655 // -----------------------------------------------------------------------
 656
 657 void ImplDestroyHelpWindow( bool bUpdateHideTime )
 658 {
 659     ImplSVData* pSVData = ImplGetSVData();
 660     HelpTextWindow* pHelpWin = pSVData->maHelpData.mpHelpWin;
 661     if ( pHelpWin )
 662     {
 663         Window * pWindow = pHelpWin->GetParent()->ImplGetFrameWindow();
 664         // find out screen area covered by system help window
 665         Rectangle aInvRect( pHelpWin->GetWindowExtentsRelative( pWindow ) );
 666         if( pHelpWin->IsVisible() )
 667             pWindow->Invalidate( aInvRect );
 668         pSVData->maHelpData.mpHelpWin = NULL;
 669         pSVData->maHelpData.mbKeyboardHelp = FALSE;
 670         pHelpWin->Hide();
 671         delete pHelpWin;
 672         if( bUpdateHideTime )
 673             pSVData->maHelpData.mnLastHelpHideTime = Time::GetSystemTicks();
 674     }
 675 }
 676
 677 // -----------------------------------------------------------------------
 678
 679 void ImplSetHelpWindowPos( Window* pHelpWin, USHORT nHelpWinStyle, USHORT nStyle,
 680                            const Point& rPos, const Rectangle* pHelpArea )
 681 {
 682     Point               aPos = rPos;
 683     Size                aSz = pHelpWin->GetSizePixel();
 684     Rectangle   aScreenRect = pHelpWin->ImplGetFrameWindow()->GetDesktopRectPixel();
 685     aPos = pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( aPos );
 686     // get mouse screen coords
 687     Point mPos( pHelpWin->GetParent()->ImplGetFrameWindow()->GetPointerPosPixel() );
 688     mPos = pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( mPos );
 689
 690     if ( nHelpWinStyle == HELPWINSTYLE_QUICK )
 691     {
 692         if ( !(nStyle & QUICKHELP_NOAUTOPOS) )
 693         {
 694             long nScreenHeight = aScreenRect.GetHeight();
 695             aPos.X() -= 4;
 696             if ( aPos.Y() > aScreenRect.Top()+nScreenHeight-(nScreenHeight/4) )
 697                 aPos.Y() -= aSz.Height()+4;
 698             else
 699                 aPos.Y() += 21;
 700         }
 701     }
 702     else
 703     {
 704         // If it's the mouse position, move the window slightly
 705         // so the mouse pointer does not cover it
 706         if ( aPos == mPos )
 707         {
 708             aPos.X() += 12;
 709             aPos.Y() += 16;
 710         }
 711     }
 712
 713     if ( nStyle & QUICKHELP_NOAUTOPOS )
 714     {
 715         if ( pHelpArea )
 716         {
 717             // convert help area to screen coords
 718             Rectangle devHelpArea(
 719                 pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( pHelpArea->TopLeft() ),
 720                 pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( pHelpArea->BottomRight() ) );
 721
 722             // Welche Position vom Rechteck?
 723             aPos = devHelpArea.Center();
 724
 725             if ( nStyle & QUICKHELP_LEFT )
 726                 aPos.X() = devHelpArea.Left();
 727             else if ( nStyle & QUICKHELP_RIGHT )
 728                 aPos.X() = devHelpArea.Right();
 729
 730             if ( nStyle & QUICKHELP_TOP )
 731                 aPos.Y() = devHelpArea.Top();
 732             else if ( nStyle & QUICKHELP_BOTTOM )
 733                 aPos.Y() = devHelpArea.Bottom();
 734         }
 735
 736         // Welche Richtung?
 737         if ( nStyle & QUICKHELP_LEFT )
 738             ;
 739         else if ( nStyle & QUICKHELP_RIGHT )
 740             aPos.X() -= aSz.Width();
 741         else
 742             aPos.X() -= aSz.Width()/2;
 743
 744         if ( nStyle & QUICKHELP_TOP )
 745             ;
 746         else if ( nStyle & QUICKHELP_BOTTOM )
 747             aPos.Y() -= aSz.Height();
 748         else
 749             aPos.Y() -= aSz.Height()/2;
 750     }
 751
 752     if ( aPos.X() < aScreenRect.Left() )
 753         aPos.X() = aScreenRect.Left();
 754     else if ( ( aPos.X() + aSz.Width() ) > aScreenRect.Right() )
 755         aPos.X() = aScreenRect.Right() - aSz.Width();
 756     if ( aPos.Y() < aScreenRect.Top() )
 757         aPos.Y() = aScreenRect.Top();
 758     else if ( ( aPos.Y() + aSz.Height() ) > aScreenRect.Bottom() )
 759         aPos.Y() = aScreenRect.Bottom() - aSz.Height();
 760
 761     // the popup must not appear under the mouse
 762     // otherwise it would directly be closed due to a focus change...
 763     Rectangle aHelpRect( aPos, aSz );
 764     if( aHelpRect.IsInside( mPos ) )
 765     {
 766         Point delta(2,2);
 767         Point pSize( aSz.Width(), aSz.Height() );
 768         Point pTest( mPos - pSize - delta );
 769         if( pTest.X() > aScreenRect.Left() &&  pTest.Y() > aScreenRect.Top() )
 770             aPos = pTest;
 771         else
 772             aPos = mPos + delta;
 773     }
 774
 775     Window* pWindow = pHelpWin->GetParent()->ImplGetFrameWindow();
 776     aPos = pWindow->AbsoluteScreenToOutputPixel( aPos );
 777     pHelpWin->SetPosPixel( aPos );
 778 }