1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_VCL_SELENG_HXX
#define INCLUDED_VCL_SELENG_HXX
#include <vcl/dllapi.h>
#include <vcl/timer.hxx>
#include <vcl/event.hxx>
#include <vcl/vclenum.hxx>
#include <o3tl/typed_flags_set.hxx>
class CommandEvent;
namespace vcl {
class Window;
}
// Timerticks
#define SELENG_DRAGDROP_TIMEOUT 400
#define SELENG_AUTOREPEAT_INTERVAL 50
#define SELENG_AUTOREPEAT_INTERVAL_MIN 25
#define SELENG_AUTOREPEAT_INTERVAL_MAX 300
class VCL_DLLPUBLIC FunctionSet
{
public:
virtual ~FunctionSet() = 0;
virtual void BeginDrag() = 0;
virtual void CreateAnchor() = 0; // Anker-Pos := Cursor-Pos
virtual void DestroyAnchor() = 0;
// move cursor, at the same time match cursor position to the selection
// starting at anchor. true == Ok
virtual void SetCursorAtPoint( const Point& rPointPixel,
bool bDontSelectAtCursor = false ) = 0;
virtual bool IsSelectionAtPoint( const Point& rPointPixel ) = 0;
virtual void DeselectAtPoint( const Point& rPointPixel ) = 0;
// delete anchor & deselect all
virtual void DeselectAll() = 0;
};
enum class SelectionEngineFlags {
DRG_ENAB = 0x0001,
IN_SEL = 0x0002,
IN_ADD = 0x0004,
ADD_ALW = 0x0008,
HAS_ANCH = 0x0020,
CMDEVT = 0x0040,
WAIT_UPEVT = 0x0080,
EXPANDONMOVE = 0x0100,
};
namespace o3tl
{
template<> struct typed_flags<SelectionEngineFlags> : is_typed_flags<SelectionEngineFlags, 0x01ef> {};
}
class VCL_DLLPUBLIC SelectionEngine
{
private:
FunctionSet* pFunctionSet;
VclPtr<vcl::Window> pWin;
tools::Rectangle aArea;
Timer aWTimer; // generate fake mouse moves
MouseEvent aLastMove;
SelectionMode eSelMode;
sal_uLong nUpdateInterval;
sal_uInt16 nLockedMods;
SelectionEngineFlags nFlags;
DECL_DLLPRIVATE_LINK( ImpWatchDog, Timer*, void );
inline bool ShouldDeselect( bool bModifierKey1 ) const;
// determines to deselect or not when Ctrl-key is pressed on CursorPosChanging
public:
SelectionEngine( vcl::Window* pWindow,
FunctionSet* pFunctions = nullptr );
~SelectionEngine();
// Avoid implicitly defined copy constructors/assignments for the
// DLLPUBLIC class (they may require forward-declared classes used
// internally to be defined in places using SelectionEngine)
SelectionEngine(const SelectionEngine&) = delete;
SelectionEngine(SelectionEngine&&) = delete;
SelectionEngine& operator=(const SelectionEngine&) = delete;
SelectionEngine& operator=(SelectionEngine&&) = delete;
// true: Event was processed by Selection Engine
bool SelMouseButtonDown( const MouseEvent& rMEvt );
bool SelMouseButtonUp( const MouseEvent& rMEvt );
bool SelMouseMove( const MouseEvent& rMEvt );
//SelMouseButtonDown captures mouse events, SelMouseButtonUp
//releases the capture. If you need to release the mouse
//capture after SelMouseButtonDown but before
//SelMouseButtonUp, e.g. to allow events to go to a
//context menu via "Command" which is delivered after
//mouse down but before mouse up, then use this
void ReleaseMouse();
void CaptureMouse();
// Keyboard
void CursorPosChanging( bool bShift, bool bMod1 );
// is needed to generate a Move event via a Timer
// when the mouse is outside the area
void SetVisibleArea( const tools::Rectangle& rNewArea )
{ aArea = rNewArea; }
void SetAddMode( bool);
bool IsAddMode() const;
void AddAlways( bool bOn );
bool IsAlwaysAdding() const;
void EnableDrag( bool bOn );
void SetSelectionMode( SelectionMode eMode );
SelectionMode GetSelectionMode() const { return eSelMode; }
void SetFunctionSet( FunctionSet* pFuncs )
{ pFunctionSet = pFuncs; }
const FunctionSet* GetFunctionSet() const { return pFunctionSet; }
const Point& GetMousePosPixel() const
{ return aLastMove.GetPosPixel(); }
const MouseEvent& GetMouseEvent() const { return aLastMove; }
void SetWindow( vcl::Window*);
vcl::Window* GetWindow() const { return pWin; }
void LockModifiers( sal_uInt16 nModifiers )
{ nLockedMods = nModifiers; }
sal_uInt16 GetLockedModifiers() const { return nLockedMods; }
bool IsInSelection() const;
void Reset();
bool Command(const CommandEvent& rCEvt);
bool HasAnchor() const;
void SetAnchor( bool bAnchor );
void SetUpdateInterval( sal_uLong nInterval );
// is switched on in the Ctor
void ExpandSelectionOnMouseMove( bool bExpand = true )
{
if( bExpand )
nFlags |= SelectionEngineFlags::EXPANDONMOVE;
else
nFlags &= ~SelectionEngineFlags::EXPANDONMOVE;
}
};
inline bool SelectionEngine::IsAddMode() const
{
if ( nFlags & (SelectionEngineFlags::IN_ADD | SelectionEngineFlags::ADD_ALW) )
return true;
else
return false;
}
inline void SelectionEngine::SetAddMode( bool bNewMode )
{
if ( bNewMode )
nFlags |= SelectionEngineFlags::IN_ADD;
else
nFlags &= ~SelectionEngineFlags::IN_ADD;
}
inline void SelectionEngine::EnableDrag( bool bOn )
{
if ( bOn )
nFlags |= SelectionEngineFlags::DRG_ENAB;
else
nFlags &= ~SelectionEngineFlags::DRG_ENAB;
}
inline void SelectionEngine::AddAlways( bool bOn )
{
if( bOn )
nFlags |= SelectionEngineFlags::ADD_ALW;
else
nFlags &= ~SelectionEngineFlags::ADD_ALW;
}
inline bool SelectionEngine::IsAlwaysAdding() const
{
if ( nFlags & SelectionEngineFlags::ADD_ALW )
return true;
else
return false;
}
inline bool SelectionEngine::IsInSelection() const
{
if ( nFlags & SelectionEngineFlags::IN_SEL )
return true;
else
return false;
}
inline bool SelectionEngine::HasAnchor() const
{
if ( nFlags & SelectionEngineFlags::HAS_ANCH )
return true;
else
return false;
}
inline void SelectionEngine::SetAnchor( bool bAnchor )
{
if ( bAnchor )
nFlags |= SelectionEngineFlags::HAS_ANCH;
else
nFlags &= ~SelectionEngineFlags::HAS_ANCH;
}
#endif // INCLUDED_VCL_SELENG_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
