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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
|
/* -*- 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_SOURCE_INC_SVIMPBOX_HXX
#define INCLUDED_VCL_SOURCE_INC_SVIMPBOX_HXX
#include <vcl/seleng.hxx>
#include <vcl/idle.hxx>
#include <vcl/image.hxx>
#include <vcl/vclevent.hxx>
#include <vcl/toolkit/scrbar.hxx>
#include <vcl/toolkit/treelistbox.hxx>
#include <o3tl/enumarray.hxx>
#include <memory>
#include <vector>
class SvLBoxButton;
class SvTreeList;
class SvImpLBox;
class SvTreeListEntry;
namespace comphelper::string { class NaturalStringSorter; }
class ImpLBSelEng final : public FunctionSet
{
SvImpLBox* pImp;
VclPtr<SvTreeListBox> pView;
public:
ImpLBSelEng( SvImpLBox* pImp, SvTreeListBox* pView );
virtual ~ImpLBSelEng() override;
void BeginDrag() override;
void CreateAnchor() override;
void DestroyAnchor() override;
void SetCursorAtPoint( const Point& rPoint,
bool bDontSelectAtCursor=false ) override;
bool IsSelectionAtPoint( const Point& rPoint ) override;
void DeselectAtPoint( const Point& rPoint ) override;
void DeselectAll() override;
};
// Flags for nFlag
enum class LBoxFlags {
NONE = 0x0000,
DeselectAll = 0x0002,
StartEditTimer = 0x0004, // MAC only
IgnoreSelect = 0x0008,
InResize = 0x0010,
RemovedEntryInvisible = 0x0020,
RemovedRecalcMostRight = 0x0040,
IgnoreChangedTabs = 0x0080,
InPaint = 0x0100,
EndScrollSetVisSize = 0x0200,
Filling = 0x0400,
};
namespace o3tl
{
template<> struct typed_flags<LBoxFlags> : is_typed_flags<LBoxFlags, 0x07fe> {};
}
#define NODE_BMP_TABDIST_NOTVALID -2000000
#define FIRST_ENTRY_TAB 1
class SvImpLBox
{
friend class ImpLBSelEng;
friend class SvTreeListBox;
friend class SalInstanceTreeView;
friend class IconView;
private:
SvTreeList* m_pTree;
SvTreeListEntry* m_pAnchor;
SvTreeListEntry* m_pMostRightEntry;
SvLBoxButton* m_pActiveButton;
SvTreeListEntry* m_pActiveEntry;
SvLBoxTab* m_pActiveTab;
VclPtr<ScrollBarBox> m_aScrBarBox;
static Image* s_pDefCollapsed;
static Image* s_pDefExpanded;
static oslInterlockedCount s_nImageRefCount; /// When 0 all static images will be destroyed
// Node Bitmaps
enum class ImageType
{
NodeExpanded = 0, // node is expanded ( usually a bitmap showing a minus )
NodeCollapsed, // node is collapsed ( usually a bitmap showing a plus )
EntryDefExpanded, // default for expanded entries
EntryDefCollapsed, // default for collapsed entries
LAST = EntryDefCollapsed
};
// all our images
o3tl::enumarray<ImageType, Image>
m_aNodeAndEntryImages;
ImpLBSelEng m_aFctSet;
tools::Long m_nNodeBmpWidth;
tools::Long m_nMostRight;
short m_nHorSBarHeight, m_nVerSBarWidth;
bool m_bUpdateMode : 1;
bool m_bSubLstOpLR : 1; // open/close sublist with cursor left/right, defaulted with false
bool mbForceMakeVisible;
Point m_aEditClickPos;
Idle m_aEditIdle;
std::unique_ptr<comphelper::string::NaturalStringSorter> m_pStringSorter;
std::vector< short > m_aContextBmpWidthVector;
DECL_LINK(EditTimerCall, Timer *, void);
void InvalidateEntriesFrom( tools::Long nY ) const;
bool IsLineVisible( tools::Long nY ) const;
void KeyLeftRight( tools::Long nDiff );
void DrawNet(vcl::RenderContext& rRenderContext);
// ScrollBar-Handler
DECL_LINK( ScrollUpDownHdl, ScrollBar*, void );
DECL_LINK( ScrollLeftRightHdl, ScrollBar*, void );
DECL_LINK( EndScrollHdl, ScrollBar*, void );
void SetNodeBmpWidth( const Image& );
void SetNodeBmpTabDistance();
// Selection-Engine
SvTreeListEntry* MakePointVisible( const Point& rPoint );
void SetAnchorSelection( SvTreeListEntry* pOld,
SvTreeListEntry* pNewCursor );
void BeginDrag();
bool ButtonDownCheckCtrl( const MouseEvent& rMEvt, SvTreeListEntry* pEntry );
bool MouseMoveCheckCtrl( const MouseEvent& rMEvt, SvTreeListEntry const * pEntry );
bool ButtonUpCheckCtrl( const MouseEvent& rMEvt );
bool ButtonDownCheckExpand( const MouseEvent&, SvTreeListEntry* );
bool EntryReallyHit(SvTreeListEntry* pEntry, const Point& rPos, tools::Long nLine);
void InitScrollBarBox();
SvLBoxTab* NextTab( SvLBoxTab const * );
void SetMostRight( SvTreeListEntry* pEntry );
void FindMostRight( SvTreeListEntry* pParent );
void FindMostRight_Impl( SvTreeListEntry* pParent );
void NotifyTabsChanged();
// if element at cursor can be expanded in general
bool IsExpandable() const;
static void implInitDefaultNodeImages();
void UpdateStringSorter();
short UpdateContextBmpWidthVector( SvTreeListEntry const * pEntry, short nWidth );
void UpdateContextBmpWidthMax( SvTreeListEntry const * pEntry );
void UpdateContextBmpWidthVectorFromMovedEntry( SvTreeListEntry* pEntry );
void ExpandAll();
void CollapseTo(SvTreeListEntry* pParentToCollapse);
protected:
VclPtr<SvTreeListBox> m_pView;
VclPtr<ScrollBar> m_aHorSBar;
VclPtr<ScrollBar> m_aVerSBar;
SvTreeListEntry* m_pCursor;
SvTreeListEntry* m_pCursorOld;
SvTreeListEntry* m_pStartEntry;
ImplSVEvent* m_nCurUserEvent;
Size m_aOutputSize;
LBoxFlags m_nFlags;
WinBits m_nStyle;
bool mbNoAutoCurEntry; // disable the behavior of automatically selecting a "CurEntry" upon painting the control
SelectionEngine m_aSelEng;
sal_uLong m_nVisibleCount; // Number of lines in control
bool m_bInVScrollHdl : 1;
bool m_bSimpleTravel : 1; // is true if SelectionMode::Single
tools::Long m_nNextVerVisSize;
tools::Long m_nNodeBmpTabDistance; // typical smaller than 0
virtual tools::Long GetEntryLine(const SvTreeListEntry* pEntry) const;
virtual void CursorDown();
virtual void CursorUp();
virtual void PageDown( sal_uInt16 nDelta );
virtual void PageUp( sal_uInt16 nDelta );
// set Thumb to FirstEntryToDraw
virtual void SyncVerThumb();
virtual void AdjustScrollBars( Size& rSize );
virtual void InvalidateEntry( tools::Long nY ) const;
tools::Rectangle GetVisibleArea() const;
void SetCursor( SvTreeListEntry* pEntry, bool bForceNoSelect = false );
void PositionScrollBars( Size& rOSize, sal_uInt16 nMask );
void FindMostRight();
void FillView();
void ShowVerSBar();
void StopUserEvent();
DECL_LINK( MyUserEvent, void*, void);
public:
SvImpLBox( SvTreeListBox* pView, SvTreeList*, WinBits nWinStyle );
virtual ~SvImpLBox();
void Clear();
void SetStyle( WinBits i_nWinStyle );
void SetNoAutoCurEntry( bool b );
void SetModel( SvTreeList* pModel ) { m_pTree = pModel;}
void EntryInserted( SvTreeListEntry*);
void RemovingEntry( SvTreeListEntry* pEntry );
void EntryRemoved();
void MovingEntry( SvTreeListEntry* pEntry );
void EntryMoved( SvTreeListEntry* pEntry );
void TreeInserted( SvTreeListEntry* pEntry );
void EntryExpanded( SvTreeListEntry* pEntry );
void EntryCollapsed( SvTreeListEntry* pEntry );
void CollapsingEntry( SvTreeListEntry* pEntry );
void EntrySelected( SvTreeListEntry* pEntry, bool bSelect );
virtual void Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect);
void MouseButtonDown( const MouseEvent& );
void MouseButtonUp( const MouseEvent& );
void MouseMove( const MouseEvent&);
virtual bool KeyInput( const KeyEvent& );
void Resize();
void GetFocus();
void LoseFocus();
virtual void UpdateAll();
void SetEntryHeight();
void InvalidateEntry( SvTreeListEntry* );
void RecalcFocusRect();
void SelectEntry( SvTreeListEntry* pEntry, bool bSelect );
void SetDragDropMode( DragDropMode eDDMode );
void SetSelectionMode( SelectionMode eSelMode );
virtual bool IsEntryInView( SvTreeListEntry* pEntry ) const;
virtual SvTreeListEntry* GetEntry( const Point& rPos ) const;
// returns last entry, if Pos below last entry
virtual SvTreeListEntry* GetClickedEntry( const Point& ) const;
SvTreeListEntry* GetCurEntry() const { return m_pCursor; }
void SetCurEntry( SvTreeListEntry* );
virtual Point GetEntryPosition(const SvTreeListEntry*) const;
void MakeVisible( SvTreeListEntry* pEntry, bool bMoveToTop = false );
void ScrollToAbsPos( tools::Long nPos );
void PaintDDCursor(SvTreeListEntry* pEntry, bool bShow);
// Images
inline Image& implGetImageLocation( const ImageType _eType );
inline void SetExpandedNodeBmp( const Image& _rImg );
inline void SetCollapsedNodeBmp( const Image& _rImg );
inline const Image& GetExpandedNodeBmp( );
inline const Image& GetCollapsedNodeBmp( );
inline void SetDefaultEntryExpBmp( const Image& _rImg );
inline void SetDefaultEntryColBmp( const Image& _rImg );
inline const Image& GetDefaultEntryExpBmp( );
inline const Image& GetDefaultEntryColBmp( );
static const Image& GetDefaultExpandedNodeImage( );
static const Image& GetDefaultCollapsedNodeImage( );
const Size& GetOutputSize() const { return m_aOutputSize;}
virtual void KeyUp( bool bPageUp );
virtual void KeyDown( bool bPageDown );
void Command( const CommandEvent& rCEvt );
void Invalidate();
void DestroyAnchor() { m_pAnchor=nullptr; m_aSelEng.Reset(); }
void SelAllDestrAnch( bool bSelect, bool bDestroyAnchor = true, bool bSingleSelToo = false );
void ShowCursor( bool bShow );
bool RequestHelp( const HelpEvent& rHEvt );
bool IsNodeButton( const Point& rPosPixel, const SvTreeListEntry* pEntry ) const;
void SetUpdateMode( bool bMode );
bool GetUpdateMode() const { return m_bUpdateMode; }
tools::Rectangle GetClipRegionRect() const;
bool HasHorScrollBar() const { return m_aHorSBar->IsVisible(); }
void CallEventListeners( VclEventId nEvent, void* pData = nullptr );
bool IsSelectable( const SvTreeListEntry* pEntry ) const;
void SetForceMakeVisible(bool bEnable) { mbForceMakeVisible = bEnable; }
// tdf#143114 allow to ask if CaptureOnButton is active
// (MouseButtonDown hit on SvLBoxButton, CaptureMouse() active)
bool IsCaptureOnButtonActive() const;
};
inline bool SvImpLBox::IsCaptureOnButtonActive() const
{
return nullptr != m_pActiveButton && nullptr != m_pActiveEntry;
}
inline Image& SvImpLBox::implGetImageLocation( const ImageType _eType )
{
return m_aNodeAndEntryImages[_eType];
}
inline void SvImpLBox::SetExpandedNodeBmp( const Image& rImg )
{
implGetImageLocation( ImageType::NodeExpanded ) = rImg;
SetNodeBmpWidth( rImg );
}
inline void SvImpLBox::SetCollapsedNodeBmp( const Image& rImg )
{
implGetImageLocation( ImageType::NodeCollapsed ) = rImg;
SetNodeBmpWidth( rImg );
}
inline const Image& SvImpLBox::GetExpandedNodeBmp( )
{
return implGetImageLocation( ImageType::NodeExpanded );
}
inline const Image& SvImpLBox::GetCollapsedNodeBmp( )
{
return implGetImageLocation( ImageType::NodeCollapsed );
}
inline void SvImpLBox::SetDefaultEntryExpBmp( const Image& _rImg )
{
implGetImageLocation( ImageType::EntryDefExpanded ) = _rImg;
}
inline void SvImpLBox::SetDefaultEntryColBmp( const Image& _rImg )
{
implGetImageLocation( ImageType::EntryDefCollapsed ) = _rImg;
}
inline const Image& SvImpLBox::GetDefaultEntryExpBmp( )
{
return implGetImageLocation( ImageType::EntryDefExpanded );
}
inline const Image& SvImpLBox::GetDefaultEntryColBmp( )
{
return implGetImageLocation( ImageType::EntryDefCollapsed );
}
inline Point SvImpLBox::GetEntryPosition(const SvTreeListEntry* pEntry) const
{
return Point(0, GetEntryLine(pEntry));
}
inline bool SvImpLBox::IsLineVisible( tools::Long nY ) const
{
bool bRet = true;
if ( nY < 0 || nY >= m_aOutputSize.Height() )
bRet = false;
return bRet;
}
inline void SvImpLBox::TreeInserted( SvTreeListEntry* pInsTree )
{
EntryInserted( pInsTree );
}
#endif // INCLUDED_VCL_SOURCE_INC_SVIMPBOX_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
