sd/inc/undo/undomanager.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: undomanager.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _SD_UNDOMANAGER_HXX
  32 #define _SD_UNDOMANAGER_HXX
  33
  34 #include "misc/scopelock.hxx"
  35 #include <svtools/undo.hxx>
  36
  37 namespace sd
  38 {
  39
  40 class UndoManager : public SfxUndoManager
  41 {
  42 public:
  43     UndoManager( USHORT nMaxUndoActionCount = 20 );
  44
  45     virtual void            EnterListAction(const UniString &rComment, const UniString& rRepeatComment, USHORT nId=0);
  46     virtual void                        LeaveListAction();
  47
  48     virtual void                        AddUndoAction( SfxUndoAction *pAction, BOOL bTryMerg=FALSE );
  49
  50     bool                                        isInListAction() const { return mnListLevel != 0; }
  51     bool                                        isInUndo() const { return maIsInUndoLock.isLocked(); }
  52
  53     virtual BOOL                        Undo( USHORT nCount=1 );
  54     virtual BOOL                        Redo( USHORT nCount=1 );
  55
  56     /** Set or reset the undo manager linked with the called undo manager.
  57     */
  58     void SetLinkedUndoManager (SfxUndoManager* pLinkedUndoManager);
  59
  60 private:
  61     using SfxUndoManager::Undo;
  62     using SfxUndoManager::Redo;
  63
  64     int mnListLevel;
  65     ScopeLock maIsInUndoLock;
  66
  67     /** Used when the outline view is visible as a last resort to
  68         synchronize the undo managers.
  69     */
  70     SfxUndoManager* mpLinkedUndoManager;
  71
  72     /** Call ClearRedo() at the linked undo manager, when present.
  73
  74         It should not be necessary to call ClearRedo() explicitly, but the
  75         synchronization between the under managers of the document and the
  76         outline view seems to have a bug.  Therefore this method is called
  77         whenever a new undo action is added.
  78     */
  79     void ClearLinkedRedoActions (void);
  80 };
  81
  82 }
  83
  84 #endif     // _SD_UNDOMANAGER_HXX