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
|
/* -*- 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 .
*/
#pragma once
#if !defined(VCL_DLLIMPLEMENTATION) && !defined(TOOLKIT_DLLIMPLEMENTATION) && !defined(VCL_INTERNALS)
#error "don't use this in new code"
#endif
#include <memory>
#include <vcl/dllapi.h>
#include <vcl/ctrl.hxx>
#include <tools/link.hxx>
#include <vcl/image.hxx>
#include <o3tl/deleter.hxx>
#include <o3tl/typed_flags_set.hxx>
class SvxIconChoiceCtrl_Impl;
enum class SvxIconViewFlags
{
NONE = 0x0000,
POS_LOCKED = 0x0001,
SELECTED = 0x0002,
FOCUSED = 0x0004,
POS_MOVED = 0x0008, // Moved by Drag and Drop, but not logged
};
namespace o3tl
{
template<> struct typed_flags<SvxIconViewFlags> : is_typed_flags<SvxIconViewFlags, 0x000f> {};
}
enum class SvxIconChoiceCtrlTextMode
{
Full = 1, // Enlarge BoundRect southwards
Short // Shorten with "..."
};
enum class SvxIconChoiceCtrlPositionMode
{
Free, // Free pixel-perfect positioning
AutoArrange, // Auto arrange
};
class SvxIconChoiceCtrlEntry
{
Image aImage;
OUString aText;
OUString aQuickHelpText;
friend class SvxIconChoiceCtrl_Impl;
friend class IcnCursor_Impl;
friend class EntryList_Impl;
friend class IcnGridMap_Impl;
tools::Rectangle aRect; // Bounding-Rectangle of the entry
tools::Rectangle aGridRect; // Only valid in Grid-mode
sal_Int32 nPos;
/*
The insert position in the Insertlist is equal to the (sort) order stated at the Insert
(-> Order of the anchors in the anchors-list!). In "AutoArrange" mode the visible order
can differ. The entries will be linked because of this.
*/
SvxIconChoiceCtrlEntry* pblink; // backward (linker neighbour)
SvxIconChoiceCtrlEntry* pflink; // forward (rechter neighbour)
SvxIconChoiceCtrlTextMode eTextMode;
sal_uInt16 nX,nY; // for keyboard control
SvxIconViewFlags nFlags;
void ClearFlags( SvxIconViewFlags nMask ) { nFlags &= ~nMask; }
void SetFlags( SvxIconViewFlags nMask ) { nFlags |= nMask; }
void AssignFlags( SvxIconViewFlags _nFlags ) { nFlags = _nFlags; }
// set left neighbour (A <-> B ==> A <-> this <-> B)
void SetBacklink( SvxIconChoiceCtrlEntry* pA )
{
pA->pflink->pblink = this; // X <- B
this->pflink = pA->pflink; // X -> B
this->pblink = pA; // A <- X
pA->pflink = this; // A -> X
}
// Unlink (A <-> this <-> B ==> A <-> B)
void Unlink()
{
this->pblink->pflink = this->pflink;
this->pflink->pblink = this->pblink;
this->pflink = nullptr;
this->pblink = nullptr;
}
public:
SvxIconChoiceCtrlEntry( OUString aText, Image aImage );
const Image& GetImage () const { return aImage; }
void SetText ( const OUString& rText ) { aText = rText; }
const OUString& GetText () const { return aText; }
OUString VCL_DLLPUBLIC GetDisplayText() const;
void SetQuickHelpText( const OUString& rText ) { aQuickHelpText = rText; }
const OUString& GetQuickHelpText() const { return aQuickHelpText; }
SvxIconChoiceCtrlTextMode GetTextMode() const { return eTextMode; }
SvxIconViewFlags GetFlags() const { return nFlags; }
bool IsSelected() const { return bool(nFlags & SvxIconViewFlags::SELECTED); }
bool IsFocused() const { return bool(nFlags & SvxIconViewFlags::FOCUSED); }
bool IsPosLocked() const { return bool(nFlags & SvxIconViewFlags::POS_LOCKED); }
};
class SvxIconChoiceCtrlColumnInfo
{
tools::Long nWidth;
public:
SvxIconChoiceCtrlColumnInfo() :
nWidth( 100 ) {}
SvxIconChoiceCtrlColumnInfo( const SvxIconChoiceCtrlColumnInfo& );
void SetWidth( tools::Long nWd ) { nWidth = nWd; }
tools::Long GetWidth() const { return nWidth; }
};
/*
Window-Bits:
WB_ICON // Text beneath the icon
WB_SMALL_ICON // Text right to the icon, position does not mind
WB_DETAILS // Text right to the icon, limited positioning
WB_BORDER
WB_NOHIDESELECTION // Draw selection inactively, if not focused.
WB_NOHSCROLL
WB_NOVSCROLL
WB_NOSELECTION
WB_SMART_ARRANGE // Keep Visible-Area at arrange
WB_ALIGN_TOP // Align line vy line LTR
WB_ALIGN_LEFT // Align columns from top to bottom
WB_NODRAGSELECTION // No selection with tracking rectangle
WB_NOCOLUMNHEADER // No Headerbar in Details view (Headerbar not implemented)
WB_NOPOINTERFOCUS // No GrabFocus at MouseButtonDown
WB_HIGHLIGHTFRAME // The entry beneath the mouse will be highlighted
WB_NOASYNCSELECTHDL // Do not collect events -> Selection handlers will be called synchronously
*/
#define WB_ICON WB_RECTSTYLE
#define WB_SMALLICON WB_SMALLSTYLE
#define WB_DETAILS WB_VCENTER
#define WB_NOHSCROLL WB_SPIN
#define WB_NOVSCROLL WB_DRAG
#define WB_NOSELECTION WB_REPEAT
#define WB_NODRAGSELECTION WB_PATHELLIPSIS
#define WB_SMART_ARRANGE 0x01000000 // used to be WB_PASSWORD
#define WB_ALIGN_TOP WB_TOP
#define WB_ALIGN_LEFT WB_LEFT
#define WB_NOCOLUMNHEADER WB_CENTER
#define WB_HIGHLIGHTFRAME WB_IGNORETAB
#define WB_NOASYNCSELECTHDL WB_NOLABEL
class MnemonicGenerator;
class VCL_DLLPUBLIC SvtIconChoiceCtrl final : public Control
{
friend class SvxIconChoiceCtrl_Impl;
Link<SvtIconChoiceCtrl*,void> _aClickIconHdl;
std::unique_ptr<SvxIconChoiceCtrl_Impl, o3tl::default_delete<SvxIconChoiceCtrl_Impl>> _pImpl;
virtual void KeyInput( const KeyEvent& rKEvt ) override;
virtual void Command( const CommandEvent& rCEvt ) override;
virtual void Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
virtual void MouseButtonDown( const MouseEvent& rMEvt ) override;
virtual void MouseButtonUp( const MouseEvent& rMEvt ) override;
virtual void MouseMove( const MouseEvent& rMEvt ) override;
virtual void Resize() override;
virtual void GetFocus() override;
virtual void LoseFocus() override;
void ClickIcon();
virtual void DataChanged( const DataChangedEvent& rDCEvt ) override;
virtual void RequestHelp( const HelpEvent& rHEvt ) override;
static void DrawEntryImage(
SvxIconChoiceCtrlEntry const * pEntry,
const Point& rPos,
OutputDevice& rDev );
static OUString GetEntryText( SvxIconChoiceCtrlEntry const * pEntry );
virtual void FillLayoutData() const override;
void CallImplEventListeners(VclEventId nEvent, void* pData);
public:
SvtIconChoiceCtrl( vcl::Window* pParent, WinBits nWinStyle );
virtual ~SvtIconChoiceCtrl() override;
virtual void dispose() override;
WinBits GetStyle() const;
void SetSelectionMode(SelectionMode eMode);
void SetFont( const vcl::Font& rFont );
void SetPointFont( const vcl::Font& rFont );
void SetClickHdl( const Link<SvtIconChoiceCtrl*,void>& rLink ) { _aClickIconHdl = rLink; }
using Window::SetBackground;
void SetBackground( const Wallpaper& rWallpaper );
void ArrangeIcons();
SvxIconChoiceCtrlEntry* InsertEntry( const OUString& rText,
const Image& rImage);
void RemoveEntry(sal_Int32 nEntryListPos);
bool DoKeyInput( const KeyEvent& rKEvt );
sal_Int32 GetEntryCount() const;
SvxIconChoiceCtrlEntry* GetEntry( sal_Int32 nPos ) const;
sal_Int32 GetEntryListPos( SvxIconChoiceCtrlEntry const * pEntry ) const;
using Window::SetCursor;
void SetCursor( SvxIconChoiceCtrlEntry* pEntry );
SvxIconChoiceCtrlEntry* GetCursor() const;
// sal_uLong is the position of the selected element in the list
SvxIconChoiceCtrlEntry* GetSelectedEntry() const;
#ifdef DBG_UTIL
void SetEntryTextMode( SvxIconChoiceCtrlTextMode eMode, SvxIconChoiceCtrlEntry* pEntry );
#endif
tools::Rectangle GetBoundingBox( SvxIconChoiceCtrlEntry* pEntry ) const;
tools::Rectangle GetEntryCharacterBounds( const sal_Int32 _nEntryPos, const sal_Int32 _nCharacterIndex ) const;
void SetNoSelection();
// ACCESSIBILITY ==========================================================
/** Creates and returns the accessible object of the Box. */
virtual css::uno::Reference< css::accessibility::XAccessible > CreateAccessible() override;
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
