/*************************************************************************
*
* 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.
*
************************************************************************/
// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_svx.hxx"
#include "fmundo.hxx"
#include "fmpgeimp.hxx"
#include "svx/dbtoolsclient.hxx"
#include "svx/svditer.hxx"
#include "fmobj.hxx"
#include "fmprop.hrc"
#include "svx/fmresids.hrc"
#include "svx/fmglob.hxx"
#include "svx/dialmgr.hxx"
#include "svx/fmmodel.hxx"
#include "svx/fmpage.hxx"
/** === begin UNO includes === **/
#include <com/sun/star/util/XModifyBroadcaster.hpp>
#include <com/sun/star/beans/PropertyAttribute.hpp>
#include <com/sun/star/container/XContainer.hpp>
#include <com/sun/star/container/XContainerListener.hpp>
#include <com/sun/star/script/XEventAttacherManager.hpp>
#include <com/sun/star/form/binding/XBindableValue.hpp>
#include <com/sun/star/form/binding/XListEntrySink.hpp>
#include <com/sun/star/reflection/XInterfaceMethodTypeDescription.hpp>
/** === end UNO includes === **/
#include "svx/fmtools.hxx"
#include <rtl/logfile.hxx>
#include <svl/macitem.hxx>
#include <tools/shl.hxx>
#include <tools/diagnose_ex.h>
#include <sfx2/objsh.hxx>
#include <sfx2/docfile.hxx>
#include <sfx2/app.hxx>
#include <sfx2/sfx.hrc>
#include <sfx2/event.hxx>
#include <osl/mutex.hxx>
#include <vos/mutex.hxx>
#include <comphelper/property.hxx>
#include <comphelper/uno3.hxx>
#include <comphelper/stl_types.hxx>
#include <comphelper/componentcontext.hxx>
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::awt;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::container;
using namespace ::com::sun::star::script;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::form;
using namespace ::com::sun::star::util;
using namespace ::com::sun::star::reflection;
using namespace ::com::sun::star::form::binding;
using namespace ::svxform;
#include <com/sun/star/script/XScriptListener.hdl>
#include <comphelper/processfactory.hxx>
#include <cppuhelper/implbase1.hxx>
typedef cppu::WeakImplHelper1< XScriptListener > ScriptEventListener_BASE;
class ScriptEventListenerWrapper : public ScriptEventListener_BASE
{
public:
ScriptEventListenerWrapper( FmFormModel& _rModel) throw ( RuntimeException )
:m_rModel( _rModel )
,m_attemptedListenerCreation( false )
{
}
// XEventListener
virtual void SAL_CALL disposing(const EventObject& ) throw( RuntimeException ){}
// XScriptListener
virtual void SAL_CALL firing(const ScriptEvent& evt) throw(RuntimeException)
{
attemptListenerCreation();
if ( m_vbaListener.is() )
{
m_vbaListener->firing( evt );
}
}
virtual Any SAL_CALL approveFiring(const ScriptEvent& evt) throw( com::sun::star::reflection::InvocationTargetException, RuntimeException)
{
attemptListenerCreation();
if ( m_vbaListener.is() )
{
return m_vbaListener->approveFiring( evt );
}
return Any();
}
private:
void attemptListenerCreation()
{
if ( m_attemptedListenerCreation )
return;
m_attemptedListenerCreation = true;
try
{
::comphelper::ComponentContext const aContext( ::comphelper::getProcessServiceFactory() );
Reference< XScriptListener > const xScriptListener( aContext.createComponent( "ooo.vba.EventListener" ), UNO_QUERY_THROW );
Reference< XPropertySet > const xListenerProps( xScriptListener, UNO_QUERY_THROW );
// SfxObjectShellRef is good here since the model controls the lifetime of the shell
SfxObjectShellRef const xObjectShell = m_rModel.GetObjectShell();
ENSURE_OR_THROW( xObjectShell.Is(), "no object shell!" );
xListenerProps->setPropertyValue( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Model" ) ), makeAny( xObjectShell->GetModel() ) );
m_vbaListener = xScriptListener;
}
catch( Exception const & )
{
DBG_UNHANDLED_EXCEPTION();
}
}
FmFormModel& m_rModel;
Reference< XScriptListener > m_vbaListener;
bool m_attemptedListenerCreation;
};
//------------------------------------------------------------------------------
// some helper structs for caching property infos
//------------------------------------------------------------------------------
struct PropertyInfo
{
sal_Bool bIsTransientOrReadOnly : 1; // the property is transient or read-only, thus we need no undo action for it
sal_Bool bIsValueProperty : 1; // the property is the special value property, thus it may be handled
// as if it's transient or persistent
};
struct PropertySetInfo
{
DECLARE_STL_USTRINGACCESS_MAP(PropertyInfo, AllProperties);
AllProperties aProps; // all properties of this set which we know so far
sal_Bool bHasEmptyControlSource; // sal_True -> the set has a DataField property, and the current value is an empty string
// sal_False -> the set has _no_ such property or it's value isn't empty
};
sal_Bool operator < (const Reference< XPropertySet >& lhs,
const Reference< XPropertySet >& rhs)
{
return lhs.get() < rhs.get();
}
DECLARE_STL_STDKEY_MAP(Reference< XPropertySet >, PropertySetInfo, PropertySetInfoCache);
//------------------------------------------------------------------------------
String static_STR_UNDO_PROPERTY;
//------------------------------------------------------------------------------
DBG_NAME(FmXUndoEnvironment)
//------------------------------------------------------------------------------
FmXUndoEnvironment::FmXUndoEnvironment(FmFormModel& _rModel)
:rModel( _rModel )
,m_pPropertySetCache( NULL )
,m_pScriptingEnv( ::svxform::createDefaultFormScriptingEnvironment( _rModel ) )
,m_Locks( 0 )
,bReadOnly( sal_False )
,m_bDisposed( false )
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::FmXUndoEnvironment" );
DBG_CTOR(FmXUndoEnvironment,NULL);
try
{
m_vbaListener = new ScriptEventListenerWrapper( _rModel );
}
catch( Exception& )
{
}
}
//------------------------------------------------------------------------------
FmXUndoEnvironment::~FmXUndoEnvironment()
{
DBG_DTOR(FmXUndoEnvironment,NULL);
if (m_pPropertySetCache)
delete static_cast<PropertySetInfoCache*>(m_pPropertySetCache);
}
//------------------------------------------------------------------------------
void FmXUndoEnvironment::dispose()
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::dispose" );
OSL_ENSURE( !m_bDisposed, "FmXUndoEnvironment::dispose: disposed twice?" );
if ( !m_bDisposed )
return;
Lock();
sal_uInt16 nCount = rModel.GetPageCount();
sal_uInt16 i;
for (i = 0; i < nCount; i++)
{
FmFormPage* pPage = PTR_CAST( FmFormPage, rModel.GetPage(i) );
if ( pPage )
{
Reference< XInterface > xForms = pPage->GetForms( false ).get();
if ( xForms.is() )
RemoveElement( xForms );
}
}
nCount = rModel.GetMasterPageCount();
for (i = 0; i < nCount; i++)
{
FmFormPage* pPage = PTR_CAST( FmFormPage, rModel.GetMasterPage(i) );
if ( pPage )
{
Reference< XInterface > xForms = pPage->GetForms( false ).get();
if ( xForms.is() )
RemoveElement( xForms );
}
}
UnLock();
OSL_PRECOND( rModel.GetObjectShell(), "FmXUndoEnvironment::dispose: no object shell anymore!" );
if ( rModel.GetObjectShell() )
EndListening( *rModel.GetObjectShell() );
if ( IsListening( rModel ) )
EndListening( rModel );
m_pScriptingEnv->dispose();
m_bDisposed = true;
}
//------------------------------------------------------------------------------
void FmXUndoEnvironment::ModeChanged()
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::ModeChanged" );
OSL_PRECOND( rModel.GetObjectShell(), "FmXUndoEnvironment::ModeChanged: no object shell anymore!" );
if ( !rModel.GetObjectShell() )
return;
if (bReadOnly != (rModel.GetObjectShell()->IsReadOnly() || rModel.GetObjectShell()->IsReadOnlyUI()))
{
bReadOnly = !bReadOnly;
sal_uInt16 nCount = rModel.GetPageCount();
sal_uInt16 i;
for (i = 0; i < nCount; i++)
{
FmFormPage* pPage = PTR_CAST( FmFormPage, rModel.GetPage(i) );
if ( pPage )
{
Reference< XInterface > xForms = pPage->GetForms( false ).get();
if ( xForms.is() )
TogglePropertyListening( xForms );
}
}
nCount = rModel.GetMasterPageCount();
for (i = 0; i < nCount; i++)
{
FmFormPage* pPage = PTR_CAST( FmFormPage, rModel.GetMasterPage(i) );
if ( pPage )
{
Reference< XInterface > xForms = pPage->GetForms( false ).get();
if ( xForms.is() )
TogglePropertyListening( xForms );
}
}
if (!bReadOnly)
StartListening(rModel);
else
EndListening(rModel);
}
}
//------------------------------------------------------------------------------
void FmXUndoEnvironment::Notify( SfxBroadcaster& /*rBC*/, const SfxHint& rHint )
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::Notify" );
if (rHint.ISA(SdrHint))
{
SdrHint* pSdrHint = (SdrHint*)&rHint;
switch( pSdrHint->GetKind() )
{
case HINT_OBJINSERTED:
{
SdrObject* pSdrObj = (SdrObject*)pSdrHint->GetObject();
Inserted( pSdrObj );
} break;
case HINT_OBJREMOVED:
{
SdrObject* pSdrObj = (SdrObject*)pSdrHint->GetObject();
Removed( pSdrObj );
}
break;
default:
break;
}
}
else if (rHint.ISA(SfxSimpleHint))
{
switch ( ((SfxSimpleHint&)rHint).GetId() )
{
case SFX_HINT_DYING:
dispose();
rModel.SetObjectShell( NULL );
break;
case SFX_HINT_MODECHANGED:
ModeChanged();
break;
}
}
else if (rHint.ISA(SfxEventHint))
{
switch (((SfxEventHint&)rHint).GetEventId())
{
case SFX_EVENT_CREATEDOC:
case SFX_EVENT_OPENDOC:
ModeChanged();
break;
}
}
}
//------------------------------------------------------------------
void FmXUndoEnvironment::Inserted(SdrObject* pObj)
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::Inserted" );
if (pObj->GetObjInventor() == FmFormInventor)
{
FmFormObj* pFormObj = PTR_CAST(FmFormObj, pObj);
Inserted( pFormObj );
}
else if (pObj->IsGroupObject())
{
SdrObjListIter aIter(*pObj->GetSubList());
while ( aIter.IsMore() )
Inserted( aIter.Next() );
}
}
//------------------------------------------------------------------------------
namespace
{
sal_Bool lcl_searchElement(const Reference< XIndexAccess>& xCont, const Reference< XInterface >& xElement)
{
if (!xCont.is() || !xElement.is())
return sal_False;
sal_Int32 nCount = xCont->getCount();
Reference< XInterface > xComp;
for (sal_Int32 i = 0; i < nCount; i++)
{
try
{
xCont->getByIndex(i) >>= xComp;
if (xComp.is())
{
if ( xElement == xComp )
return sal_True;
else
{
Reference< XIndexAccess> xCont2(xComp, UNO_QUERY);
if (xCont2.is() && lcl_searchElement(xCont2, xElement))
return sal_True;
}
}
}
catch(const Exception&)
{
DBG_UNHANDLED_EXCEPTION();
}
}
return sal_False;
}
}
//------------------------------------------------------------------------------
void FmXUndoEnvironment::Inserted(FmFormObj* pObj)
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::Inserted" );
DBG_ASSERT( pObj, "FmXUndoEnvironment::Inserted: invalid object!" );
if ( !pObj )
return;
// ist das Control noch einer Form zugeordnet
Reference< XInterface > xModel(pObj->GetUnoControlModel(), UNO_QUERY);
Reference< XFormComponent > xContent(xModel, UNO_QUERY);
if (xContent.is() && pObj->GetPage())
{
// if the component doesn't belong to a form, yet, find one to insert into
if (!xContent->getParent().is())
{
try
{
Reference< XIndexContainer > xObjectParent = pObj->GetOriginalParent();
FmFormPage& rPage = dynamic_cast< FmFormPage& >( *pObj->GetPage() );
Reference< XIndexAccess > xForms( rPage.GetForms(), UNO_QUERY_THROW );
Reference< XIndexContainer > xNewParent;
Reference< XForm > xForm;
sal_Int32 nPos = -1;
if ( lcl_searchElement( xForms, xObjectParent ) )
{
// the form which was the parent of the object when it was removed is still
// part of the form component hierachy of the current page
xNewParent = xObjectParent;
xForm.set( xNewParent, UNO_QUERY_THROW );
nPos = ::std::min( pObj->GetOriginalIndex(), xNewParent->getCount() );
}
else
{
xForm.set( rPage.GetImpl().findPlaceInFormComponentHierarchy( xContent ), UNO_SET_THROW );
xNewParent.set( xForm, UNO_QUERY_THROW );
nPos = xNewParent->getCount();
}
rPage.GetImpl().setUniqueName( xContent, xForm );
xNewParent->insertByIndex( nPos, makeAny( xContent ) );
Reference< XEventAttacherManager > xManager( xNewParent, UNO_QUERY_THROW );
xManager->registerScriptEvents( nPos, pObj->GetOriginalEvents() );
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
}
// FormObject zuruecksetzen
pObj->ClearObjEnv();
}
}
//------------------------------------------------------------------
void FmXUndoEnvironment::Removed(SdrObject* pObj)
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::Removed" );
if ( pObj->IsVirtualObj() )
// for virtual objects, we've already been notified of the removal of the master
// object, which is sufficient here
return;
if (pObj->GetObjInventor() == FmFormInventor)
{
FmFormObj* pFormObj = PTR_CAST(FmFormObj, pObj);
Removed(pFormObj);
}
else if (pObj->IsGroupObject())
{
SdrObjListIter aIter(*pObj->GetSubList());
while ( aIter.IsMore() )
Removed( aIter.Next() );
}
}
//------------------------------------------------------------------------------
void FmXUndoEnvironment::Removed(FmFormObj* pObj)
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::Removed" );
DBG_ASSERT( pObj, "FmXUndoEnvironment::Removed: invalid object!" );
if ( !pObj )
return;
// ist das Control noch einer Form zugeordnet
Reference< XFormComponent > xContent(pObj->GetUnoControlModel(), UNO_QUERY);
if (xContent.is())
{
// das Object wird aus einer Liste herausgenommen
// existiert ein Vater wird das Object beim beim Vater entfernt und
// am FormObject gemerkt!
// wird das Object wieder eingefuegt und ein Parent existiert, so wird dieser
// Parent wiederum gesetzt
Reference< XIndexContainer > xForm(xContent->getParent(), UNO_QUERY);
if (xForm.is())
{
Reference< XIndexAccess > xIndexAccess((XIndexContainer*)xForm.get());
// Feststellen an welcher Position sich das Kind befunden hat
const sal_Int32 nPos = getElementPos(xIndexAccess, xContent);
if (nPos >= 0)
{
Sequence< ScriptEventDescriptor > aEvts;
Reference< XEventAttacherManager > xManager(xForm, UNO_QUERY);
if (xManager.is())
aEvts = xManager->getScriptEvents(nPos);
try
{
pObj->SetObjEnv(xForm, nPos, aEvts);
xForm->removeByIndex(nPos);
}
catch(Exception&)
{
DBG_UNHANDLED_EXCEPTION();
}
}
}
}
}
// XEventListener
//------------------------------------------------------------------------------
void SAL_CALL FmXUndoEnvironment::disposing(const EventObject& e) throw( RuntimeException )
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::disposing" );
// check if it's an object we have cached informations about
if (m_pPropertySetCache)
{
Reference< XPropertySet > xSourceSet(e.Source, UNO_QUERY);
if (xSourceSet.is())
{
PropertySetInfoCache* pCache = static_cast<PropertySetInfoCache*>(m_pPropertySetCache);
PropertySetInfoCacheIterator aSetPos = pCache->find(xSourceSet);
if (aSetPos != pCache->end())
pCache->erase(aSetPos);
}
}
}
// XPropertyChangeListener
//------------------------------------------------------------------------------
void SAL_CALL FmXUndoEnvironment::propertyChange(const PropertyChangeEvent& evt) throw(::com::sun::star::uno::RuntimeException)
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::propertyChange" );
::osl::ClearableMutexGuard aGuard( m_aMutex );
if (!IsLocked())
{
Reference< XPropertySet > xSet(evt.Source, UNO_QUERY);
if (!xSet.is())
return;
// if it's a "default value" property of a control model, set the according "value" property
static ::rtl::OUString pDefaultValueProperties[] = {
FM_PROP_DEFAULT_TEXT, FM_PROP_DEFAULTCHECKED, FM_PROP_DEFAULT_DATE, FM_PROP_DEFAULT_TIME,
FM_PROP_DEFAULT_VALUE, FM_PROP_DEFAULT_SELECT_SEQ, FM_PROP_EFFECTIVE_DEFAULT
};
const ::rtl::OUString aValueProperties[] = {
FM_PROP_TEXT, FM_PROP_STATE, FM_PROP_DATE, FM_PROP_TIME,
FM_PROP_VALUE, FM_PROP_SELECT_SEQ, FM_PROP_EFFECTIVE_VALUE
};
sal_Int32 nDefaultValueProps = sizeof(pDefaultValueProperties)/sizeof(pDefaultValueProperties[0]);
OSL_ENSURE(sizeof(aValueProperties)/sizeof(aValueProperties[0]) == nDefaultValueProps,
"FmXUndoEnvironment::propertyChange: inconsistence!");
for (sal_Int32 i=0; i<nDefaultValueProps; ++i)
{
if (0 == evt.PropertyName.compareTo(pDefaultValueProperties[i]))
{
try
{
xSet->setPropertyValue(aValueProperties[i], evt.NewValue);
}
catch(const Exception&)
{
OSL_ENSURE(sal_False, "FmXUndoEnvironment::propertyChange: could not adjust the value property!");
}
}
}
// no Undo for transient and readonly props. But unfortunately "transient" is not only that the
// "transient" flag is set for the property in question, instead is is somewhat more complex
// Transience criterions are:
// - the "transient" flag is set for the property
// - OR the control has a non-empty COntrolSource property, i.e. is intended to be bound
// to a database column. Note that it doesn't matter here whether the control actually
// *is* bound to a column
// - OR the control is bound to an external value via XBindableValue/XValueBinding
// which does not have a "ExternalData" property being <TRUE/>
if (!m_pPropertySetCache)
m_pPropertySetCache = new PropertySetInfoCache;
PropertySetInfoCache* pCache = static_cast<PropertySetInfoCache*>(m_pPropertySetCache);
// let's see if we know something about the set
PropertySetInfoCacheIterator aSetPos = pCache->find(xSet);
if (aSetPos == pCache->end())
{
PropertySetInfo aNewEntry;
if (!::comphelper::hasProperty(FM_PROP_CONTROLSOURCE, xSet))
{
aNewEntry.bHasEmptyControlSource = sal_False;
}
else
{
try
{
Any aCurrentControlSource = xSet->getPropertyValue(FM_PROP_CONTROLSOURCE);
aNewEntry.bHasEmptyControlSource = !aCurrentControlSource.hasValue() || (::comphelper::getString(aCurrentControlSource).getLength() == 0);
}
catch(const Exception&)
{
DBG_UNHANDLED_EXCEPTION();
}
}
aSetPos = pCache->insert(PropertySetInfoCache::value_type(xSet,aNewEntry)).first;
DBG_ASSERT(aSetPos != pCache->end(), "FmXUndoEnvironment::propertyChange : just inserted it ... why it's not there ?");
}
else
{ // is it the DataField property ?
if (evt.PropertyName.equals(FM_PROP_CONTROLSOURCE))
{
aSetPos->second.bHasEmptyControlSource = !evt.NewValue.hasValue() || (::comphelper::getString(evt.NewValue).getLength() == 0);
}
}
// now we have access to the cached info about the set
// let's see what we know about the property
PropertySetInfo::AllProperties& rPropInfos = aSetPos->second.aProps;
PropertySetInfo::AllPropertiesIterator aPropertyPos = rPropInfos.find(evt.PropertyName);
if (aPropertyPos == rPropInfos.end())
{ // nothing 'til now ... have to change this ....
PropertyInfo aNewEntry;
// the attributes
sal_Int32 nAttributes = xSet->getPropertySetInfo()->getPropertyByName(evt.PropertyName).Attributes;
aNewEntry.bIsTransientOrReadOnly = ((nAttributes & PropertyAttribute::READONLY) != 0) || ((nAttributes & PropertyAttribute::TRANSIENT) != 0);
// check if it is the special "DataFieldProperty"
aNewEntry.bIsValueProperty = sal_False;
try
{
if (::comphelper::hasProperty(FM_PROP_CONTROLSOURCEPROPERTY, xSet))
{
Any aControlSourceProperty = xSet->getPropertyValue(FM_PROP_CONTROLSOURCEPROPERTY);
::rtl::OUString sControlSourceProperty;
aControlSourceProperty >>= sControlSourceProperty;
aNewEntry.bIsValueProperty = (sControlSourceProperty.equals(evt.PropertyName));
}
}
catch(const Exception&)
{
DBG_UNHANDLED_EXCEPTION();
}
// insert the new entry
aPropertyPos = rPropInfos.insert(PropertySetInfo::AllProperties::value_type(evt.PropertyName,aNewEntry)).first;
DBG_ASSERT(aPropertyPos != rPropInfos.end(), "FmXUndoEnvironment::propertyChange : just inserted it ... why it's not there ?");
}
// now we have access to the cached info about the property affected
// and are able to decide wether or not we need an undo action
bool bAddUndoAction = rModel.IsUndoEnabled();
// no UNDO for transient/readonly properties
if ( bAddUndoAction && aPropertyPos->second.bIsTransientOrReadOnly )
bAddUndoAction = false;
if ( bAddUndoAction && aPropertyPos->second.bIsValueProperty )
{
// no UNDO when the "value" property changes, but the ControlSource is non-empty
// (in this case the control is intended to be bound to a database column)
if ( !aSetPos->second.bHasEmptyControlSource )
bAddUndoAction = false;
// no UNDO if the control is currently bound to an external value
if ( bAddUndoAction )
{
Reference< XBindableValue > xBindable( evt.Source, UNO_QUERY );
Reference< XValueBinding > xBinding;
if ( xBindable.is() )
xBinding = xBindable->getValueBinding();
Reference< XPropertySet > xBindingProps;
Reference< XPropertySetInfo > xBindingPropsPSI;
if ( xBindable.is() )
xBindingProps.set( xBinding, UNO_QUERY );
if ( xBindingProps.is() )
xBindingPropsPSI = xBindingProps->getPropertySetInfo();
// TODO: we should cache all those things, else this might be too expensive.
// However, this requires we're notified of changes in the value binding
static const ::rtl::OUString s_sExternalData( RTL_CONSTASCII_USTRINGPARAM( "ExternalData" ) );
if ( xBindingPropsPSI.is() && xBindingPropsPSI->hasPropertyByName( s_sExternalData ) )
{
sal_Bool bExternalData = sal_True;
OSL_VERIFY( xBindingProps->getPropertyValue( s_sExternalData ) >>= bExternalData );
bAddUndoAction = !bExternalData;
}
else
bAddUndoAction = !xBinding.is();
}
}
if ( bAddUndoAction && ( evt.PropertyName == FM_PROP_STRINGITEMLIST ) )
{
Reference< XListEntrySink > xSink( evt.Source, UNO_QUERY );
if ( xSink.is() && xSink->getListEntrySource().is() )
// #i41029# / 2005-01-31 / frank.schoenheit@sun.com
bAddUndoAction = false;
}
if ( bAddUndoAction )
{
aGuard.clear();
// TODO: this is a potential race condition: two threads here could in theory
// add their undo actions out-of-order
::vos::OClearableGuard aSolarGuard( Application::GetSolarMutex() );
rModel.AddUndo(new FmUndoPropertyAction(rModel, evt));
}
}
else
{
// if it's the DataField property we may have to adjust our cache
if (m_pPropertySetCache && evt.PropertyName.equals(FM_PROP_CONTROLSOURCE))
{
Reference< XPropertySet > xSet(evt.Source, UNO_QUERY);
PropertySetInfoCache* pCache = static_cast<PropertySetInfoCache*>(m_pPropertySetCache);
PropertySetInfo& rSetInfo = (*pCache)[xSet];
rSetInfo.bHasEmptyControlSource = !evt.NewValue.hasValue() || (::comphelper::getString(evt.NewValue).getLength() == 0);
}
}
}
// XContainerListener
//------------------------------------------------------------------------------
void SAL_CALL FmXUndoEnvironment::elementInserted(const ContainerEvent& evt) throw(::com::sun::star::uno::RuntimeException)
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::elementInserted" );
::vos::OClearableGuard aSolarGuard( Application::GetSolarMutex() );
::osl::MutexGuard aGuard( m_aMutex );
// neues Object zum lauschen
Reference< XInterface > xIface;
evt.Element >>= xIface;
OSL_ENSURE(xIface.is(), "FmXUndoEnvironment::elementInserted: invalid container notification!");
AddElement(xIface);
implSetModified();
}
//------------------------------------------------------------------------------
void FmXUndoEnvironment::implSetModified()
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::implSetModified" );
if ( !IsLocked() && rModel.GetObjectShell() )
{
rModel.GetObjectShell()->SetModified( sal_True );
}
}
//------------------------------------------------------------------------------
void SAL_CALL FmXUndoEnvironment::elementReplaced(const ContainerEvent& evt) throw(::com::sun::star::uno::RuntimeException)
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::elementReplaced" );
::vos::OClearableGuard aSolarGuard( Application::GetSolarMutex() );
::osl::MutexGuard aGuard( m_aMutex );
Reference< XInterface > xIface;
evt.ReplacedElement >>= xIface;
OSL_ENSURE(xIface.is(), "FmXUndoEnvironment::elementReplaced: invalid container notification!");
RemoveElement(xIface);
evt.Element >>= xIface;
AddElement(xIface);
implSetModified();
}
//------------------------------------------------------------------------------
void SAL_CALL FmXUndoEnvironment::elementRemoved(const ContainerEvent& evt) throw(::com::sun::star::uno::RuntimeException)
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::elementRemoved" );
::vos::OClearableGuard aSolarGuard( Application::GetSolarMutex() );
::osl::MutexGuard aGuard( m_aMutex );
Reference< XInterface > xIface( evt.Element, UNO_QUERY );
OSL_ENSURE(xIface.is(), "FmXUndoEnvironment::elementRemoved: invalid container notification!");
RemoveElement(xIface);
implSetModified();
}
//------------------------------------------------------------------------------
void SAL_CALL FmXUndoEnvironment::modified( const EventObject& /*aEvent*/ ) throw (RuntimeException)
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::modified" );
implSetModified();
}
//------------------------------------------------------------------------------
void FmXUndoEnvironment::AddForms(const Reference< XNameContainer > & rForms)
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::AddForms" );
Lock();
Reference< XInterface > xInt(rForms, UNO_QUERY);
AddElement(xInt);
UnLock();
}
//------------------------------------------------------------------------------
void FmXUndoEnvironment::RemoveForms(const Reference< XNameContainer > & rForms)
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::RemoveForms" );
Lock();
Reference< XInterface > xInt(rForms, UNO_QUERY);
RemoveElement(xInt);
UnLock();
}
//------------------------------------------------------------------------------
void FmXUndoEnvironment::TogglePropertyListening(const Reference< XInterface > & Element)
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::TogglePropertyListening" );
// am Container horchen
Reference< XIndexContainer > xContainer(Element, UNO_QUERY);
if (xContainer.is())
{
sal_uInt32 nCount = xContainer->getCount();
Reference< XInterface > xIface;
for (sal_uInt32 i = 0; i < nCount; i++)
{
xContainer->getByIndex(i) >>= xIface;
TogglePropertyListening(xIface);
}
}
Reference< XPropertySet > xSet(Element, UNO_QUERY);
if (xSet.is())
{
if (!bReadOnly)
xSet->addPropertyChangeListener( ::rtl::OUString(), this );
else
xSet->removePropertyChangeListener( ::rtl::OUString(), this );
}
}
//------------------------------------------------------------------------------
void FmXUndoEnvironment::switchListening( const Reference< XIndexContainer >& _rxContainer, bool _bStartListening ) SAL_THROW(())
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::switchListening" );
OSL_PRECOND( _rxContainer.is(), "FmXUndoEnvironment::switchListening: invalid container!" );
if ( !_rxContainer.is() )
return;
try
{
// if it's an EventAttacherManager, then we need to listen for
// script events
Reference< XEventAttacherManager > xManager( _rxContainer, UNO_QUERY );
if ( xManager.is() )
{
if ( _bStartListening )
{
m_pScriptingEnv->registerEventAttacherManager( xManager );
if ( m_vbaListener.is() )
xManager->addScriptListener( m_vbaListener );
}
else
{
m_pScriptingEnv->revokeEventAttacherManager( xManager );
if ( m_vbaListener.is() )
xManager->removeScriptListener( m_vbaListener );
}
}
// also handle all children of this element
sal_uInt32 nCount = _rxContainer->getCount();
Reference< XInterface > xInterface;
for ( sal_uInt32 i = 0; i < nCount; ++i )
{
_rxContainer->getByIndex( i ) >>= xInterface;
if ( _bStartListening )
AddElement( xInterface );
else
RemoveElement( xInterface );
}
// be notified of any changes in the container elements
Reference< XContainer > xSimpleContainer( _rxContainer, UNO_QUERY );
OSL_ENSURE( xSimpleContainer.is(), "FmXUndoEnvironment::switchListening: how are we expected to be notified of changes in the container?" );
if ( xSimpleContainer.is() )
{
if ( _bStartListening )
xSimpleContainer->addContainerListener( this );
else
xSimpleContainer->removeContainerListener( this );
}
}
catch( const Exception& )
{
OSL_ENSURE( sal_False, "FmXUndoEnvironment::switchListening: caught an exception!" );
}
}
//------------------------------------------------------------------------------
void FmXUndoEnvironment::switchListening( const Reference< XInterface >& _rxObject, bool _bStartListening ) SAL_THROW(())
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::switchListening" );
OSL_PRECOND( _rxObject.is(), "FmXUndoEnvironment::switchListening: how should I listen at a NULL object?" );
try
{
if ( !bReadOnly )
{
Reference< XPropertySet > xProps( _rxObject, UNO_QUERY );
if ( xProps.is() )
{
if ( _bStartListening )
xProps->addPropertyChangeListener( ::rtl::OUString(), this );
else
xProps->removePropertyChangeListener( ::rtl::OUString(), this );
}
}
Reference< XModifyBroadcaster > xBroadcaster( _rxObject, UNO_QUERY );
if ( xBroadcaster.is() )
{
if ( _bStartListening )
xBroadcaster->addModifyListener( this );
else
xBroadcaster->removeModifyListener( this );
}
}
catch( const Exception& )
{
OSL_ENSURE( sal_False, "FmXUndoEnvironment::switchListening: caught an exception!" );
}
}
//------------------------------------------------------------------------------
void FmXUndoEnvironment::AddElement(const Reference< XInterface >& _rxElement )
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::AddElement" );
OSL_ENSURE( !m_bDisposed, "FmXUndoEnvironment::AddElement: not when I'm already disposed!" );
// am Container horchen
Reference< XIndexContainer > xContainer( _rxElement, UNO_QUERY );
if ( xContainer.is() )
switchListening( xContainer, true );
switchListening( _rxElement, true );
}
//------------------------------------------------------------------------------
void FmXUndoEnvironment::RemoveElement(const Reference< XInterface >& _rxElement)
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmXUndoEnvironment::RemoveElement" );
if ( m_bDisposed )
return;
switchListening( _rxElement, false );
if (!bReadOnly)
{
// reset the ActiveConnection if the form is to be removed. This will (should) free the resources
// associated with this connection
// 86299 - 05/02/2001 - frank.schoenheit@germany.sun.com
Reference< XForm > xForm( _rxElement, UNO_QUERY );
Reference< XPropertySet > xFormProperties( xForm, UNO_QUERY );
if ( xFormProperties.is() )
if ( !::svxform::OStaticDataAccessTools().isEmbeddedInDatabase( _rxElement ) )
// (if there is a connection in the context of the component, setting
// a new connection would be vetoed, anyway)
// #i34196# - 2004-09-21 - fs@openoffice.org
xFormProperties->setPropertyValue( FM_PROP_ACTIVE_CONNECTION, Any() );
}
Reference< XIndexContainer > xContainer( _rxElement, UNO_QUERY );
if ( xContainer.is() )
switchListening( xContainer, false );
}
//------------------------------------------------------------------------------
FmUndoPropertyAction::FmUndoPropertyAction(FmFormModel& rNewMod, const PropertyChangeEvent& evt)
:SdrUndoAction(rNewMod)
,xObj(evt.Source, UNO_QUERY)
,aPropertyName(evt.PropertyName)
,aNewValue(evt.NewValue)
,aOldValue(evt.OldValue)
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmUndoPropertyAction::FmUndoPropertyAction" );
if (rNewMod.GetObjectShell())
rNewMod.GetObjectShell()->SetModified(sal_True);
if(static_STR_UNDO_PROPERTY.Len() == 0)
static_STR_UNDO_PROPERTY = SVX_RES(RID_STR_UNDO_PROPERTY);
}
//------------------------------------------------------------------------------
void FmUndoPropertyAction::Undo()
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmUndoPropertyAction::Undo" );
FmXUndoEnvironment& rEnv = ((FmFormModel&)rMod).GetUndoEnv();
if (xObj.is() && !rEnv.IsLocked())
{
rEnv.Lock();
try
{
xObj->setPropertyValue( aPropertyName, aOldValue );
}
catch( const Exception& )
{
OSL_ENSURE( sal_False, "FmUndoPropertyAction::Undo: caught an exception!" );
}
rEnv.UnLock();
}
}
//------------------------------------------------------------------------------
void FmUndoPropertyAction::Redo()
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmUndoPropertyAction::Redo" );
FmXUndoEnvironment& rEnv = ((FmFormModel&)rMod).GetUndoEnv();
if (xObj.is() && !rEnv.IsLocked())
{
rEnv.Lock();
try
{
xObj->setPropertyValue( aPropertyName, aNewValue );
}
catch( const Exception& )
{
OSL_ENSURE( sal_False, "FmUndoPropertyAction::Redo: caught an exception!" );
}
rEnv.UnLock();
}
}
//------------------------------------------------------------------------------
String FmUndoPropertyAction::GetComment() const
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmUndoPropertyAction::GetComment" );
String aStr(static_STR_UNDO_PROPERTY);
aStr.SearchAndReplace( '#', aPropertyName );
return aStr;
}
DBG_NAME(FmUndoContainerAction);
//------------------------------------------------------------------------------
FmUndoContainerAction::FmUndoContainerAction(FmFormModel& _rMod,
Action _eAction,
const Reference< XIndexContainer > & xCont,
const Reference< XInterface > & xElem,
sal_Int32 nIdx)
:SdrUndoAction( _rMod )
,m_xContainer( xCont )
,m_nIndex( nIdx )
,m_eAction( _eAction )
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmUndoContainerAction::FmUndoContainerAction" );
OSL_ENSURE( nIdx >= 0, "FmUndoContainerAction::FmUndoContainerAction: invalid index!" );
// some old code suggested this could be a valid argument. However, this code was
// buggy, and it *seemed* that nobody used it - so it was removed.
DBG_CTOR(FmUndoContainerAction,NULL);
if ( xCont.is() && xElem.is() )
{
// normalize
m_xElement = m_xElement.query( xElem );
if ( m_eAction == Removed )
{
if (m_nIndex >= 0)
{
Reference< XEventAttacherManager > xManager( xCont, UNO_QUERY );
if ( xManager.is() )
m_aEvents = xManager->getScriptEvents(m_nIndex);
}
else
m_xElement = NULL;
// we now own the element
m_xOwnElement = m_xElement;
}
}
}
//------------------------------------------------------------------------------
FmUndoContainerAction::~FmUndoContainerAction()
{
// if we own the object ....
DisposeElement( m_xOwnElement );
DBG_DTOR(FmUndoContainerAction,NULL);
}
//------------------------------------------------------------------------------
void FmUndoContainerAction::DisposeElement( const Reference< XInterface > & xElem )
{
Reference< XComponent > xComp( xElem, UNO_QUERY );
if ( xComp.is() )
{
// and the object does not have a parent
Reference< XChild > xChild( xElem, UNO_QUERY );
if ( xChild.is() && !xChild->getParent().is() )
// -> dispose it
xComp->dispose();
}
}
//------------------------------------------------------------------------------
void FmUndoContainerAction::implReInsert( ) SAL_THROW( ( Exception ) )
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmUndoContainerAction::implReInsert" );
if ( m_xContainer->getCount() >= m_nIndex )
{
// insert the element
Any aVal;
if ( m_xContainer->getElementType() == ::getCppuType( static_cast< const Reference< XFormComponent >* >( NULL ) ) )
{
aVal <<= Reference< XFormComponent >( m_xElement, UNO_QUERY );
}
else
{
aVal <<= Reference< XForm >( m_xElement, UNO_QUERY );
}
m_xContainer->insertByIndex( m_nIndex, aVal );
OSL_ENSURE( getElementPos( m_xContainer.get(), m_xElement ) == m_nIndex, "FmUndoContainerAction::implReInsert: insertion did not work!" );
// register the events
Reference< XEventAttacherManager > xManager( m_xContainer, UNO_QUERY );
if ( xManager.is() )
xManager->registerScriptEvents( m_nIndex, m_aEvents );
// we don't own the object anymore
m_xOwnElement = NULL;
}
}
//------------------------------------------------------------------------------
void FmUndoContainerAction::implReRemove( ) SAL_THROW( ( Exception ) )
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmUndoContainerAction::implReRemove" );
Reference< XInterface > xElement;
if ( ( m_nIndex >= 0 ) && ( m_nIndex < m_xContainer->getCount() ) )
m_xContainer->getByIndex( m_nIndex ) >>= xElement;
if ( xElement != m_xElement )
{
// the indexes in the container changed. Okay, so go the long way and
// manually determine the index
m_nIndex = getElementPos( m_xContainer.get(), m_xElement );
if ( m_nIndex != -1 )
xElement = m_xElement;
}
OSL_ENSURE( xElement == m_xElement, "FmUndoContainerAction::implReRemove: cannot find the element which I'm responsible for!" );
if ( xElement == m_xElement )
{
Reference< XEventAttacherManager > xManager( m_xContainer, UNO_QUERY );
if ( xManager.is() )
m_aEvents = xManager->getScriptEvents( m_nIndex );
m_xContainer->removeByIndex( m_nIndex );
// from now on, we own this object
m_xOwnElement = m_xElement;
}
}
//------------------------------------------------------------------------------
void FmUndoContainerAction::Undo()
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmUndoContainerAction::Undo" );
FmXUndoEnvironment& rEnv = static_cast< FmFormModel& >( rMod ).GetUndoEnv();
if ( m_xContainer.is() && !rEnv.IsLocked() && m_xElement.is() )
{
rEnv.Lock();
try
{
switch ( m_eAction )
{
case Inserted:
implReRemove();
break;
case Removed:
implReInsert();
break;
}
}
catch( const Exception& )
{
OSL_ENSURE( sal_False, "FmUndoContainerAction::Undo: caught an exception!" );
}
rEnv.UnLock();
}
}
//------------------------------------------------------------------------------
void FmUndoContainerAction::Redo()
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmUndoContainerAction::Redo" );
FmXUndoEnvironment& rEnv = static_cast< FmFormModel& >( rMod ).GetUndoEnv();
if ( m_xContainer.is() && !rEnv.IsLocked() && m_xElement.is() )
{
rEnv.Lock();
try
{
switch ( m_eAction )
{
case Inserted:
implReInsert();
break;
case Removed:
implReRemove();
break;
}
}
catch( const Exception& )
{
OSL_ENSURE( sal_False, "FmUndoContainerAction::Redo: caught an exception!" );
}
rEnv.UnLock();
}
}
//------------------------------------------------------------------------------
FmUndoModelReplaceAction::FmUndoModelReplaceAction(FmFormModel& _rMod, SdrUnoObj* _pObject, const Reference< XControlModel > & _xReplaced)
:SdrUndoAction(_rMod)
,m_xReplaced(_xReplaced)
,m_pObject(_pObject)
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmUndoModelReplaceAction::FmUndoModelReplaceAction" );
}
//------------------------------------------------------------------------------
FmUndoModelReplaceAction::~FmUndoModelReplaceAction()
{
// dispose our element if nobody else is responsible for
DisposeElement(m_xReplaced);
}
//------------------------------------------------------------------------------
void FmUndoModelReplaceAction::DisposeElement( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel>& xReplaced )
{
Reference< XComponent > xComp(xReplaced, UNO_QUERY);
if (xComp.is())
{
Reference< XChild > xChild(xReplaced, UNO_QUERY);
if (!xChild.is() || !xChild->getParent().is())
xComp->dispose();
}
}
//------------------------------------------------------------------------------
void FmUndoModelReplaceAction::Undo()
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmUndoModelReplaceAction::Undo" );
try
{
Reference< XControlModel > xCurrentModel( m_pObject->GetUnoControlModel() );
// replace the model within the parent
Reference< XChild > xCurrentAsChild( xCurrentModel, UNO_QUERY );
Reference< XNameContainer > xCurrentsParent;
if ( xCurrentAsChild.is() )
xCurrentsParent = xCurrentsParent.query( xCurrentAsChild->getParent() );
DBG_ASSERT( xCurrentsParent.is(), "FmUndoModelReplaceAction::Undo: invalid current model!" );
if ( xCurrentsParent.is() )
{
// the form container works with FormComponents
Reference< XFormComponent > xComponent( m_xReplaced, UNO_QUERY );
DBG_ASSERT( xComponent.is(), "FmUndoModelReplaceAction::Undo: the new model is no form component !" );
Reference< XPropertySet > xCurrentAsSet( xCurrentModel, UNO_QUERY );
DBG_ASSERT( ::comphelper::hasProperty(FM_PROP_NAME, xCurrentAsSet ), "FmUndoModelReplaceAction::Undo : one of the models is invalid !");
::rtl::OUString sName;
xCurrentAsSet->getPropertyValue( FM_PROP_NAME ) >>= sName;
xCurrentsParent->replaceByName( sName, makeAny( xComponent ) );
m_pObject->SetUnoControlModel(m_xReplaced);
m_pObject->SetChanged();
m_xReplaced = xCurrentModel;
}
}
catch(Exception&)
{
DBG_ERROR("FmUndoModelReplaceAction::Undo : could not replace the model !");
}
}
//------------------------------------------------------------------------------
String FmUndoModelReplaceAction::GetComment() const
{
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "svx", "Ocke.Janssen@sun.com", "FmUndoModelReplaceAction::GetComment" );
return SVX_RES(RID_STR_UNDO_MODEL_REPLACE);
}