diff options
Diffstat (limited to 'svl/source/notify/cancel.cxx')
| -rw-r--r-- | svl/source/notify/cancel.cxx | 204 |
1 files changed, 204 insertions, 0 deletions
diff --git a/svl/source/notify/cancel.cxx b/svl/source/notify/cancel.cxx new file mode 100644 index 000000000000..1df3abb22776 --- /dev/null +++ b/svl/source/notify/cancel.cxx @@ -0,0 +1,204 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: cancel.cxx,v $ + * $Revision: 1.9 $ + * + * 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_svl.hxx" +#define _SFX_CANCEL_CXX +#include <svl/cancel.hxx> + +#include <vos/mutex.hxx> +#include <tools/debug.hxx> + +#include <svl/smplhint.hxx> +#include <svl/cnclhint.hxx> +#include <rtl/instance.hxx> + +namespace { struct lclMutex : public rtl::Static< ::vos::OMutex, lclMutex >{}; } + +//========================================================================= + +SfxCancelManager::SfxCancelManager( SfxCancelManager *pParent ) +: _pParent( pParent ) +{ +} + +//------------------------------------------------------------------------- + +SfxCancelManager::~SfxCancelManager() +{ + DBG_ASSERT( _pParent || !_aJobs.Count(), "deleting SfxCancelManager in use" ); + for ( USHORT n = _aJobs.Count(); n--; ) + _aJobs.GetObject(n)->SetManager( _pParent ); +} + +//------------------------------------------------------------------------- + +BOOL SfxCancelManager::CanCancel() const + +/* [Beschreibung] + + Liefert TRUE wenn an diesem CancelManager oder an einem Parent + ein Job l"auft. +*/ + +{ + ::vos::OGuard aGuard( lclMutex::get() ); + return _aJobs.Count() > 0 || ( _pParent && _pParent->CanCancel() ); +} + +//------------------------------------------------------------------------- + +void SfxCancelManager::Cancel( BOOL bDeep ) + +/* [Beschreibung] + + Diese Methode markiert alle angemeldeten <SfxCancellable>-Instanzen + als suspendiert. +*/ + +{ + ::vos::OGuard aGuard( lclMutex::get() ); + SfxCancelManagerWeak xWeak( this ); + for ( USHORT n = _aJobs.Count(); n-- && xWeak.Is(); ) + if ( n < _aJobs.Count() ) + _aJobs.GetObject(n)->Cancel(); + if ( xWeak.Is() && _pParent ) + _pParent->Cancel( bDeep ); +} + +//------------------------------------------------------------------------- + +void SfxCancelManager::InsertCancellable( SfxCancellable *pJob ) + +/* [Beschreibung] + + Diese interne Methode tr"agt 'pJob' in die Liste der unterbrechbaren + Jobs ein und Broadcastet dies. Jeder <SfxCancellable> darf nur + maximal einmal angemeldet sein, dies geschiet in seinem Ctor. +*/ + +{ +#ifdef GPF_ON_EMPTY_TITLE + if ( !pJob->GetTitle() ) + { + DBG_ERROR( "SfxCancellable: empty titles not allowed (Vermummungsverbot)" ) + *(int*)0 = 0; + } +#endif + + ::vos::OClearableGuard aGuard( lclMutex::get() ); + _aJobs.C40_INSERT( SfxCancellable, pJob, _aJobs.Count() ); + + aGuard.clear(); + Broadcast( SfxSimpleHint( SFX_HINT_CANCELLABLE ) ); +} + +//------------------------------------------------------------------------- + + +void SfxCancelManager::RemoveCancellable( SfxCancellable *pJob ) + +/* [Beschreibung] + + Diese interne Methode tr"agt 'pJob' aus die Liste der unterbrechbaren + Jobs aus und Broadcastet dies. Dieser Aufruf mu\s paarig nach einem + <InsertCancellable> erfolgen und wird im Dtor des <SfxCancellable> + ausgel"ost. +*/ + +{ + ::vos::OClearableGuard aGuard( lclMutex::get() ); + const SfxCancellable *pTmp = pJob; + USHORT nPos = _aJobs.GetPos( pTmp ); + if ( nPos != 0xFFFF ) + { + _aJobs.Remove( nPos , 1 ); + aGuard.clear(); + Broadcast( SfxSimpleHint( SFX_HINT_CANCELLABLE ) ); + Broadcast( SfxCancelHint( pJob, SFXCANCELHINT_REMOVED ) ); + } +} + +//------------------------------------------------------------------------- + +SfxCancellable::~SfxCancellable() +{ + SfxCancelManager* pMgr = _pMgr; + if ( pMgr ) + pMgr->RemoveCancellable( this ); +} + +//------------------------------------------------------------------------- + +void SfxCancellable::Cancel() + +/* [Description] + + This virtual function is called when the user hits the cancel-button. + If you overload it, you can stop your activities. Please always call + 'SfxCancellable::Cancel()'. +*/ + +{ +#ifdef GFP_ON_NO_CANCEL + if ( _bCancelled < 5 ) + ++_bCancelled; + else + { + delete this; + } +#else + _bCancelled = TRUE; +#endif +} + +//------------------------------------------------------------------------- + +void SfxCancellable::SetManager( SfxCancelManager *pMgr ) +{ + SfxCancelManager* pTmp = _pMgr; + if ( pTmp ) + pTmp->RemoveCancellable( this ); + _pMgr = pMgr; + if ( pMgr ) + pMgr->InsertCancellable( this ); +} + +//------------------------------------------------------------------------- + +TYPEINIT1(SfxCancelHint, SfxHint); + +SfxCancelHint::SfxCancelHint( SfxCancellable* pJob, USHORT _nAction ) +{ + pCancellable = pJob; + nAction = _nAction; +} + + |