vcl/source/control/spinbtn.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 <tools/rcid.h>
  21 #include <vcl/spin.h>
  22 #include <vcl/event.hxx>
  23 #include <vcl/spin.hxx>
  24
  25 // =======================================================================
  26
  27 void SpinButton::ImplInit( Window* pParent, WinBits nStyle )
  28 {
  29     mbUpperIn     = sal_False;
  30     mbLowerIn     = sal_False;
  31     mbInitialUp   = sal_False;
  32     mbInitialDown = sal_False;
  33
  34     mnMinRange  = 0;
  35     mnMaxRange  = 100;
  36     mnValue     = 0;
  37     mnValueStep = 1;
  38
  39     maRepeatTimer.SetTimeout( GetSettings().GetMouseSettings().GetButtonStartRepeat() );
  40     maRepeatTimer.SetTimeoutHdl( LINK( this, SpinButton, ImplTimeout ) );
  41
  42     mbRepeat = 0 != ( nStyle & WB_REPEAT );
  43
  44     if ( nStyle & WB_HSCROLL )
  45         mbHorz = sal_True;
  46     else
  47         mbHorz = sal_False;
  48
  49     Control::ImplInit( pParent, nStyle, NULL );
  50 }
  51
  52 // -----------------------------------------------------------------------
  53
  54 SpinButton::SpinButton( Window* pParent, WinBits nStyle )
  55     :Control( WINDOW_SPINBUTTON )
  56     ,mbUpperIsFocused( sal_False )
  57 {
  58     ImplInit( pParent, nStyle );
  59 }
  60
  61 // -----------------------------------------------------------------------
  62
  63 SpinButton::~SpinButton()
  64 {
  65 }
  66
  67 // -----------------------------------------------------------------------
  68
  69 IMPL_LINK( SpinButton, ImplTimeout, Timer*, pTimer )
  70 {
  71     if ( pTimer->GetTimeout() == GetSettings().GetMouseSettings().GetButtonStartRepeat() )
  72     {
  73         pTimer->SetTimeout( GetSettings().GetMouseSettings().GetButtonRepeat() );
  74         pTimer->Start();
  75     }
  76     else
  77     {
  78         if ( mbInitialUp )
  79             Up();
  80         else
  81             Down();
  82     }
  83
  84     return 0;
  85 }
  86
  87 // -----------------------------------------------------------------------
  88
  89 void SpinButton::Up()
  90 {
  91     if ( ImplIsUpperEnabled() )
  92     {
  93         mnValue += mnValueStep;
  94         StateChanged( STATE_CHANGE_DATA );
  95
  96         ImplMoveFocus( sal_True );
  97     }
  98
  99     ImplCallEventListenersAndHandler( VCLEVENT_SPINBUTTON_UP, maUpHdlLink, this );
 100 }
 101
 102 // -----------------------------------------------------------------------
 103
 104 void SpinButton::Down()
 105 {
 106     if ( ImplIsLowerEnabled() )
 107     {
 108         mnValue -= mnValueStep;
 109         StateChanged( STATE_CHANGE_DATA );
 110
 111         ImplMoveFocus( sal_False );
 112     }
 113
 114     ImplCallEventListenersAndHandler( VCLEVENT_SPINBUTTON_DOWN, maDownHdlLink, this );
 115 }
 116
 117 // -----------------------------------------------------------------------
 118
 119 void SpinButton::Resize()
 120 {
 121     Control::Resize();
 122
 123     Size aSize( GetOutputSizePixel() );
 124     Point aTmpPoint;
 125     Rectangle aRect( aTmpPoint, aSize );
 126     if ( mbHorz )
 127     {
 128         maLowerRect = Rectangle( 0, 0, aSize.Width()/2, aSize.Height()-1 );
 129         maUpperRect = Rectangle( maLowerRect.TopRight(), aRect.BottomRight() );
 130     }
 131     else
 132     {
 133         maUpperRect = Rectangle( 0, 0, aSize.Width()-1, aSize.Height()/2 );
 134         maLowerRect = Rectangle( maUpperRect.BottomLeft(), aRect.BottomRight() );
 135     }
 136
 137     ImplCalcFocusRect( ImplIsUpperEnabled() || !ImplIsLowerEnabled() );
 138
 139     Invalidate();
 140 }
 141
 142 // -----------------------------------------------------------------------
 143
 144 void SpinButton::Draw( OutputDevice* pDev, const Point& rPos, const Size& rSize, sal_uLong nFlags )
 145 {
 146     Point       aPos  = pDev->LogicToPixel( rPos );
 147     Size        aSize = pDev->LogicToPixel( rSize );
 148
 149     pDev->Push();
 150     pDev->SetMapMode();
 151     if ( !(nFlags & WINDOW_DRAW_MONO) )
 152     {
 153         // DecoView uses the FaceColor...
 154         AllSettings aSettings = pDev->GetSettings();
 155         StyleSettings aStyleSettings = aSettings.GetStyleSettings();
 156         if ( IsControlBackground() )
 157             aStyleSettings.SetFaceColor( GetControlBackground() );
 158         else
 159             aStyleSettings.SetFaceColor( GetSettings().GetStyleSettings().GetFaceColor() );
 160
 161         aSettings.SetStyleSettings( aStyleSettings );
 162         pDev->SetSettings( aSettings );
 163     }
 164
 165     Rectangle   aRect( Point( 0, 0 ), aSize );
 166     Rectangle aLowerRect, aUpperRect;
 167     if ( mbHorz )
 168     {
 169         aLowerRect = Rectangle( 0, 0, aSize.Width()/2, aSize.Height()-1 );
 170         aUpperRect = Rectangle( aLowerRect.TopRight(), aRect.BottomRight() );
 171     }
 172     else
 173     {
 174         aUpperRect = Rectangle( 0, 0, aSize.Width()-1, aSize.Height()/2 );
 175         aLowerRect = Rectangle( aUpperRect.BottomLeft(), aRect.BottomRight() );
 176     }
 177
 178     aUpperRect += aPos;
 179     aLowerRect += aPos;
 180
 181     ImplDrawSpinButton( pDev, aUpperRect, aLowerRect, sal_False, sal_False,
 182                         IsEnabled() && ImplIsUpperEnabled(),
 183                         IsEnabled() && ImplIsLowerEnabled(), mbHorz, sal_True );
 184     pDev->Pop();
 185 }
 186
 187
 188 void SpinButton::Paint( const Rectangle& )
 189 {
 190     HideFocus();
 191
 192     sal_Bool bEnable = IsEnabled();
 193     ImplDrawSpinButton( this, maUpperRect, maLowerRect, mbUpperIn, mbLowerIn,
 194                         bEnable && ImplIsUpperEnabled(),
 195                         bEnable && ImplIsLowerEnabled(), mbHorz, sal_True );
 196
 197     if ( HasFocus() )
 198         ShowFocus( maFocusRect );
 199 }
 200
 201 // -----------------------------------------------------------------------
 202
 203 void SpinButton::MouseButtonDown( const MouseEvent& rMEvt )
 204 {
 205     if ( maUpperRect.IsInside( rMEvt.GetPosPixel() ) && ( ImplIsUpperEnabled() ) )
 206     {
 207         mbUpperIn   = sal_True;
 208         mbInitialUp = sal_True;
 209         Invalidate( maUpperRect );
 210     }
 211     else if ( maLowerRect.IsInside( rMEvt.GetPosPixel() ) && ( ImplIsLowerEnabled() ) )
 212     {
 213         mbLowerIn     = sal_True;
 214         mbInitialDown = sal_True;
 215         Invalidate( maLowerRect );
 216     }
 217
 218     if ( mbUpperIn || mbLowerIn )
 219     {
 220         Update();
 221         CaptureMouse();
 222         if ( mbRepeat )
 223             maRepeatTimer.Start();
 224     }
 225 }
 226
 227 // -----------------------------------------------------------------------
 228
 229 void SpinButton::MouseButtonUp( const MouseEvent& )
 230 {
 231     ReleaseMouse();
 232     if ( mbRepeat )
 233     {
 234         maRepeatTimer.Stop();
 235         maRepeatTimer.SetTimeout(GetSettings().GetMouseSettings().GetButtonStartRepeat() );
 236     }
 237
 238     if ( mbUpperIn )
 239     {
 240         mbUpperIn   = sal_False;
 241         Invalidate( maUpperRect );
 242         Update();
 243         Up();
 244     }
 245     else if ( mbLowerIn )
 246     {
 247         mbLowerIn = sal_False;
 248         Invalidate( maLowerRect );
 249         Update();
 250         Down();
 251     }
 252
 253     mbInitialUp = mbInitialDown = sal_False;
 254 }
 255
 256 // -----------------------------------------------------------------------
 257
 258 void SpinButton::MouseMove( const MouseEvent& rMEvt )
 259 {
 260     if ( !rMEvt.IsLeft() || (!mbInitialUp && !mbInitialDown) )
 261         return;
 262
 263     if ( !maUpperRect.IsInside( rMEvt.GetPosPixel() ) &&
 264          mbUpperIn && mbInitialUp )
 265     {
 266         mbUpperIn = sal_False;
 267         maRepeatTimer.Stop();
 268         Invalidate( maUpperRect );
 269         Update();
 270     }
 271     else if ( !maLowerRect.IsInside( rMEvt.GetPosPixel() ) &&
 272               mbLowerIn & mbInitialDown )
 273     {
 274         mbLowerIn = sal_False;
 275         maRepeatTimer.Stop();
 276         Invalidate( maLowerRect );
 277         Update();
 278     }
 279     else if ( maUpperRect.IsInside( rMEvt.GetPosPixel() ) &&
 280               !mbUpperIn && mbInitialUp )
 281     {
 282         mbUpperIn = sal_True;
 283         if ( mbRepeat )
 284             maRepeatTimer.Start();
 285         Invalidate( maUpperRect );
 286         Update();
 287     }
 288     else if ( maLowerRect.IsInside( rMEvt.GetPosPixel() ) &&
 289               !mbLowerIn && mbInitialDown )
 290     {
 291         mbLowerIn = sal_True;
 292         if ( mbRepeat )
 293             maRepeatTimer.Start();
 294         Invalidate( maLowerRect );
 295         Update();
 296     }
 297 }
 298
 299 // -----------------------------------------------------------------------
 300
 301 void SpinButton::KeyInput( const KeyEvent& rKEvt )
 302 {
 303     if ( !rKEvt.GetKeyCode().GetModifier() )
 304     {
 305         switch ( rKEvt.GetKeyCode().GetCode() )
 306         {
 307         case KEY_LEFT:
 308         case KEY_RIGHT:
 309         {
 310             bool bUp = KEY_RIGHT == rKEvt.GetKeyCode().GetCode();
 311             if ( mbHorz && !ImplMoveFocus( bUp ) )
 312                 bUp ? Up() : Down();
 313         }
 314         break;
 315
 316         case KEY_UP:
 317         case KEY_DOWN:
 318         {
 319             bool bUp = KEY_UP == rKEvt.GetKeyCode().GetCode();
 320             if ( !mbHorz && !ImplMoveFocus( KEY_UP == rKEvt.GetKeyCode().GetCode() ) )
 321                 bUp ? Up() : Down();
 322         }
 323         break;
 324
 325         case KEY_SPACE:
 326             mbUpperIsFocused ? Up() : Down();
 327             break;
 328
 329         default:
 330             Control::KeyInput( rKEvt );
 331             break;
 332         }
 333     }
 334     else
 335         Control::KeyInput( rKEvt );
 336 }
 337
 338 // -----------------------------------------------------------------------
 339
 340 void SpinButton::StateChanged( StateChangedType nType )
 341 {
 342     switch ( nType )
 343     {
 344     case STATE_CHANGE_DATA:
 345     case STATE_CHANGE_ENABLE:
 346         Invalidate();
 347         break;
 348
 349     case STATE_CHANGE_STYLE:
 350     {
 351         sal_Bool bNewRepeat = 0 != ( GetStyle() & WB_REPEAT );
 352         if ( bNewRepeat != mbRepeat )
 353         {
 354             if ( maRepeatTimer.IsActive() )
 355             {
 356                 maRepeatTimer.Stop();
 357                 maRepeatTimer.SetTimeout( GetSettings().GetMouseSettings().GetButtonStartRepeat() );
 358             }
 359             mbRepeat = bNewRepeat;
 360         }
 361
 362         sal_Bool bNewHorz = 0 != ( GetStyle() & WB_HSCROLL );
 363         if ( bNewHorz != mbHorz )
 364         {
 365             mbHorz = bNewHorz;
 366             Resize();
 367         }
 368     }
 369     break;
 370     }
 371
 372     Control::StateChanged( nType );
 373 }
 374
 375 // -----------------------------------------------------------------------
 376
 377 void SpinButton::SetRangeMin( long nNewRange )
 378 {
 379     SetRange( Range( nNewRange, GetRangeMax() ) );
 380 }
 381
 382 // -----------------------------------------------------------------------
 383
 384 void SpinButton::SetRangeMax( long nNewRange )
 385 {
 386     SetRange( Range( GetRangeMin(), nNewRange ) );
 387 }
 388
 389 // -----------------------------------------------------------------------
 390
 391 void SpinButton::SetRange( const Range& rRange )
 392 {
 393     // adjust rage
 394     Range aRange = rRange;
 395     aRange.Justify();
 396     long nNewMinRange = aRange.Min();
 397     long nNewMaxRange = aRange.Max();
 398
 399     // do something only if old and new range differ
 400     if ( (mnMinRange != nNewMinRange) ||
 401          (mnMaxRange != nNewMaxRange) )
 402     {
 403         mnMinRange = nNewMinRange;
 404         mnMaxRange = nNewMaxRange;
 405
 406         // adjust value to new range, if necessary
 407         if ( mnValue > mnMaxRange )
 408             mnValue = mnMaxRange;
 409         if ( mnValue < mnMinRange )
 410             mnValue = mnMinRange;
 411
 412         StateChanged( STATE_CHANGE_DATA );
 413     }
 414 }
 415
 416 // -----------------------------------------------------------------------
 417
 418 void SpinButton::SetValue( long nValue )
 419 {
 420     // adjust, if necessary
 421     if ( nValue > mnMaxRange )
 422         nValue = mnMaxRange;
 423     if ( nValue < mnMinRange )
 424         nValue = mnMinRange;
 425
 426     if ( mnValue != nValue )
 427     {
 428         mnValue = nValue;
 429         StateChanged( STATE_CHANGE_DATA );
 430     }
 431 }
 432
 433 // -----------------------------------------------------------------------
 434
 435 void SpinButton::GetFocus()
 436 {
 437     ShowFocus( maFocusRect );
 438     Control::GetFocus();
 439 }
 440
 441 // -----------------------------------------------------------------------
 442
 443 void SpinButton::LoseFocus()
 444 {
 445     HideFocus();
 446     Control::LoseFocus();
 447 }
 448
 449 // -----------------------------------------------------------------------
 450
 451 sal_Bool SpinButton::ImplMoveFocus( sal_Bool _bUpper )
 452 {
 453     if ( _bUpper == mbUpperIsFocused )
 454         return sal_False;
 455
 456     HideFocus();
 457     ImplCalcFocusRect( _bUpper );
 458     if ( HasFocus() )
 459         ShowFocus( maFocusRect );
 460     return sal_True;
 461 }
 462
 463 // -----------------------------------------------------------------------
 464
 465 void SpinButton::ImplCalcFocusRect( sal_Bool _bUpper )
 466 {
 467     maFocusRect = _bUpper ? maUpperRect : maLowerRect;
 468     // inflate by some pixels
 469     maFocusRect.Left() += 2;
 470     maFocusRect.Top() += 2;
 471     maFocusRect.Right() -= 2;
 472     maFocusRect.Bottom() -= 2;
 473     mbUpperIsFocused = _bUpper;
 474 }
 475
 476 // -----------------------------------------------------------------------
 477
 478 Rectangle* SpinButton::ImplFindPartRect( const Point& rPt )
 479 {
 480     if( maUpperRect.IsInside( rPt ) )
 481         return &maUpperRect;
 482     else if( maLowerRect.IsInside( rPt ) )
 483         return &maLowerRect;
 484     else
 485         return NULL;
 486 }
 487
 488 long SpinButton::PreNotify( NotifyEvent& rNEvt )
 489 {
 490     long nDone = 0;
 491     const MouseEvent* pMouseEvt = NULL;
 492
 493     if( (rNEvt.GetType() == EVENT_MOUSEMOVE) && (pMouseEvt = rNEvt.GetMouseEvent()) != NULL )
 494     {
 495         if( !pMouseEvt->GetButtons() && !pMouseEvt->IsSynthetic() && !pMouseEvt->IsModifierChanged() )
 496         {
 497             // trigger redraw if mouse over state has changed
 498             if( IsNativeControlSupported(CTRL_SPINBOX, PART_ENTIRE_CONTROL) ||
 499                 IsNativeControlSupported(CTRL_SPINBOX, PART_ALL_BUTTONS) )
 500             {
 501                 Rectangle* pRect = ImplFindPartRect( GetPointerPosPixel() );
 502                 Rectangle* pLastRect = ImplFindPartRect( GetLastPointerPosPixel() );
 503                 if( pRect != pLastRect || (pMouseEvt->IsLeaveWindow() || pMouseEvt->IsEnterWindow()) )
 504                 {
 505                     Region aRgn( GetActiveClipRegion() );
 506                     if( pLastRect )
 507                     {
 508                         SetClipRegion(Region(*pLastRect));
 509                         Paint( *pLastRect );
 510                         SetClipRegion( aRgn );
 511                     }
 512                     if( pRect )
 513                     {
 514                         SetClipRegion(Region(*pRect));
 515                         Paint( *pRect );
 516                         SetClipRegion( aRgn );
 517                     }
 518                 }
 519             }
 520         }
 521     }
 522
 523     return nDone ? nDone : Control::PreNotify(rNEvt);
 524 }
 525
 526 // -----------------------------------------------------------------------
 527
 528 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */