diff options
Diffstat (limited to 'extensions/source/propctrlr/eformshelper.hxx')
| -rw-r--r-- | extensions/source/propctrlr/eformshelper.hxx | 271 |
1 files changed, 0 insertions, 271 deletions
diff --git a/extensions/source/propctrlr/eformshelper.hxx b/extensions/source/propctrlr/eformshelper.hxx deleted file mode 100644 index 53883b348..000000000 --- a/extensions/source/propctrlr/eformshelper.hxx +++ /dev/null @@ -1,271 +0,0 @@ -/* -*- 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_SOURCE_PROPCTRLR_EFORMSHELPER_HXX -#define EXTENSIONS_SOURCE_PROPCTRLR_EFORMSHELPER_HXX - -#include "pcrcommon.hxx" - -/** === begin UNO includes === **/ -#include <com/sun/star/frame/XModel.hpp> -#include <com/sun/star/beans/XPropertySet.hpp> -#include <com/sun/star/xforms/XModel.hpp> -#include <com/sun/star/xforms/XFormsSupplier.hpp> -#include <com/sun/star/form/binding/XBindableValue.hpp> -#include <com/sun/star/form/binding/XListEntrySource.hpp> -/** === end UNO includes === **/ -#include <osl/mutex.hxx> -#include <tools/string.hxx> -#include <comphelper/listenernotification.hxx> - -#include <vector> -#include <set> -#include <map> - -//........................................................................ -namespace pcr -{ -//........................................................................ - - typedef ::std::map< ::rtl::OUString, ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >, ::std::less< ::rtl::OUString > > - MapStringToPropertySet; - - //==================================================================== - //= EFormsHelper - //==================================================================== - class EFormsHelper - { - protected: - ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > - m_xControlModel; - ::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XBindableValue > - m_xBindableControl; - ::com::sun::star::uno::Reference< ::com::sun::star::xforms::XFormsSupplier > - m_xDocument; - PropertyChangeListeners - m_aPropertyListeners; - MapStringToPropertySet - m_aSubmissionUINames; // only filled upon request - MapStringToPropertySet - m_aBindingUINames; // only filled upon request - - public: - EFormsHelper( - ::osl::Mutex& _rMutex, - const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxControlModel, - const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxContextDocument - ); - - /** determines whether the given document is an eForm - - If this method returns <FALSE/>, you cannot instantiate a EFormsHelper with - this document, since then no of it's functionality will be available. - */ - static bool - isEForm( - const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxContextDocument - ) SAL_THROW(()); - - /** registers a listener to be notified when any aspect of the binding changes. - - The listener will be registered at the current binding of the control model. If the binding - changes (see <method>setBinding</method>), the listener will be revoked from the old binding, - registered at the new binding, and for all properties which differ between both bindings, - the listener will be notified. - @see revokeBindingListener - */ - void registerBindingListener( - const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& _rxBindingListener - ); - - /** revokes the binding listener which has previously been registered - @see registerBindingListener - */ - void revokeBindingListener( - const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& _rxBindingListener - ); - - /** checks whether it's possible to bind the control model to a given XSD data type - - @param _nDataType - the data type which should be bound. If this is -1, <TRUE/> is returned if the control model - can be bound to <em>any</em> data type. - */ - bool canBindToDataType( sal_Int32 _nDataType = -1 ) const SAL_THROW(()); - - /** checks whether the control model cna be bound to any XSD data type - */ - bool canBindToAnyDataType() const SAL_THROW(()) { return canBindToDataType( -1 ); } - - /** checks whether the control model is a source for list entries, as supplied by XML data bindings - */ - bool isListEntrySink() const SAL_THROW(()); - - /** retrieves the names of all XForms models in the document the control lives in - */ - void getFormModelNames( ::std::vector< ::rtl::OUString >& /* [out] */ _rModelNames ) const SAL_THROW(()); - - /** retrieves the names of all bindings for a given model - @see getFormModelNames - */ - void getBindingNames( const ::rtl::OUString& _rModelName, ::std::vector< ::rtl::OUString >& /* [out] */ _rBindingNames ) const SAL_THROW(()); - - /// retrieves the XForms model (within the control model's document) with the given name - ::com::sun::star::uno::Reference< ::com::sun::star::xforms::XModel > - getFormModelByName( const ::rtl::OUString& _rModelName ) const SAL_THROW(()); - - /** retrieves the model which the active binding of the control model belongs to - */ - ::com::sun::star::uno::Reference< ::com::sun::star::xforms::XModel > - getCurrentFormModel() const SAL_THROW(()); - - /** retrieves the name of the model which the active binding of the control model belongs to - */ - ::rtl::OUString - getCurrentFormModelName() const SAL_THROW(()); - - /** retrieves the binding instance which is currently attached to the control model - */ - ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > - getCurrentBinding() const SAL_THROW(()); - - /** retrieves the name of the binding instance which is currently attached to the control model - */ - ::rtl::OUString - getCurrentBindingName() const SAL_THROW(()); - - /** sets a new binding at the control model - */ - void setBinding( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxBinding ) SAL_THROW(()); - - /** retrieves the binding instance which is currently used as list source for the control model - @see isListEntrySink - */ - ::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XListEntrySource > - getCurrentListSourceBinding() const SAL_THROW(()); - - /** sets a new list source at the control model - @see isListEntrySink - */ - void setListSourceBinding( const ::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XListEntrySource >& _rxListSource ) SAL_THROW(()); - - /** retrieves a given binding for a given model, or creates a new one - - @param _rTargetModel - the name of the model to create a binding for. Must not be empty - @param _rBindingName - the name of the binding to retrieve. If the model denoted by <arg>_rTargetModel</arg> does not - have a binding with this name, a new binding is created and returned. - */ - ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > - getOrCreateBindingForModel( const ::rtl::OUString& _rTargetModel, const ::rtl::OUString& _rBindingName ) const SAL_THROW(()); - - /** types of sub-elements of a model - */ - enum ModelElementType - { - Submission, - Binding - }; - - /** retrieves the name of a model's sub-element, as to be shown in the UI - @see getModelElementFromUIName - @see getAllElementUINames - */ - ::rtl::OUString - getModelElementUIName( - const ModelElementType _eType, - const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxElement - ) const SAL_THROW(()); - - /** retrieves the submission object for an UI name - - Note that <member>getAllElementUINames</member> must have been called before, for the given element type - - @see getModelElementUIName - @see getAllElementUINames - */ - ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > - getModelElementFromUIName( - const ModelElementType _eType, - const ::rtl::OUString& _rUIName - ) const SAL_THROW(()); - - /** retrieves the UI names of all elements of all models in our document - @param _eType - the type of elements for which the names should be retrieved - @param _rElementNames - the array of element names - @see getModelElementUIName - @see getModelElementFromUIName - */ - void getAllElementUINames( - const ModelElementType _eType, - ::std::vector< ::rtl::OUString >& /* [out] */ _rElementNames, - bool _bPrepentEmptyEntry - ); - - protected: - void firePropertyChanges( - const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxOldProps, - const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxNewProps, - ::std::set< ::rtl::OUString >& _rFilter - ) const; - - /** fires a change in a single property, if the property value changed, and if we have a listener - interested in property changes - */ - void firePropertyChange( - const ::rtl::OUString& _rName, - const ::com::sun::star::uno::Any& _rOldValue, - const ::com::sun::star::uno::Any& _rNewValue - ) const; - - private: - void impl_switchBindingListening_throw( bool _bDoListening, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& _rxListener ); - - /// implementation for both <member>getOrCreateBindingForModel</member> - ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > - implGetOrCreateBinding( const ::rtl::OUString& _rTargetModel, const ::rtl::OUString& _rBindingName ) const SAL_THROW(()); - - void - impl_toggleBindingPropertyListening_throw( bool _bDoListen, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& _rxConcreteListenerOrNull ); - - private: - EFormsHelper(); // never implemented - EFormsHelper( const EFormsHelper& ); // never implemented - EFormsHelper& operator=( const EFormsHelper& ); // never implemented - }; - -//........................................................................ -} // namespace pcr -//........................................................................ - -#endif // EXTENSIONS_SOURCE_PROPCTRLR_EFORMSHELPER_HXX - -/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |