181 lines
7.9 KiB
C++
181 lines
7.9 KiB
C++
/*************************************************************************
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: entrylisthelper.hxx,v $
|
|
*
|
|
* $Revision: 1.6 $
|
|
*
|
|
* last change: $Author: hr $ $Date: 2006-06-19 12:54:08 $
|
|
*
|
|
* The Contents of this file are made available subject to
|
|
* the terms of GNU Lesser General Public License Version 2.1.
|
|
*
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2005 by Sun Microsystems, Inc.
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
*
|
|
* This library 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 for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*
|
|
************************************************************************/
|
|
|
|
#ifndef FORMS_ENTRYLISTHELPER_HXX
|
|
#define FORMS_ENTRYLISTHELPER_HXX
|
|
|
|
#ifndef _COM_SUN_STAR_FORM_BINDING_XLISTENTRYSINK_HDL_
|
|
#include <com/sun/star/form/binding/XListEntrySink.hpp>
|
|
#endif
|
|
#ifndef _COM_SUN_STAR_FORM_BINDING_XLISTENTRYLISTENER_HDL_
|
|
#include <com/sun/star/form/binding/XListEntryListener.hpp>
|
|
#endif
|
|
#ifndef _COM_SUN_STAR_LANG_ILLEGALARGUMENTEXCEPTION_HPP_
|
|
#include <com/sun/star/lang/IllegalArgumentException.hpp>
|
|
#endif
|
|
#ifndef _CPPUHELPER_IMPLBASE2_HXX_
|
|
#include <cppuhelper/implbase2.hxx>
|
|
#endif
|
|
|
|
//.........................................................................
|
|
namespace frm
|
|
{
|
|
//.........................................................................
|
|
|
|
//=====================================================================
|
|
//= OEntryListHelper
|
|
//=====================================================================
|
|
typedef ::cppu::ImplHelper2 < ::com::sun::star::form::binding::XListEntrySink
|
|
, ::com::sun::star::form::binding::XListEntryListener
|
|
> OEntryListHelper_BASE;
|
|
|
|
class OEntryListHelper : public OEntryListHelper_BASE
|
|
{
|
|
private:
|
|
::osl::Mutex& m_rMutex;
|
|
|
|
::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XListEntrySource >
|
|
m_xListSource; /// our external list source
|
|
::com::sun::star::uno::Sequence< ::rtl::OUString >
|
|
m_aStringItems; /// "overridden" StringItemList property value
|
|
|
|
protected:
|
|
OEntryListHelper( ::osl::Mutex& _rMutex );
|
|
OEntryListHelper( const OEntryListHelper& _rSource, ::osl::Mutex& _rMutex );
|
|
~OEntryListHelper( );
|
|
|
|
/// returns the current string item list
|
|
inline const ::com::sun::star::uno::Sequence< ::rtl::OUString >&
|
|
getStringItemList() const { return m_aStringItems; }
|
|
inline const ::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XListEntrySource >&
|
|
getExternalListEntrySource() const { return m_xListSource; }
|
|
|
|
/// determines whether we actually have an external list source
|
|
inline 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 ::com::sun::star::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 ::com::sun::star::lang::EventObject& Source ) throw (::com::sun::star::uno::RuntimeException) = 0;
|
|
|
|
/** helper for implementing convertFastPropertyValue( StringItemList )
|
|
|
|
<p>The signature of this method and the return type have the same semantics
|
|
as convertFastPropertyValue.</p>
|
|
*/
|
|
sal_Bool convertNewListSourceProperty(
|
|
::com::sun::star::uno::Any& _rConvertedValue,
|
|
::com::sun::star::uno::Any& _rOldValue,
|
|
const ::com::sun::star::uno::Any& _rValue
|
|
)
|
|
SAL_THROW( ( ::com::sun::star::lang::IllegalArgumentException ) );
|
|
|
|
/** 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 ::com::sun::star::uno::Any& _rValue );
|
|
|
|
/** 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( ) = 0;
|
|
|
|
/** called whenever a connection to a new external list source has been established
|
|
*/
|
|
virtual void connectedExternalListSource( );
|
|
|
|
/** called whenever a connection to a new external list source has been revoked
|
|
*/
|
|
virtual void disconnectedExternalListSource( );
|
|
|
|
private:
|
|
// XListEntrySink
|
|
virtual void SAL_CALL setListEntrySource( const ::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XListEntrySource >& _rxSource ) throw (::com::sun::star::uno::RuntimeException);
|
|
virtual ::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XListEntrySource > SAL_CALL getListEntrySource( ) throw (::com::sun::star::uno::RuntimeException);
|
|
|
|
// XListEntryListener
|
|
virtual void SAL_CALL entryChanged( const ::com::sun::star::form::binding::ListEntryEvent& _rSource ) throw (::com::sun::star::uno::RuntimeException);
|
|
virtual void SAL_CALL entryRangeInserted( const ::com::sun::star::form::binding::ListEntryEvent& _rSource ) throw (::com::sun::star::uno::RuntimeException);
|
|
virtual void SAL_CALL entryRangeRemoved( const ::com::sun::star::form::binding::ListEntryEvent& _rSource ) throw (::com::sun::star::uno::RuntimeException);
|
|
virtual void SAL_CALL allEntriesChanged( const ::com::sun::star::lang::EventObject& _rSource ) throw (::com::sun::star::uno::RuntimeException);
|
|
|
|
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 ::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XListEntrySource >& _rxSource
|
|
);
|
|
|
|
private:
|
|
OEntryListHelper(); // never implemented
|
|
OEntryListHelper( const OEntryListHelper& ); // never implemented
|
|
OEntryListHelper& operator=( const OEntryListHelper& ); // never implemented
|
|
};
|
|
|
|
//.........................................................................
|
|
} // namespace frm
|
|
//.........................................................................
|
|
|
|
|
|
#endif // FORMS_ENTRYLISTHELPER_HXX
|