office-gobmx/reportdesign/inc/UndoEnv.hxx
2010-10-27 12:33:13 +01:00

152 lines
6.2 KiB
C++

/* -*- 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 INCLUDED_UNDOENV_HXX
#define INCLUDED_UNDOENV_HXX
#include <com/sun/star/beans/XPropertyChangeListener.hpp>
#include <com/sun/star/beans/PropertyChangeEvent.hpp>
#include <com/sun/star/container/XContainerListener.hpp>
#include <com/sun/star/report/XReportDefinition.hpp>
#include <memory>
#include <svl/lstner.hxx>
namespace rptui
{
class OXUndoEnvironmentImpl;
//========================================================================
class REPORTDESIGN_DLLPUBLIC OXUndoEnvironment
: public ::cppu::WeakImplHelper3< ::com::sun::star::beans::XPropertyChangeListener
, ::com::sun::star::container::XContainerListener
, ::com::sun::star::util::XModifyListener
>
, public SfxListener
{
const ::std::auto_ptr<OXUndoEnvironmentImpl> m_pImpl;
OXUndoEnvironment(const OXUndoEnvironment&);
OXUndoEnvironment& operator=(const OXUndoEnvironment&);
protected:
virtual ~OXUndoEnvironment();
void SetUndoMode(sal_Bool _bUndo);
public:
OXUndoEnvironment(OReportModel& _rModel);
/**
Create an object ob OUndoEnvLock locks the undo possibility
As long as in the OUndoEnvLock scope, no undo is possible for manipulated object.
*/
class OUndoEnvLock
{
OXUndoEnvironment& m_rUndoEnv;
public:
OUndoEnvLock(OXUndoEnvironment& _rUndoEnv): m_rUndoEnv(_rUndoEnv){m_rUndoEnv.Lock();}
~OUndoEnvLock(){ m_rUndoEnv.UnLock(); }
};
/**
This is near the same as OUndoEnvLock but it is also possible to ask for the current mode.
UndoMode will set if SID_UNDO is called in execute()
*/
class OUndoMode
{
OXUndoEnvironment& m_rUndoEnv;
public:
OUndoMode(OXUndoEnvironment& _rUndoEnv)
:m_rUndoEnv(_rUndoEnv)
{
m_rUndoEnv.Lock();
m_rUndoEnv.SetUndoMode(sal_True);
}
~OUndoMode()
{
m_rUndoEnv.SetUndoMode(sal_False);
m_rUndoEnv.UnLock();
}
};
void Lock();
void UnLock();
sal_Bool IsLocked() const;
// returns sal_True is we are in UNDO
sal_Bool IsUndoMode() const;
// access control
struct Accessor { friend class OReportModel; private: Accessor() { } };
void Clear(const Accessor& _r);
void AddElement(const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface>& Element);
void RemoveElement(const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface>& Element);
void AddSection( const ::com::sun::star::uno::Reference< ::com::sun::star::report::XSection>& _xSection);
void RemoveSection( const ::com::sun::star::uno::Reference< ::com::sun::star::report::XSection>& _xSection );
/** removes the section from the page out of the undo env
*
* \param _pPage
*/
void RemoveSection(OReportPage* _pPage);
protected:
// XEventListener
virtual void SAL_CALL disposing(const ::com::sun::star::lang::EventObject& Source) throw( ::com::sun::star::uno::RuntimeException );
// XPropertyChangeListener
virtual void SAL_CALL propertyChange(const ::com::sun::star::beans::PropertyChangeEvent& evt) throw(::com::sun::star::uno::RuntimeException);
// XContainerListener
virtual void SAL_CALL elementInserted(const ::com::sun::star::container::ContainerEvent& rEvent) throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL elementReplaced(const ::com::sun::star::container::ContainerEvent& rEvent) throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL elementRemoved(const ::com::sun::star::container::ContainerEvent& rEvent) throw(::com::sun::star::uno::RuntimeException);
// XModifyListener
virtual void SAL_CALL modified( const ::com::sun::star::lang::EventObject& aEvent ) throw (::com::sun::star::uno::RuntimeException);
void ModeChanged();
virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
private:
void TogglePropertyListening(const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface>& Element);
void implSetModified();
void switchListening( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess >& _rxContainer, bool _bStartListening ) SAL_THROW(());
void switchListening( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxObject, bool _bStartListening ) SAL_THROW(());
::std::vector< ::com::sun::star::uno::Reference< ::com::sun::star::container::XChild> >::const_iterator
getSection(const ::com::sun::star::uno::Reference< ::com::sun::star::container::XChild>& _xContainer) const;
};
}
#endif //
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */