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#pragma once
21
22#if !defined(VCL_DLLIMPLEMENTATION) && !defined(TOOLKIT_DLLIMPLEMENTATION) && !defined(VCL_INTERNALS)
23#error "don't use this in new code"
24#endif
25
26#include <config_options.h>
27#include <vcl/dllapi.h>
28#include <vcl/ctrl.hxx>
29#include <vcl/timer.hxx>
30
31class UNLESS_MERGELIBS(VCL_DLLPUBLIC) SpinButton final : public Control
32{
33private:
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 tools::Long mnMinRange;
46 tools::Long mnMaxRange;
48 tools::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
55public:
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, SystemTextColorFlags 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( tools::Long nNewRange );
73 tools::Long GetRangeMin() const { return mnMinRange; }
74 void SetRangeMax( tools::Long nNewRange );
75 tools::Long GetRangeMax() const { return mnMaxRange; }
76 void SetRange( const Range& rRange );
77 void SetValue( tools::Long nValue );
78 tools::Long GetValue() const { return mnValue; }
79 void SetValueStep( tools::Long nNewStep ) { mnValueStep = nNewStep; }
80 tools::Long GetValueStep() const { return mnValueStep; }
81 virtual bool PreNotify( NotifyEvent& rNEvt ) override;
82
83private:
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/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
SystemTextColorFlags
An auto-timer is a multi-shot timer re-emitting itself at interval until destroyed or stopped.
Definition: timer.hxx:67
Definition: ctrl.hxx:82
virtual void StateChanged(StateChangedType nStateChange) override
Definition: ctrl.cxx:257
virtual void Resize() override
Definition: ctrl.cxx:75
Some things multiple-inherit from VclAbstractDialog and OutputDevice, so we need to use virtual inher...
Definition: outdev.hxx:171
Definition: timer.hxx:27
virtual void GetFocus()
Definition: window.cxx:1843
virtual void MouseButtonDown(const MouseEvent &rMEvt)
Definition: mouse.cxx:420
virtual void MouseButtonUp(const MouseEvent &rMEvt)
Definition: mouse.cxx:427
virtual void KeyInput(const KeyEvent &rKEvt)
Definition: window.cxx:1807
virtual void Paint(vcl::RenderContext &rRenderContext, const tools::Rectangle &rRect)
Definition: paint.cxx:1020
virtual bool PreNotify(NotifyEvent &rNEvt)
Definition: event.cxx:52
virtual void MouseMove(const MouseEvent &rMEvt)
Definition: mouse.cxx:414
virtual void Draw(::OutputDevice *pDev, const Point &rPos, SystemTextColorFlags nFlags)
Definition: window.cxx:1831
virtual void LoseFocus()
Definition: window.cxx:1857
SAL_DLLPRIVATE void ImplInit(vcl::Window *pParent, WinBits nStyle, SystemParentData *pSystemParentData)
Definition: window.cxx:940
DECL_DLLPRIVATE_LINK(ImplHandlePaintHdl, Timer *, void)
virtual void SetValue(tools::Long nNew) override
long Long
const char GetValue[]
const double mnValue
StateChangedType
Definition: window.hxx:291
sal_Int64 WinBits
Definition: wintypes.hxx:109