forms/source/component/entrylisthelper.cxx

   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 <com/sun/star/form/binding/XListEntryTypedSource.hpp>
  27 #include <algorithm>
  28
  29
  30 namespace frm
  31 {
  32
  33
  34     using namespace ::com::sun::star::uno;
  35     using namespace ::com::sun::star::lang;
  36     using namespace ::com::sun::star::util;
  37     using namespace ::com::sun::star::form::binding;
  38
  39     OEntryListHelper::OEntryListHelper( OControlModel& _rControlModel )
  40         :m_rControlModel( _rControlModel )
  41         ,m_aRefreshListeners( _rControlModel.getInstanceMutex() )
  42     {
  43     }
  44
  45
  46     OEntryListHelper::OEntryListHelper( const OEntryListHelper& _rSource, OControlModel& _rControlModel )
  47         :m_rControlModel( _rControlModel )
  48         ,m_xListSource ( _rSource.m_xListSource  )
  49         ,m_aStringItems( _rSource.m_aStringItems )
  50         ,m_aRefreshListeners( _rControlModel.getInstanceMutex() )
  51     {
  52     }
  53
  54
  55     OEntryListHelper::~OEntryListHelper( )
  56     {
  57     }
  58
  59
  60     void SAL_CALL OEntryListHelper::setListEntrySource( const Reference< XListEntrySource >& _rxSource )
  61     {
  62         ControlModelLock aLock( m_rControlModel );
  63
  64         // disconnect from the current external list source
  65         disconnectExternalListSource();
  66
  67         // and connect to the new one
  68         if ( _rxSource.is() )
  69             connectExternalListSource( _rxSource, aLock );
  70     }
  71
  72
  73     Reference< XListEntrySource > SAL_CALL OEntryListHelper::getListEntrySource(  )
  74     {
  75         return m_xListSource;
  76     }
  77
  78
  79     void SAL_CALL OEntryListHelper::entryChanged( const ListEntryEvent& _rEvent )
  80     {
  81         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 < static_cast<sal_Int32>(m_aStringItems.size()) ),
  86             "OEntryListHelper::entryChanged: invalid index!" );
  87         OSL_ENSURE( _rEvent.Entries.getLength() == 1,
  88             "OEntryListHelper::entryChanged: invalid string list!" );
  89
  90         if  (   ( _rEvent.Position >= 0 )
  91             &&  ( _rEvent.Position < static_cast<sal_Int32>(m_aStringItems.size()) )
  92             &&  _rEvent.Entries.hasElements()
  93             )
  94         {
  95             m_aStringItems[ _rEvent.Position ] = _rEvent.Entries[ 0 ];
  96             if (m_aTypedItems.hasElements())
  97                 m_aTypedItems = Sequence<Any>();    // doesn't match anymore
  98             stringItemListChanged( aLock );
  99         }
 100     }
 101
 102
 103     void SAL_CALL OEntryListHelper::entryRangeInserted( const ListEntryEvent& _rEvent )
 104     {
 105         ControlModelLock aLock( m_rControlModel );
 106
 107         OSL_ENSURE( _rEvent.Source == m_xListSource,
 108             "OEntryListHelper::entryRangeInserted: where did this come from?" );
 109         OSL_ENSURE( ( _rEvent.Position > 0 ) && ( _rEvent.Position < static_cast<sal_Int32>(m_aStringItems.size()) ) && _rEvent.Entries.hasElements(),
 110             "OEntryListHelper::entryRangeRemoved: invalid count and/or position!" );
 111
 112         if  (   ( _rEvent.Position > 0 )
 113             &&  ( _rEvent.Position < static_cast<sal_Int32>(m_aStringItems.size()) )
 114             &&  _rEvent.Entries.hasElements()
 115             )
 116         {
 117             m_aStringItems.insert(m_aStringItems.begin() + _rEvent.Position, _rEvent.Entries.begin(), _rEvent.Entries.end());
 118             if (m_aTypedItems.hasElements())
 119                 m_aTypedItems = Sequence<Any>();    // doesn't match anymore
 120             stringItemListChanged( aLock );
 121         }
 122     }
 123
 124
 125     void SAL_CALL OEntryListHelper::entryRangeRemoved( const ListEntryEvent& _rEvent )
 126     {
 127         ControlModelLock aLock( m_rControlModel );
 128
 129         OSL_ENSURE( _rEvent.Source == m_xListSource,
 130             "OEntryListHelper::entryRangeRemoved: where did this come from?" );
 131         OSL_ENSURE( ( _rEvent.Position > 0 ) && ( _rEvent.Count > 0 ) && ( _rEvent.Position + _rEvent.Count <= static_cast<sal_Int32>(m_aStringItems.size()) ),
 132             "OEntryListHelper::entryRangeRemoved: invalid count and/or position!" );
 133
 134         if  (   !(( _rEvent.Position > 0 )
 135             &&  ( _rEvent.Count > 0 )
 136             &&  ( _rEvent.Position + _rEvent.Count <= static_cast<sal_Int32>(m_aStringItems.size()) ))
 137             )
 138             return;
 139
 140         m_aStringItems.erase(m_aStringItems.begin() + _rEvent.Position,
 141                              m_aStringItems.begin() + _rEvent.Position + _rEvent.Count );
 142         if (_rEvent.Position + _rEvent.Count <= m_aTypedItems.getLength())
 143         {
 144             Sequence<Any> aTmp( m_aTypedItems.getLength() - _rEvent.Count );
 145             auto aTmpRange = asNonConstRange(aTmp);
 146             sal_Int32 nStop = _rEvent.Position;
 147             sal_Int32 i = 0;
 148             for ( ; i < nStop; ++i)
 149             {
 150                 aTmpRange[i] = m_aTypedItems[i];
 151             }
 152             nStop = aTmp.getLength();
 153             for (sal_Int32 j = _rEvent.Position + _rEvent.Count; i < nStop; ++i, ++j)
 154             {
 155                 aTmpRange[i] = m_aTypedItems[j];
 156             }
 157             m_aTypedItems = aTmp;
 158         }
 159         else if (m_aTypedItems.hasElements())
 160         {
 161             m_aTypedItems = Sequence<Any>();    // doesn't match anymore
 162         }
 163         stringItemListChanged( aLock );
 164     }
 165
 166
 167     void SAL_CALL OEntryListHelper::allEntriesChanged( const EventObject& _rEvent )
 168     {
 169         ControlModelLock aLock( m_rControlModel );
 170
 171         OSL_ENSURE( _rEvent.Source == m_xListSource,
 172             "OEntryListHelper::allEntriesChanged: where did this come from?" );
 173
 174         if ( _rEvent.Source == m_xListSource )
 175         {
 176             impl_lock_refreshList( aLock );
 177         }
 178     }
 179
 180     // XRefreshable
 181
 182     void SAL_CALL OEntryListHelper::addRefreshListener(const Reference<XRefreshListener>& _rxListener)
 183     {
 184         if ( _rxListener.is() )
 185             m_aRefreshListeners.addInterface( _rxListener );
 186     }
 187
 188
 189     void SAL_CALL OEntryListHelper::removeRefreshListener(const Reference<XRefreshListener>& _rxListener)
 190     {
 191         if ( _rxListener.is() )
 192             m_aRefreshListeners.removeInterface( _rxListener );
 193     }
 194
 195
 196     void SAL_CALL OEntryListHelper::refresh()
 197     {
 198         {
 199             ControlModelLock aLock( m_rControlModel );
 200             impl_lock_refreshList( aLock );
 201         }
 202
 203         EventObject aEvt( static_cast< XRefreshable* >( this ) );
 204         m_aRefreshListeners.notifyEach( &XRefreshListener::refreshed, aEvt );
 205     }
 206
 207
 208     void OEntryListHelper::impl_lock_refreshList( ControlModelLock& _rInstanceLock )
 209     {
 210         if ( hasExternalListSource() )
 211             obtainListSourceEntries( _rInstanceLock );
 212         else
 213             refreshInternalEntryList();
 214     }
 215
 216
 217     bool OEntryListHelper::handleDisposing( const EventObject& _rEvent )
 218     {
 219         if ( m_xListSource .is() && ( _rEvent.Source == m_xListSource ) )
 220         {
 221             disconnectExternalListSource( );
 222             return true;
 223         }
 224         return false;
 225     }
 226
 227
 228     void OEntryListHelper::disposing( )
 229     {
 230         EventObject aEvt( static_cast< XRefreshable* >( this ) );
 231         m_aRefreshListeners.disposeAndClear(aEvt);
 232
 233         if ( hasExternalListSource( ) )
 234             disconnectExternalListSource( );
 235     }
 236
 237
 238     void OEntryListHelper::disconnectExternalListSource( )
 239     {
 240         if ( m_xListSource.is() )
 241             m_xListSource->removeListEntryListener( this );
 242
 243         m_xListSource.clear();
 244     }
 245
 246
 247     void OEntryListHelper::connectExternalListSource( const Reference< XListEntrySource >& _rxSource, ControlModelLock& _rInstanceLock )
 248     {
 249         OSL_ENSURE( !hasExternalListSource(), "OEntryListHelper::connectExternalListSource: only to be called if no external source is active!" );
 250         OSL_ENSURE( _rxSource.is(), "OEntryListHelper::connectExternalListSource: invalid list source!" );
 251
 252         // remember it
 253         m_xListSource = _rxSource;
 254
 255         // initially fill our item list
 256         if ( m_xListSource.is() )
 257         {
 258             // be notified when the list changes ...
 259             m_xListSource->addListEntryListener( this );
 260
 261             obtainListSourceEntries( _rInstanceLock );
 262         }
 263     }
 264
 265
 266     void OEntryListHelper::obtainListSourceEntries( ControlModelLock& _rInstanceLock )
 267     {
 268         Reference< XListEntryTypedSource > xTyped;
 269         xTyped.set( m_xListSource, UNO_QUERY);
 270         if (xTyped.is())
 271         {
 272             comphelper::sequenceToContainer( m_aStringItems, xTyped->getAllListEntriesTyped( m_aTypedItems));
 273         }
 274         else
 275         {
 276             comphelper::sequenceToContainer( m_aStringItems, m_xListSource->getAllListEntries());
 277             if (m_aTypedItems.hasElements())
 278                 m_aTypedItems = Sequence<Any>();
 279         }
 280         stringItemListChanged( _rInstanceLock );
 281     }
 282
 283
 284     bool OEntryListHelper::convertNewListSourceProperty( Any& _rConvertedValue,
 285         Any& _rOldValue, const Any& _rValue )
 286     {
 287         if ( hasExternalListSource() )
 288             throw IllegalArgumentException( );
 289             // TODO: error message
 290
 291         return ::comphelper::tryPropertyValue( _rConvertedValue, _rOldValue, _rValue, comphelper::containerToSequence(m_aStringItems) );
 292     }
 293
 294
 295     void OEntryListHelper::setNewStringItemList( const css::uno::Any& _rValue, ControlModelLock& _rInstanceLock )
 296     {
 297         OSL_PRECOND( !hasExternalListSource(), "OEntryListHelper::setNewStringItemList: this should never have survived convertNewListSourceProperty!" );
 298         css::uno::Sequence<OUString> aTmp;
 299         OSL_VERIFY( _rValue >>= aTmp );
 300         comphelper::sequenceToContainer(m_aStringItems, aTmp);
 301         if (m_aTypedItems.hasElements())
 302             m_aTypedItems = Sequence<Any>();    // doesn't match anymore
 303         stringItemListChanged( _rInstanceLock );
 304     }
 305
 306
 307     void OEntryListHelper::setNewTypedItemList( const css::uno::Any& _rValue, ControlModelLock& _rInstanceLock )
 308     {
 309         OSL_PRECOND( !hasExternalListSource(), "OEntryListHelper::setNewTypedItemList: this should never have survived convertNewListSourceProperty!" );
 310         if (!(_rValue >>= m_aTypedItems ))
 311         {
 312             OSL_VERIFY(false);
 313             if (m_aTypedItems.hasElements())
 314                 m_aTypedItems = Sequence<Any>();    // doesn't match anymore
 315         }
 316         // Sets both properties, assuming that TypedItemList belongs to StringItemList.
 317         stringItemListChanged( _rInstanceLock );
 318     }
 319
 320
 321 }   // namespace frm
 322
 323
 324 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */