include/vcl/toolkit/spin.hxx

   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 #ifndef INCLUDED_VCL_SPIN_HXX
  21 #define INCLUDED_VCL_SPIN_HXX
  22
  23 #if !defined(VCL_DLLIMPLEMENTATION) && !defined(TOOLKIT_DLLIMPLEMENTATION)
  24 #error "don't use this in new code"
  25 #endif
  26
  27 #include <vcl/dllapi.h>
  28 #include <vcl/ctrl.hxx>
  29 #include <vcl/timer.hxx>
  30
  31 class VCL_DLLPUBLIC SpinButton : public Control
  32 {
  33 private:
  34     AutoTimer       maRepeatTimer;
  35     tools::Rectangle       maUpperRect;
  36     tools::Rectangle       maLowerRect;
  37     tools::Rectangle       maFocusRect;
  38     bool            mbRepeat         : 1;
  39     bool            mbUpperIn        : 1;
  40     bool            mbLowerIn        : 1;
  41     bool            mbInitialUp      : 1;
  42     bool            mbInitialDown    : 1;
  43     bool            mbHorz           : 1;
  44     bool            mbUpperIsFocused : 1;
  45     long            mnMinRange;
  46     long            mnMaxRange;
  47     long            mnValue;
  48     long            mnValueStep;
  49
  50     SAL_DLLPRIVATE tools::Rectangle* ImplFindPartRect( const Point& rPt );
  51     using Window::ImplInit;
  52     SAL_DLLPRIVATE void       ImplInit( vcl::Window* pParent, WinBits nStyle );
  53     DECL_DLLPRIVATE_LINK( ImplTimeout, Timer*, void );
  54
  55 public:
  56     explicit        SpinButton( vcl::Window* pParent, WinBits nStyle );
  57
  58     void            Up();
  59     void            Down();
  60
  61     virtual void    Resize() override;
  62     virtual void    Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
  63     virtual void    Draw( OutputDevice* pDev, const Point& rPos, const Size& rSize, DrawFlags nFlags ) override;
  64     virtual void    MouseButtonDown( const MouseEvent& rMEvt ) override;
  65     virtual void    MouseButtonUp( const MouseEvent& rMEvt ) override;
  66     virtual void    MouseMove( const MouseEvent& rMEvt ) override;
  67     virtual void    KeyInput( const KeyEvent& rKEvt ) override;
  68     virtual void    StateChanged( StateChangedType nStateChange ) override;
  69     virtual void    GetFocus() override;
  70     virtual void    LoseFocus() override;
  71
  72     void            SetRangeMin( long nNewRange );
  73     long            GetRangeMin() const { return mnMinRange; }
  74     void            SetRangeMax( long nNewRange );
  75     long            GetRangeMax() const { return mnMaxRange; }
  76     void            SetRange( const Range& rRange );
  77     void            SetValue( long nValue );
  78     long            GetValue() const { return mnValue; }
  79     void            SetValueStep( long nNewStep ) { mnValueStep = nNewStep; }
  80     long            GetValueStep() const { return mnValueStep; }
  81     virtual bool    PreNotify( NotifyEvent& rNEvt ) override;
  82
  83 private:
  84     // moves the focus to the upper or lower rect. Return sal_True if the focus rect actually changed.
  85     SAL_DLLPRIVATE bool        ImplMoveFocus( bool _bUpper );
  86     SAL_DLLPRIVATE void        ImplCalcFocusRect( bool _bUpper );
  87
  88     SAL_DLLPRIVATE bool ImplIsUpperEnabled( ) const
  89     {
  90         return mnValue + mnValueStep <= mnMaxRange;
  91     }
  92     SAL_DLLPRIVATE bool ImplIsLowerEnabled( ) const
  93     {
  94         return mnValue >= mnMinRange + mnValueStep;
  95     }
  96 };
  97
  98 #endif // INCLUDED_VCL_SPIN_HXX
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */