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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef SC_FIELDWND_HXX
#define SC_FIELDWND_HXX
#include <vector>
#include "address.hxx"
#include <vcl/ctrl.hxx>
#include <vcl/fixed.hxx>
#include <vcl/scrbar.hxx>
#include <cppuhelper/weakref.hxx>
class ScDPLayoutDlg;
class ScAccessibleDataPilotControl;
//===================================================================
/** Type of content area. */
enum ScDPFieldType
{
TYPE_PAGE, /// Area for all page fields.
TYPE_ROW, /// Area for all row fields.
TYPE_COL, /// Area for all column fields.
TYPE_DATA, /// Area for all data fields.
TYPE_SELECT /// Selection area with all fields.
};
//-------------------------------------------------------------------
/**
* Represents a field area in the DataPilot layout dialog. This base class
* handles storage of field names and the accessibility object.
*/
class ScDPFieldControlBase : public Control
{
protected:
struct FieldName
{
rtl::OUString maText;
bool mbFits;
sal_uInt8 mnDupCount;
FieldName(const rtl::OUString& rText, bool bFits, sal_uInt8 nDupCount = 0);
FieldName(const FieldName& r);
rtl::OUString getDisplayedText() const;
};
typedef ::std::vector<FieldName> FieldNames;
public:
/**
* Custom scroll bar to pass the command event to its parent window.
* We need this to pass the mouse wheel events to its parent field
* control to have mouse wheel events appaer to be properly handled by the
* scroll bar.
*/
class ScrollBar : public ::ScrollBar
{
public:
ScrollBar(Window* pParent, WinBits nStyle);
virtual void Command( const CommandEvent& rCEvt );
private:
Window* mpParent;
};
ScDPFieldControlBase(
ScDPLayoutDlg* pParent, const ResId& rResId, FixedText* pCaption );
virtual ~ScDPFieldControlBase();
virtual void CalcSize() = 0;
virtual bool IsValidIndex( size_t nIndex ) const = 0;
/** @return The pixel position of a field (without bound check). */
virtual Point GetFieldPosition( size_t nIndex ) = 0;
/** Calculates the field index at a specific pixel position.
@param rnIndex The index of the field is returned here.
@return TRUE, if the index value is valid. */
virtual bool GetFieldIndex( const Point& rPos, size_t& rnIndex ) = 0;
/** @return The pixel size of a field. */
virtual Size GetFieldSize() const = 0;
/** @return The description of the control which is used for the accessibility objects. */
virtual String GetDescription() const = 0;
/** @return The type of the FieldWindow. */
virtual ScDPFieldType GetFieldType() const = 0;
virtual void ScrollToShowSelection() = 0;
virtual void ScrollToEnd() = 0;
virtual void ResetScrollBar() = 0;
virtual void HandleWheelScroll(long nNotch) = 0;
/** Reads the FixedText's text with mnemonic and hides the FixedText. */
void UseMnemonic();
/** @return The name of the control without shortcut. */
::rtl::OUString GetName() const;
void SetName(const ::rtl::OUString& rName);
/** @return TRUE, if the field with the given index exists. */
bool IsExistingIndex( size_t nIndex ) const;
/** Inserts a field to the specified index. */
void AddField( const rtl::OUString& rText, size_t nNewIndex );
/** Inserts a field using the specified pixel position.
@param rPos The coordinates to insert the field.
@param rnIndex The new index of the field is returned here.
@return true, if the field has been created. */
bool AddField(const rtl::OUString& rText, const Point& rPos, size_t& rnIndex, sal_uInt8& rnDupCount);
bool MoveField(size_t nCurPos, const Point& rPos, size_t& rnIndex);
bool AppendField(const rtl::OUString& rText, size_t& rnIndex);
/** Removes a field from the specified index. */
void DelField( size_t nDelIndex );
/** @return The count of existing fields. */
size_t GetFieldCount() const;
bool IsEmpty() const;
/** Removes all fields. */
void ClearFields();
/** Changes the text on an existing field. */
void SetFieldText(const rtl::OUString& rText, size_t nIndex, sal_uInt8 nDupCount);
/** Returns the text of an existing field. */
rtl::OUString GetFieldText( size_t nIndex ) const;
/** Calculates a field index at a specific pixel position. Returns in every
case the index of an existing field.
@param rnIndex The index of the field is returned here.
@return TRUE, if the index value is valid. */
void GetExistingIndex( const Point& rPos, size_t& rnIndex );
size_t GetSelectedField() const;
/** Selects the next field. Called i.e. after moving a field from SELECT area. */
void SelectNext();
/** Grabs focus and sets new selection. */
void GrabFocusWithSel( size_t nIndex );
virtual void Paint( const Rectangle& rRect );
virtual void DataChanged( const DataChangedEvent& rDCEvt );
virtual void Command( const CommandEvent& rCEvt );
virtual void MouseButtonDown( const MouseEvent& rMEvt );
virtual void MouseButtonUp( const MouseEvent& rMEvt );
virtual void MouseMove( const MouseEvent& rMEvt );
virtual void KeyInput( const KeyEvent& rKEvt );
virtual void GetFocus();
virtual void LoseFocus();
protected:
FieldNames& GetFieldNames();
const FieldNames& GetFieldNames() const;
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible > CreateAccessible();
void FieldFocusChanged(size_t nOldSelected, size_t nFieldSelected);
void AccessibleSetFocus(bool bOn);
/** Updates the tab stop style bits. */
void UpdateStyle();
/** Draws the background. */
void DrawBackground( OutputDevice& rDev );
/** Draws a field into the specified rectangle. */
void DrawField(
OutputDevice& rDev, const Rectangle& rRect, FieldName& rText, bool bFocus );
void AppendPaintable(Window* p);
void DrawPaintables();
void DrawInvertSelection();
Size GetStdFieldBtnSize() const;
/** @return The new selection index after moving to the given direction. */
virtual size_t CalcNewFieldIndex( SCsCOL nDX, SCsROW nDY ) const = 0;
/**
* @param nIndex logical index of a field name, independent of scroll
* offsets.
* @return Display position of the button. The first displayed button is
* always 0 no matter what the current scroll offset is. In case
* the field specified by the index is outside the visible range,
* <code>INVALID_INDEX</code> is returned.
*/
virtual size_t GetDisplayPosition(size_t nIndex) const = 0;
/** Draws the complete control. */
virtual void Redraw() = 0;
private:
/** @return TRUE, if the field with the given index exists and the text is
too long for the button control. */
bool IsShortenedText( size_t nIndex ) const;
/** Moves the selected field to nDestIndex. */
void MoveField( size_t nDestIndex );
/** Moves the selected field to the given direction. */
void MoveFieldRel( SCsCOL nDX, SCsROW nDY );
/** Sets selection to the field with index nIndex. */
void SetSelection( size_t nIndex );
/** Sets selection to first field. */
void SetSelectionHome();
/** Sets selection to last field. */
void SetSelectionEnd();
/** Sets selection to new position relative to current. */
void MoveSelection( SCsCOL nDX, SCsROW nDY );
sal_uInt8 GetNextDupCount(const rtl::OUString& rFieldText) const;
private:
typedef ::std::vector<Window*> Paintables;
Paintables maPaintables;
FieldNames maFieldNames; /// String array of the field names and flags, if text fits into button.
ScDPLayoutDlg* mpDlg;
FixedText* mpCaption; /// FixedText containing the name of the control.
::rtl::OUString maName;
size_t mnFieldSelected; /// Currently selected field.
com::sun::star::uno::WeakReference< ::com::sun::star::accessibility::XAccessible > xAccessible;
ScAccessibleDataPilotControl* pAccessible;
};
// ============================================================================
/**
* Base class for field control with a horizontal scroll bar at the bottom.
* Page, column, data and select fields are derived from this class.
*/
class ScDPHorFieldControl : public ScDPFieldControlBase
{
protected:
virtual size_t CalcNewFieldIndex(SCsCOL nDX, SCsROW nDY) const;
virtual size_t GetDisplayPosition(size_t nIndex) const;
virtual void Redraw();
public:
ScDPHorFieldControl(
ScDPLayoutDlg* pDialog, const ResId& rResId, FixedText* pCaption );
virtual ~ScDPHorFieldControl();
virtual void CalcSize();
virtual bool IsValidIndex( size_t nIndex ) const;
virtual Point GetFieldPosition(size_t nIndex);
virtual Size GetFieldSize() const;
virtual bool GetFieldIndex( const Point& rPos, size_t& rnIndex );
virtual String GetDescription() const;
virtual void ScrollToEnd();
virtual void ScrollToShowSelection();
virtual void ResetScrollBar();
virtual void HandleWheelScroll(long nNotch);
private:
bool GetFieldBtnPosSize(size_t nPos, Point& rPos, Size& rSize);
void HandleScroll();
DECL_LINK(ScrollHdl, void*);
DECL_LINK(EndScrollHdl, void*);
private:
ScrollBar maScroll;
size_t mnFieldBtnRowCount;
size_t mnFieldBtnColCount;
};
// ============================================================================
class ScDPPageFieldControl : public ScDPHorFieldControl
{
public:
ScDPPageFieldControl(
ScDPLayoutDlg* pDialog, const ResId& rResId, FixedText* pCaption);
virtual ~ScDPPageFieldControl();
virtual ScDPFieldType GetFieldType() const;
virtual String GetDescription() const;
};
// ============================================================================
class ScDPColFieldControl : public ScDPHorFieldControl
{
public:
ScDPColFieldControl(
ScDPLayoutDlg* pDialog, const ResId& rResId, FixedText* pCaption);
virtual ~ScDPColFieldControl();
virtual ScDPFieldType GetFieldType() const;
virtual String GetDescription() const;
};
// ============================================================================
/**
* Row field control with a vertical scroll bar.
*/
class ScDPRowFieldControl : public ScDPFieldControlBase
{
public:
ScDPRowFieldControl(
ScDPLayoutDlg* pDialog, const ResId& rResId, FixedText* pCaption );
virtual ~ScDPRowFieldControl();
virtual void CalcSize();
virtual bool IsValidIndex( size_t nIndex ) const;
virtual Point GetFieldPosition( size_t nIndex );
virtual Size GetFieldSize() const;
virtual bool GetFieldIndex( const Point& rPos, size_t& rnIndex );
virtual String GetDescription() const;
virtual ScDPFieldType GetFieldType() const;
virtual void ScrollToEnd();
virtual void ScrollToShowSelection();
virtual void ResetScrollBar();
virtual void HandleWheelScroll(long nNotch);
protected:
virtual size_t CalcNewFieldIndex( SCsCOL nDX, SCsROW nDY ) const;
virtual size_t GetDisplayPosition(size_t nIndex) const;
virtual void Redraw();
private:
bool GetFieldBtnPosSize(size_t nPos, Point& rPos, Size& rSize);
void HandleScroll();
DECL_LINK(ScrollHdl, void*);
DECL_LINK(EndScrollHdl, void*);
private:
ScDPFieldControlBase::ScrollBar maScroll;
size_t mnColumnBtnCount;
};
// ============================================================================
class ScDPSelectFieldControl : public ScDPHorFieldControl
{
public:
ScDPSelectFieldControl(
ScDPLayoutDlg* pDialog, const ResId& rResId, FixedText* pCaption);
virtual ~ScDPSelectFieldControl();
virtual ScDPFieldType GetFieldType() const;
virtual String GetDescription() const;
};
// ============================================================================
class ScDPDataFieldControl : public ScDPHorFieldControl
{
public:
ScDPDataFieldControl( ScDPLayoutDlg* pParent, const ResId& rResId, FixedText* pCaption );
virtual ~ScDPDataFieldControl();
virtual ScDPFieldType GetFieldType() const;
virtual Size GetFieldSize() const;
virtual String GetDescription() const;
};
#endif // SC_FIELDWND_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|