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
/* -*- 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 _EXTENSIONS_PROPCTRLR_BROWSERLISTBOX_HXX_
#define _EXTENSIONS_PROPCTRLR_BROWSERLISTBOX_HXX_
#include "browserline.hxx"
#include "modulepcr.hxx"
#include "pcrcommon.hxx"
#include <com/sun/star/inspection/XPropertyControl.hpp>
#include <com/sun/star/inspection/XPropertyHandler.hpp>
#include <vcl/scrbar.hxx>
#include <vcl/lstbox.hxx>
#include <vcl/button.hxx>
#include <tools/link.hxx>
#include <rtl/ref.hxx>
#include <set>
#include <vector>
#include <boost/unordered_map.hpp>
#include <boost/shared_ptr.hpp>
//............................................................................
namespace pcr
{
//............................................................................
class IPropertyLineListener;
class IPropertyControlObserver;
struct OLineDescriptor;
class InspectorHelpWindow;
class PropertyControlContext_Impl;
//========================================================================
//= administrative structures for OBrowserListBox
//========================================================================
typedef ::boost::shared_ptr< OBrowserLine > BrowserLinePointer;
struct ListBoxLine
{
::rtl::OUString aName;
BrowserLinePointer pLine;
::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyHandler >
xHandler;
ListBoxLine( const ::rtl::OUString& rName, BrowserLinePointer _pLine, const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyHandler >& _rxHandler )
: aName( rName ),
pLine( _pLine ),
xHandler( _rxHandler )
{
}
};
typedef ::std::vector< ListBoxLine > ListBoxLines;
//========================================================================
//= IControlContext
//========================================================================
/** non-UNO version of XPropertyControlContext
*/
class SAL_NO_VTABLE IControlContext
{
public:
virtual void SAL_CALL focusGained( const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControl >& Control ) throw (::com::sun::star::uno::RuntimeException) = 0;
virtual void SAL_CALL valueChanged( const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControl >& Control ) throw (::com::sun::star::uno::RuntimeException) = 0;
virtual void SAL_CALL activateNextControl( const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControl >& CurrentControl ) throw (::com::sun::star::uno::RuntimeException) = 0;
protected:
~IControlContext() {}
};
//========================================================================
//= OBrowserListBox
//========================================================================
class OBrowserListBox :public Control
,public IButtonClickListener
,public IControlContext
,public PcrClient
{
protected:
Window m_aLinesPlayground;
ScrollBar m_aVScroll;
::std::auto_ptr< InspectorHelpWindow >
m_pHelpWindow;
ListBoxLines m_aLines;
IPropertyLineListener* m_pLineListener;
IPropertyControlObserver* m_pControlObserver;
long m_nYOffset;
long m_nCurrentPreferredHelpHeight;
::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControl >
m_xActiveControl;
sal_uInt16 m_nTheNameSize;
sal_uInt16 m_nRowHeight;
::std::set< sal_uInt16 > m_aOutOfDateLines;
sal_Bool m_bIsActive : 1;
sal_Bool m_bUpdate : 1;
::rtl::Reference< PropertyControlContext_Impl >
m_pControlContextImpl;
protected:
void PositionLine( sal_uInt16 _nIndex );
void UpdatePosNSize();
void UpdatePlayGround();
void UpdateVScroll();
void ShowEntry(sal_uInt16 nPos);
void MoveThumbTo(sal_Int32 nNewThumbPos);
void Resize();
public:
OBrowserListBox( Window* pParent, WinBits nWinStyle = WB_DIALOGCONTROL );
~OBrowserListBox();
void UpdateAll();
void ActivateListBox( sal_Bool _bActive );
sal_uInt16 CalcVisibleLines();
void EnableUpdate();
void DisableUpdate();
long Notify( NotifyEvent& _rNEvt );
long PreNotify( NotifyEvent& _rNEvt );
void SetListener( IPropertyLineListener* _pListener );
void SetObserver( IPropertyControlObserver* _pObserver );
void EnableHelpSection( bool _bEnable );
bool HasHelpSection() const;
void SetHelpText( const ::rtl::OUString& _rHelpText );
void SetHelpLineLimites( sal_Int32 _nMinLines, sal_Int32 _nMaxLines );
void Clear();
sal_uInt16 InsertEntry( const OLineDescriptor&, sal_uInt16 nPos = EDITOR_LIST_APPEND );
sal_Bool RemoveEntry( const ::rtl::OUString& _rName );
void ChangeEntry( const OLineDescriptor&, sal_uInt16 nPos );
void SetPropertyValue( const ::rtl::OUString& rEntryName, const ::com::sun::star::uno::Any& rValue, bool _bUnknownValue );
sal_uInt16 GetPropertyPos( const ::rtl::OUString& rEntryName ) const;
::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControl >
GetPropertyControl( const ::rtl::OUString& rEntryName );
void EnablePropertyControls( const ::rtl::OUString& _rEntryName, sal_Int16 _nControls, bool _bEnable );
void EnablePropertyLine( const ::rtl::OUString& _rEntryName, bool _bEnable );
sal_Int32 GetMinimumWidth();
sal_Int32 GetMinimumHeight();
sal_Bool IsModified( ) const;
void CommitModified( );
protected:
// IControlContext
virtual void SAL_CALL focusGained( const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControl >& Control ) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL valueChanged( const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControl >& Control ) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL activateNextControl( const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControl >& CurrentControl ) throw (::com::sun::star::uno::RuntimeException);
// IButtonClickListener
void buttonClicked( OBrowserLine* _pLine, sal_Bool _bPrimary );
using Window::SetHelpText;
private:
DECL_LINK( ScrollHdl, ScrollBar* );
/** retrieves the index of a given control in our line list
@param _rxControl
The control to lookup. Must denote a control of one of the lines in ->m_aLines
*/
sal_uInt16 impl_getControlPos( const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControl >& _rxControl ) const;
/** sets the given property value at the given control, after converting it as necessary
@param _rLine
The line whose at which the value is to be set.
@param _rPropertyValue
the property value to set. If it's not compatible with the control value,
it will be converted, using <member>XPropertyHandler::convertToControlValue</member>
*/
void impl_setControlAsPropertyValue( const ListBoxLine& _rLine, const ::com::sun::star::uno::Any& _rPropertyValue );
/** retrieves the value for the given control, as a property value, after converting it as necessary
@param _rLine
The line whose at which the value is to be set.
*/
::com::sun::star::uno::Any
impl_getControlAsPropertyValue( const ListBoxLine& _rLine ) const;
/** retrieves the ->BrowserLinePointer for a given entry name
@param _rEntryName
the name whose line is to be looked up
@param _out_rpLine
contains, upon return, the found browser line, if any
@return
<TRUE/> if and only if a non-<NULL/> line for the given entry name could be
found.
*/
bool impl_getBrowserLineForName( const ::rtl::OUString& _rEntryName, BrowserLinePointer& _out_rpLine ) const;
/** returns the preferred height (in pixels) of the help section, or 0 if we
currently don't have a help section
*/
long impl_getPrefererredHelpHeight();
private:
using Window::Activate;
};
//............................................................................
} // namespace pcr
//............................................................................
#endif // _EXTENSIONS_PROPCTRLR_BROWSERLISTBOX_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */