LibreOffice Module vcl (master)  1
include/vcl/toolkit/spin.hxx
Go to the documentation of this file.
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) && !defined(VCL_INTERNALS)
24 #error "don't use this in new code"
25 #endif
26 
27 #include <config_options.h>
28 #include <vcl/dllapi.h>
29 #include <vcl/ctrl.hxx>
30 #include <vcl/timer.hxx>
31 
32 class UNLESS_MERGELIBS(VCL_DLLPUBLIC) SpinButton final : public Control
33 {
34 private:
35  AutoTimer maRepeatTimer;
36  tools::Rectangle maUpperRect;
37  tools::Rectangle maLowerRect;
38  tools::Rectangle maFocusRect;
39  bool mbRepeat : 1;
40  bool mbUpperIn : 1;
41  bool mbLowerIn : 1;
42  bool mbInitialUp : 1;
43  bool mbInitialDown : 1;
44  bool mbHorz : 1;
45  bool mbUpperIsFocused : 1;
46  long mnMinRange;
47  long mnMaxRange;
48  long mnValue;
49  long mnValueStep;
50 
51  SAL_DLLPRIVATE tools::Rectangle* ImplFindPartRect( const Point& rPt );
52  using Window::ImplInit;
53  SAL_DLLPRIVATE void ImplInit( vcl::Window* pParent, WinBits nStyle );
54  DECL_DLLPRIVATE_LINK( ImplTimeout, Timer*, void );
55 
56 public:
57  explicit SpinButton( vcl::Window* pParent, WinBits nStyle );
58 
59  void Up();
60  void Down();
61 
62  virtual void Resize() override;
63  virtual void Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
64  virtual void Draw( OutputDevice* pDev, const Point& rPos, const Size& rSize, DrawFlags nFlags ) override;
65  virtual void MouseButtonDown( const MouseEvent& rMEvt ) override;
66  virtual void MouseButtonUp( const MouseEvent& rMEvt ) override;
67  virtual void MouseMove( const MouseEvent& rMEvt ) override;
68  virtual void KeyInput( const KeyEvent& rKEvt ) override;
69  virtual void StateChanged( StateChangedType nStateChange ) override;
70  virtual void GetFocus() override;
71  virtual void LoseFocus() override;
72 
73  void SetRangeMin( long nNewRange );
74  long GetRangeMin() const { return mnMinRange; }
75  void SetRangeMax( long nNewRange );
76  long GetRangeMax() const { return mnMaxRange; }
77  void SetRange( const Range& rRange );
78  void SetValue( long nValue );
79  long GetValue() const { return mnValue; }
80  void SetValueStep( long nNewStep ) { mnValueStep = nNewStep; }
81  long GetValueStep() const { return mnValueStep; }
82  virtual bool PreNotify( NotifyEvent& rNEvt ) override;
83 
84 private:
85  // moves the focus to the upper or lower rect. Return sal_True if the focus rect actually changed.
86  SAL_DLLPRIVATE bool ImplMoveFocus( bool _bUpper );
87  SAL_DLLPRIVATE void ImplCalcFocusRect( bool _bUpper );
88 
89  SAL_DLLPRIVATE bool ImplIsUpperEnabled( ) const
90  {
91  return mnValue + mnValueStep <= mnMaxRange;
92  }
93  SAL_DLLPRIVATE bool ImplIsLowerEnabled( ) const
94  {
95  return mnValue >= mnMinRange + mnValueStep;
96  }
97 };
98 
99 #endif // INCLUDED_VCL_SPIN_HXX
100 
101 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
DECL_DLLPRIVATE_LINK(ImplHandlePaintHdl, Timer *, void)
virtual void MouseButtonDown(const MouseEvent &rMEvt)
Definition: mouse.cxx:414
std::string GetValue
virtual void StateChanged(StateChangedType nStateChange) override
Definition: ctrl.cxx:260
virtual void MouseButtonUp(const MouseEvent &rMEvt)
Definition: mouse.cxx:421
StateChangedType
Definition: window.hxx:311
sal_Int64 WinBits
virtual void Draw(::OutputDevice *pDev, const Point &rPos, const Size &rSize, DrawFlags nFlags)
Definition: window.cxx:1843
An auto-timer is a multi-shot timer re-emitting itself at interval until destroyed or stopped...
Definition: timer.hxx:72
virtual bool PreNotify(NotifyEvent &rNEvt)
Definition: event.cxx:51
DrawFlags
Definition: window.hxx:354
Some things multiple-inherit from VclAbstractDialog and OutputDevice, so we need to use virtual inher...
Definition: outdev.hxx:304
virtual void LoseFocus()
Definition: window.cxx:1869
virtual void KeyInput(const KeyEvent &rKEvt)
Definition: window.cxx:1819
SAL_DLLPRIVATE void ImplInit(vcl::Window *pParent, WinBits nStyle, SystemParentData *pSystemParentData)
Definition: window.cxx:932
virtual void Resize() override
Definition: ctrl.cxx:74
Definition: ctrl.hxx:33
virtual void GetFocus()
Definition: window.cxx:1855
virtual void Paint(vcl::RenderContext &rRenderContext, const tools::Rectangle &rRect)
Definition: paint.cxx:1017
virtual void MouseMove(const MouseEvent &rMEvt)
Definition: mouse.cxx:408
Definition: timer.hxx:26
const double mnValue