Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 :
20 : #include "entrylisthelper.hxx"
21 : #include "FormComponent.hxx"
22 :
23 : #include <osl/diagnose.h>
24 : #include <comphelper/sequence.hxx>
25 : #include <comphelper/property.hxx>
26 : #include <algorithm>
27 :
28 :
29 : namespace frm
30 : {
31 :
32 :
33 : using namespace ::com::sun::star::uno;
34 : using namespace ::com::sun::star::lang;
35 : using namespace ::com::sun::star::util;
36 : using namespace ::com::sun::star::form::binding;
37 :
38 48 : OEntryListHelper::OEntryListHelper( OControlModel& _rControlModel )
39 : :m_rControlModel( _rControlModel )
40 48 : ,m_aRefreshListeners( _rControlModel.getInstanceMutex() )
41 : {
42 48 : }
43 :
44 :
45 2 : OEntryListHelper::OEntryListHelper( const OEntryListHelper& _rSource, OControlModel& _rControlModel )
46 : :m_rControlModel( _rControlModel )
47 : ,m_xListSource ( _rSource.m_xListSource )
48 : ,m_aStringItems( _rSource.m_aStringItems )
49 2 : ,m_aRefreshListeners( _rControlModel.getInstanceMutex() )
50 : {
51 2 : }
52 :
53 :
54 46 : OEntryListHelper::~OEntryListHelper( )
55 : {
56 46 : }
57 :
58 :
59 3 : void SAL_CALL OEntryListHelper::setListEntrySource( const Reference< XListEntrySource >& _rxSource ) throw (RuntimeException, std::exception)
60 : {
61 3 : ControlModelLock aLock( m_rControlModel );
62 :
63 : // disconnect from the current external list source
64 3 : disconnectExternalListSource();
65 :
66 : // and connect to the new one
67 3 : if ( _rxSource.is() )
68 3 : connectExternalListSource( _rxSource, aLock );
69 3 : }
70 :
71 :
72 66 : Reference< XListEntrySource > SAL_CALL OEntryListHelper::getListEntrySource( ) throw (RuntimeException, std::exception)
73 : {
74 66 : return m_xListSource;
75 : }
76 :
77 :
78 :
79 0 : void SAL_CALL OEntryListHelper::entryChanged( const ListEntryEvent& _rEvent ) throw (RuntimeException, std::exception)
80 : {
81 0 : ControlModelLock aLock( m_rControlModel );
82 :
83 : OSL_ENSURE( _rEvent.Source == m_xListSource,
84 : "OEntryListHelper::entryChanged: where did this come from?" );
85 : OSL_ENSURE( ( _rEvent.Position >= 0 ) && ( _rEvent.Position < m_aStringItems.getLength() ),
86 : "OEntryListHelper::entryChanged: invalid index!" );
87 : OSL_ENSURE( _rEvent.Entries.getLength() == 1,
88 : "OEntryListHelper::entryChanged: invalid string list!" );
89 :
90 0 : if ( ( _rEvent.Position >= 0 )
91 0 : && ( _rEvent.Position < m_aStringItems.getLength() )
92 0 : && ( _rEvent.Entries.getLength() > 0 )
93 : )
94 : {
95 0 : m_aStringItems[ _rEvent.Position ] = _rEvent.Entries[ 0 ];
96 0 : stringItemListChanged( aLock );
97 0 : }
98 0 : }
99 :
100 :
101 0 : void SAL_CALL OEntryListHelper::entryRangeInserted( const ListEntryEvent& _rEvent ) throw (RuntimeException, std::exception)
102 : {
103 0 : ControlModelLock aLock( m_rControlModel );
104 :
105 : OSL_ENSURE( _rEvent.Source == m_xListSource,
106 : "OEntryListHelper::entryRangeInserted: where did this come from?" );
107 : OSL_ENSURE( ( _rEvent.Position > 0 ) && ( _rEvent.Position < m_aStringItems.getLength() ) && ( _rEvent.Entries.getLength() > 0 ),
108 : "OEntryListHelper::entryRangeRemoved: invalid count and/or position!" );
109 :
110 0 : if ( ( _rEvent.Position > 0 )
111 0 : && ( _rEvent.Position < m_aStringItems.getLength() )
112 0 : && ( _rEvent.Entries.getLength() > 0 )
113 : )
114 : {
115 : // the entries *before* the insertion pos
116 : Sequence< OUString > aKeepEntries(
117 : m_aStringItems.getConstArray(),
118 : _rEvent.Position
119 0 : );
120 : // the entries *behind* the insertion pos
121 : Sequence< OUString > aMovedEntries(
122 0 : m_aStringItems.getConstArray() + _rEvent.Position,
123 0 : m_aStringItems.getLength() - _rEvent.Position
124 0 : );
125 :
126 : // concat all three parts
127 0 : m_aStringItems = ::comphelper::concatSequences(
128 : aKeepEntries,
129 : _rEvent.Entries,
130 : aMovedEntries
131 0 : );
132 :
133 0 : stringItemListChanged( aLock );
134 0 : }
135 0 : }
136 :
137 :
138 0 : void SAL_CALL OEntryListHelper::entryRangeRemoved( const ListEntryEvent& _rEvent ) throw (RuntimeException, std::exception)
139 : {
140 0 : ControlModelLock aLock( m_rControlModel );
141 :
142 : OSL_ENSURE( _rEvent.Source == m_xListSource,
143 : "OEntryListHelper::entryRangeRemoved: where did this come from?" );
144 : OSL_ENSURE( ( _rEvent.Position > 0 ) && ( _rEvent.Count > 0 ) && ( _rEvent.Position + _rEvent.Count <= m_aStringItems.getLength() ),
145 : "OEntryListHelper::entryRangeRemoved: invalid count and/or position!" );
146 :
147 0 : if ( ( _rEvent.Position > 0 )
148 0 : && ( _rEvent.Count > 0 )
149 0 : && ( _rEvent.Position + _rEvent.Count <= m_aStringItems.getLength() )
150 : )
151 : {
152 : // copy all items after the removed ones
153 : ::std::copy(
154 0 : m_aStringItems.getConstArray() + _rEvent.Position + _rEvent.Count,
155 0 : m_aStringItems.getConstArray() + m_aStringItems.getLength(),
156 0 : m_aStringItems.getArray( ) + _rEvent.Position
157 0 : );
158 : // shrink the array
159 0 : m_aStringItems.realloc( m_aStringItems.getLength() - _rEvent.Count );
160 :
161 0 : stringItemListChanged( aLock );
162 0 : }
163 0 : }
164 :
165 :
166 0 : void SAL_CALL OEntryListHelper::allEntriesChanged( const EventObject& _rEvent ) throw (RuntimeException, std::exception)
167 : {
168 0 : ControlModelLock aLock( m_rControlModel );
169 :
170 : OSL_ENSURE( _rEvent.Source == m_xListSource,
171 : "OEntryListHelper::allEntriesChanged: where did this come from?" );
172 :
173 0 : Reference< XListEntrySource > xSource( _rEvent.Source, UNO_QUERY );
174 0 : if ( _rEvent.Source == m_xListSource )
175 : {
176 0 : impl_lock_refreshList( aLock );
177 0 : }
178 0 : }
179 :
180 : // XRefreshable
181 :
182 0 : void SAL_CALL OEntryListHelper::addRefreshListener(const Reference<XRefreshListener>& _rxListener) throw(RuntimeException, std::exception)
183 : {
184 0 : if ( _rxListener.is() )
185 0 : m_aRefreshListeners.addInterface( _rxListener );
186 0 : }
187 :
188 :
189 0 : void SAL_CALL OEntryListHelper::removeRefreshListener(const Reference<XRefreshListener>& _rxListener) throw(RuntimeException, std::exception)
190 : {
191 0 : if ( _rxListener.is() )
192 0 : m_aRefreshListeners.removeInterface( _rxListener );
193 0 : }
194 :
195 :
196 0 : void SAL_CALL OEntryListHelper::refresh() throw(RuntimeException, std::exception)
197 : {
198 : {
199 0 : ControlModelLock aLock( m_rControlModel );
200 0 : impl_lock_refreshList( aLock );
201 : }
202 :
203 0 : EventObject aEvt( static_cast< XRefreshable* >( this ) );
204 0 : m_aRefreshListeners.notifyEach( &XRefreshListener::refreshed, aEvt );
205 0 : }
206 :
207 :
208 0 : void OEntryListHelper::impl_lock_refreshList( ControlModelLock& _rInstanceLock )
209 : {
210 0 : if ( hasExternalListSource() )
211 : {
212 0 : m_aStringItems = m_xListSource->getAllListEntries( );
213 0 : stringItemListChanged( _rInstanceLock );
214 : }
215 : else
216 0 : refreshInternalEntryList();
217 0 : }
218 :
219 :
220 4 : bool OEntryListHelper::handleDisposing( const EventObject& _rEvent )
221 : {
222 4 : if ( m_xListSource .is() && ( _rEvent.Source == m_xListSource ) )
223 : {
224 0 : disconnectExternalListSource( );
225 0 : return true;
226 : }
227 4 : return false;
228 : }
229 :
230 :
231 46 : void OEntryListHelper::disposing( )
232 : {
233 46 : EventObject aEvt( static_cast< XRefreshable* >( this ) );
234 46 : m_aRefreshListeners.disposeAndClear(aEvt);
235 :
236 46 : if ( hasExternalListSource( ) )
237 1 : disconnectExternalListSource( );
238 46 : }
239 :
240 :
241 4 : void OEntryListHelper::disconnectExternalListSource( )
242 : {
243 4 : if ( m_xListSource.is() )
244 1 : m_xListSource->removeListEntryListener( this );
245 :
246 4 : m_xListSource.clear();
247 :
248 4 : disconnectedExternalListSource();
249 4 : }
250 :
251 :
252 0 : void OEntryListHelper::connectedExternalListSource( )
253 : {
254 : // nothing to do here
255 0 : }
256 :
257 :
258 0 : void OEntryListHelper::disconnectedExternalListSource( )
259 : {
260 : // nothing to do here
261 0 : }
262 :
263 :
264 3 : void OEntryListHelper::connectExternalListSource( const Reference< XListEntrySource >& _rxSource, ControlModelLock& _rInstanceLock )
265 : {
266 : OSL_ENSURE( !hasExternalListSource(), "OEntryListHelper::connectExternalListSource: only to be called if no external source is active!" );
267 : OSL_ENSURE( _rxSource.is(), "OEntryListHelper::connectExternalListSource: invalid list source!" );
268 :
269 : // remember it
270 3 : m_xListSource = _rxSource;
271 :
272 : // initially fill our item list
273 3 : if ( m_xListSource.is() )
274 : {
275 : // be notified when the list changes ...
276 3 : m_xListSource->addListEntryListener( this );
277 :
278 3 : m_aStringItems = m_xListSource->getAllListEntries( );
279 3 : stringItemListChanged( _rInstanceLock );
280 :
281 : // let derivees react on the new list source
282 3 : connectedExternalListSource();
283 : }
284 3 : }
285 :
286 :
287 152 : bool OEntryListHelper::convertNewListSourceProperty( Any& _rConvertedValue,
288 : Any& _rOldValue, const Any& _rValue )
289 : {
290 152 : if ( hasExternalListSource() )
291 0 : throw IllegalArgumentException( );
292 : // TODO: error message
293 :
294 152 : return ::comphelper::tryPropertyValue( _rConvertedValue, _rOldValue, _rValue, m_aStringItems );
295 : }
296 :
297 :
298 61 : void OEntryListHelper::setNewStringItemList( const ::com::sun::star::uno::Any& _rValue, ControlModelLock& _rInstanceLock )
299 : {
300 : OSL_PRECOND( !hasExternalListSource(), "OEntryListHelper::setNewStringItemList: this should never have survived convertNewListSourceProperty!" );
301 61 : OSL_VERIFY( _rValue >>= m_aStringItems );
302 61 : stringItemListChanged( _rInstanceLock );
303 61 : }
304 :
305 :
306 : } // namespace frm
307 :
308 :
309 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|