f0c8312bc6
Found with bin/find-unneeded-includes Only removal proposals are dealt with here. Change-Id: I4afb3616c4f93155c187da11b2981b84d0984e9f Reviewed-on: https://gerrit.libreoffice.org/c/core/+/87943 Tested-by: Jenkins Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
196 lines
7.7 KiB
C++
196 lines
7.7 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <com/sun/star/form/binding/XListEntrySink.hpp>
|
|
#include <com/sun/star/util/XRefreshable.hpp>
|
|
#include <com/sun/star/form/binding/XListEntryListener.hpp>
|
|
|
|
#include <cppuhelper/implbase3.hxx>
|
|
#include <comphelper/interfacecontainer2.hxx>
|
|
|
|
|
|
namespace frm
|
|
{
|
|
|
|
|
|
class OControlModel;
|
|
class ControlModelLock;
|
|
|
|
|
|
//= OEntryListHelper
|
|
|
|
typedef ::cppu::ImplHelper3 < css::form::binding::XListEntrySink
|
|
, css::form::binding::XListEntryListener
|
|
, css::util::XRefreshable
|
|
> OEntryListHelper_BASE;
|
|
|
|
class OEntryListHelper : public OEntryListHelper_BASE
|
|
{
|
|
private:
|
|
OControlModel& m_rControlModel;
|
|
|
|
css::uno::Reference< css::form::binding::XListEntrySource >
|
|
m_xListSource; /// our external list source
|
|
std::vector< OUString >
|
|
m_aStringItems; /// "overridden" StringItemList property value
|
|
css::uno::Sequence< css::uno::Any >
|
|
m_aTypedItems; /// "overridden" TypedItemList property value
|
|
::comphelper::OInterfaceContainerHelper2
|
|
m_aRefreshListeners;
|
|
|
|
|
|
protected:
|
|
explicit OEntryListHelper( OControlModel& _rControlModel );
|
|
OEntryListHelper( const OEntryListHelper& _rSource, OControlModel& _rControlModel );
|
|
virtual ~OEntryListHelper( );
|
|
|
|
/// returns the current string item list
|
|
const std::vector< OUString >&
|
|
getStringItemList() const { return m_aStringItems; }
|
|
|
|
/// returns the current typed item list
|
|
const css::uno::Sequence< css::uno::Any >&
|
|
getTypedItemList() const { return m_aTypedItems; }
|
|
|
|
/// determines whether we actually have an external list source
|
|
bool hasExternalListSource( ) const { return m_xListSource.is(); }
|
|
|
|
/** handling the XEventListener::disposing call for the case where
|
|
our list source is being disposed
|
|
@return
|
|
<TRUE/> if and only if the disposed object was our list source, and so the
|
|
event was handled
|
|
*/
|
|
bool handleDisposing( const css::lang::EventObject& _rEvent );
|
|
|
|
/** to be called by derived classes' instances when they're being disposed
|
|
*/
|
|
void disposing( );
|
|
|
|
// prevent method hiding
|
|
virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override = 0;
|
|
|
|
/** helper for implementing convertFastPropertyValue( StringItemList )
|
|
|
|
<p>The signature of this method and the return type have the same semantics
|
|
as convertFastPropertyValue.</p>
|
|
*/
|
|
bool convertNewListSourceProperty(
|
|
css::uno::Any& _rConvertedValue,
|
|
css::uno::Any& _rOldValue,
|
|
const css::uno::Any& _rValue
|
|
);
|
|
|
|
/** helper for implementing setFastPropertyValueNoBroadcast
|
|
|
|
<p>Will internally call stringItemListChanged after the new item list
|
|
has been set.</p>
|
|
|
|
@precond
|
|
not to be called when we have an external list source
|
|
@see hasExternalListSource
|
|
*/
|
|
void setNewStringItemList( const css::uno::Any& _rValue, ControlModelLock& _rInstanceLock );
|
|
|
|
/** helper for implementing setFastPropertyValueNoBroadcast
|
|
|
|
<p>Will internally call stringItemListChanged after the new item list
|
|
has been set.</p>
|
|
|
|
@precond
|
|
not to be called when we have an external list source
|
|
@see hasExternalListSource
|
|
*/
|
|
void setNewTypedItemList( const css::uno::Any& _rValue, ControlModelLock& _rInstanceLock );
|
|
|
|
/** announces that the list of entries has changed.
|
|
|
|
<p>Derived classes have to override this. Most probably, they'll set the new
|
|
as model property.</p>
|
|
|
|
@pure
|
|
@see getStringItemList
|
|
*/
|
|
virtual void stringItemListChanged( ControlModelLock& _rInstanceLock ) = 0;
|
|
|
|
/** called when XRefreshable::refresh has been called, and we do *not* have an external
|
|
list source
|
|
*/
|
|
virtual void refreshInternalEntryList() = 0;
|
|
|
|
private:
|
|
// XListEntrySink
|
|
virtual void SAL_CALL setListEntrySource( const css::uno::Reference< css::form::binding::XListEntrySource >& _rxSource ) override;
|
|
virtual css::uno::Reference< css::form::binding::XListEntrySource > SAL_CALL getListEntrySource( ) override;
|
|
|
|
// XListEntryListener
|
|
virtual void SAL_CALL entryChanged( const css::form::binding::ListEntryEvent& _rSource ) override;
|
|
virtual void SAL_CALL entryRangeInserted( const css::form::binding::ListEntryEvent& _rSource ) override;
|
|
virtual void SAL_CALL entryRangeRemoved( const css::form::binding::ListEntryEvent& _rSource ) override;
|
|
virtual void SAL_CALL allEntriesChanged( const css::lang::EventObject& _rSource ) override;
|
|
|
|
// XRefreshable
|
|
virtual void SAL_CALL refresh() override;
|
|
virtual void SAL_CALL addRefreshListener(const css::uno::Reference< css::util::XRefreshListener>& _rxListener) override;
|
|
virtual void SAL_CALL removeRefreshListener(const css::uno::Reference< css::util::XRefreshListener>& _rxListener) override;
|
|
|
|
private:
|
|
/** disconnects from the active external list source, if present
|
|
@see connectExternalListSource
|
|
*/
|
|
void disconnectExternalListSource( );
|
|
|
|
/** connects to a new external list source
|
|
@param _rxSource
|
|
the new list source. Must not be <NULL/>
|
|
@see disconnectExternalListSource
|
|
*/
|
|
void connectExternalListSource(
|
|
const css::uno::Reference< css::form::binding::XListEntrySource >& _rxSource,
|
|
ControlModelLock& _rInstanceLock
|
|
);
|
|
|
|
/** obtains list entries and possibly data values from list source
|
|
|
|
@precond
|
|
m_xListSource has to hold an external list source
|
|
*/
|
|
void obtainListSourceEntries( ControlModelLock& _rInstanceLock );
|
|
|
|
/** refreshes our list entries
|
|
|
|
In case we have an external list source, it's used to obtain the new entries, and then
|
|
stringItemListChanged is called to give the derived class the possibility to
|
|
react on this.
|
|
|
|
In case we do not have an external list source, refreshInternalEntryList is called.
|
|
*/
|
|
void impl_lock_refreshList( ControlModelLock& _rInstanceLock );
|
|
|
|
private:
|
|
OEntryListHelper( const OEntryListHelper& ) = delete;
|
|
OEntryListHelper& operator=( const OEntryListHelper& ) = delete;
|
|
};
|
|
|
|
|
|
} // namespace frm
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|