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
|
/* -*- 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 SVX_SOURCE_INC_FMCONTROLBORDERMANAGER_HXX
#define SVX_SOURCE_INC_FMCONTROLBORDERMANAGER_HXX
/** === begin UNO includes === **/
#include <com/sun/star/awt/VisualEffect.hpp>
#include <com/sun/star/awt/FontUnderline.hpp>
#include <com/sun/star/awt/XControl.hpp>
#include <com/sun/star/awt/XVclWindowPeer.hpp>
/** === end UNO includes === **/
#include <comphelper/stl_types.hxx>
#include <comphelper/stl_types.hxx>
#include <set>
namespace com { namespace sun { namespace star { namespace form { namespace validation {
class XValidatableFormComponent;
} } } } }
//........................................................................
namespace svxform
{
//........................................................................
typedef sal_Int16 ControlStatus;
#define CONTROL_STATUS_NONE 0x00
#define CONTROL_STATUS_FOCUSED 0x01
#define CONTROL_STATUS_MOUSE_HOVER 0x02
#define CONTROL_STATUS_INVALID 0x04
//====================================================================
//= BorderDescriptor
//====================================================================
struct BorderDescriptor
{
sal_Int16 nBorderType;
sal_Int32 nBorderColor;
BorderDescriptor()
:nBorderType( ::com::sun::star::awt::VisualEffect::FLAT )
,nBorderColor( 0x00000000 )
{
}
inline void clear()
{
nBorderType = ::com::sun::star::awt::VisualEffect::FLAT;
nBorderColor = 0x00000000;
}
};
//====================================================================
//= UnderlineDescriptor
//====================================================================
struct UnderlineDescriptor
{
sal_Int16 nUnderlineType;
sal_Int32 nUnderlineColor;
UnderlineDescriptor()
:nUnderlineType( ::com::sun::star::awt::FontUnderline::NONE )
,nUnderlineColor( 0x00000000 )
{
}
UnderlineDescriptor( sal_Int16 _nUnderlineType, sal_Int32 _nUnderlineColor )
:nUnderlineType( _nUnderlineType )
,nUnderlineColor( _nUnderlineColor )
{
}
inline void clear()
{
nUnderlineType = ::com::sun::star::awt::FontUnderline::NONE;
nUnderlineColor = 0x00000000;
}
};
//====================================================================
//= ControlData
//====================================================================
struct ControlData : public BorderDescriptor, UnderlineDescriptor
{
::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl > xControl;
::rtl::OUString sOriginalHelpText;
ControlData() : BorderDescriptor() { }
ControlData( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl >& _rxControl )
:xControl( _rxControl )
{
}
void clear()
{
BorderDescriptor::clear();
UnderlineDescriptor::clear();
xControl.clear();
sOriginalHelpText = ::rtl::OUString();
}
};
//====================================================================
//= ControlBorderManager
//====================================================================
/** manages the dynamic border color for form controls
Used by the <type>FormController</type>, this class manages the dynamic changes in the
border color of form controls. For this a set of events have to be forwarded to the manager
instance, which then will switch the border color depending on the mouse and focus status
of the controls.
*/
class ControlBorderManager
{
private:
struct ControlDataCompare : public ::std::binary_function< ControlData, ControlData, bool >
{
bool operator()( const ControlData& _rLHS, const ControlData& _rRHS ) const
{
return _rLHS.xControl.get() < _rRHS.xControl.get();
}
};
typedef ::std::set< ControlData, ControlDataCompare > ControlBag;
typedef ::com::sun::star::awt::XVclWindowPeer WindowPeer;
typedef ::com::sun::star::uno::Reference< ::com::sun::star::awt::XVclWindowPeer > WindowPeerRef;
typedef ::std::set< WindowPeerRef, ::comphelper::OInterfaceCompare< WindowPeer > > PeerBag;
PeerBag m_aColorableControls;
PeerBag m_aNonColorableControls;
ControlData m_aFocusControl;
ControlData m_aMouseHoverControl;
ControlBag m_aInvalidControls;
// ----------------
// attributes
sal_Int32 m_nFocusColor;
sal_Int32 m_nMouseHoveColor;
sal_Int32 m_nInvalidColor;
bool m_bDynamicBorderColors;
public:
ControlBorderManager();
~ControlBorderManager();
public:
void focusGained( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxControl ) SAL_THROW(());
void focusLost( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxControl ) SAL_THROW(());
void mouseEntered( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxControl ) SAL_THROW(());
void mouseExited( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxControl ) SAL_THROW(());
void validityChanged(
const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl >& _rxControl,
const ::com::sun::star::uno::Reference< ::com::sun::star::form::validation::XValidatableFormComponent >& _rxValidatable
) SAL_THROW(());
/// enables dynamic border color for the controls
void enableDynamicBorderColor( );
/// disables dynamic border color for the controls
void disableDynamicBorderColor( );
/** sets a color to be used for a given status
@param _nStatus
the status which the color should be applied for. Must not be CONTROL_STATUS_NONE
@param _nColor
the color to apply for the given status
*/
void setStatusColor( ControlStatus _nStatus, sal_Int32 _nColor );
/** restores all colors of all controls where we possibly changed them
*/
void restoreAll();
private:
/** called when a control got one of the two possible stati (focused, and hovered with the mouse)
@param _rxControl
the control which gained the status
@param _rControlData
the control's status data, as a reference to our respective member
*/
void controlStatusGained(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxControl,
ControlData& _rControlData
) SAL_THROW(());
/** called when a control lost one of the two possible stati (focused, and hovered with the mouse)
@param _rxControl
the control which lost the status
@param _rControlData
the control's status data, as a reference to our respective member
*/
void controlStatusLost( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxControl, ControlData& _rControlData ) SAL_THROW(());
/** determines whether the border of a given peer can be colored
@param _rxPeer
the peer to examine. Must not be <NULL/>
*/
bool canColorBorder( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XVclWindowPeer >& _rxPeer );
/** determines the status of the given control
*/
ControlStatus getControlStatus( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl >& _rxControl ) SAL_THROW(());
/** retrieves the color associated with a given ControlStatus
@param _eStatus
the status of the control. Must not be <member>ControlStatus::none</member>
*/
sal_Int32 getControlColorByStatus( ControlStatus _eStatus );
/** sets the border color for a given control, depending on its status
@param _rxControl
the control to set the border color for. Must not be <NULL/>
@param _rxPeer
the peer of the control, to be passed herein for optimization the caller usually needs it, anyway).
Must not be <NULL/>
@param _rFallback
the color/type to use when the control has the status CONTROL_STATUS_NONE
*/
void updateBorderStyle(
const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl >& _rxControl,
const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XVclWindowPeer >& _rxPeer,
const BorderDescriptor& _rFallback
) SAL_THROW(());
/** determines the to-be-remembered original border color and type for a control
The method also takes into account that the control may currently have an overwritten
border style
@param _rxControl
the control to examine. Must not be <NULL/>, and have a non-<NULL/> peer
*/
void determineOriginalBorderStyle(
const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl >& _rxControl,
BorderDescriptor& _rData
) const;
};
//........................................................................
} // namespace svxform
//........................................................................
#endif // SVX_SOURCE_INC_FMCONTROLBORDERMANAGER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
