sfx2/source/inc/docundomanager.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef DOCUMENT_UNDO_MANAGER_HXX
  21 #define DOCUMENT_UNDO_MANAGER_HXX
  22
  23 #include "sfx2/sfxbasemodel.hxx"
  24
  25 #include <com/sun/star/document/XUndoManager.hpp>
  26
  27 #include <cppuhelper/implbase1.hxx>
  28
  29 #include <boost/scoped_ptr.hpp>
  30 #include <boost/noncopyable.hpp>
  31
  32 //......................................................................................................................
  33 namespace sfx2
  34 {
  35 //......................................................................................................................
  36
  37     //==================================================================================================================
  38     //= DocumentUndoManager
  39     //==================================================================================================================
  40     typedef ::cppu::ImplHelper1 <   ::com::sun::star::document::XUndoManager
  41                                 >   DocumentUndoManager_Base;
  42     struct DocumentUndoManager_Impl;
  43     class DocumentUndoManager   :public DocumentUndoManager_Base
  44                                 ,public SfxModelSubComponent
  45                                 ,public ::boost::noncopyable
  46     {
  47         friend struct DocumentUndoManager_Impl;
  48
  49     public:
  50         DocumentUndoManager( SfxBaseModel& i_document );
  51         virtual ~DocumentUndoManager();
  52
  53         // SfxModelSubComponent overridables
  54         virtual void    disposing();
  55
  56         // non-UNO API for our owner
  57         /** determines whether we have an open Undo context. No mutex locking within this method, no disposal check - this
  58             is the responsibility of the owner.
  59         */
  60         bool    isInContext() const;
  61
  62         // XInterface
  63         virtual void SAL_CALL acquire(  ) throw ();
  64         virtual void SAL_CALL release(  ) throw ();
  65
  66         // XUndoManager
  67         virtual void SAL_CALL enterUndoContext( const OUString& i_title ) throw (::com::sun::star::uno::RuntimeException);
  68         virtual void SAL_CALL enterHiddenUndoContext(  ) throw (::com::sun::star::document::EmptyUndoStackException, ::com::sun::star::uno::RuntimeException);
  69         virtual void SAL_CALL leaveUndoContext(  ) throw (::com::sun::star::util::InvalidStateException, ::com::sun::star::uno::RuntimeException);
  70         virtual void SAL_CALL addUndoAction( const ::com::sun::star::uno::Reference< ::com::sun::star::document::XUndoAction >& i_action ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
  71         virtual void SAL_CALL undo(  ) throw (::com::sun::star::document::EmptyUndoStackException, ::com::sun::star::document::UndoContextNotClosedException, ::com::sun::star::document::UndoFailedException, ::com::sun::star::uno::RuntimeException);
  72         virtual void SAL_CALL redo(  ) throw (::com::sun::star::document::EmptyUndoStackException, ::com::sun::star::document::UndoContextNotClosedException, ::com::sun::star::document::UndoFailedException, ::com::sun::star::uno::RuntimeException);
  73         virtual ::sal_Bool SAL_CALL isUndoPossible(  ) throw (::com::sun::star::uno::RuntimeException);
  74         virtual ::sal_Bool SAL_CALL isRedoPossible(  ) throw (::com::sun::star::uno::RuntimeException);
  75         virtual OUString SAL_CALL getCurrentUndoActionTitle(  ) throw (::com::sun::star::document::EmptyUndoStackException, ::com::sun::star::uno::RuntimeException);
  76         virtual OUString SAL_CALL getCurrentRedoActionTitle(  ) throw (::com::sun::star::document::EmptyUndoStackException, ::com::sun::star::uno::RuntimeException);
  77         virtual ::com::sun::star::uno::Sequence< OUString > SAL_CALL getAllUndoActionTitles(  ) throw (::com::sun::star::uno::RuntimeException);
  78         virtual ::com::sun::star::uno::Sequence< OUString > SAL_CALL getAllRedoActionTitles(  ) throw (::com::sun::star::uno::RuntimeException);
  79         virtual void SAL_CALL clear(  ) throw (::com::sun::star::document::UndoContextNotClosedException, ::com::sun::star::uno::RuntimeException);
  80         virtual void SAL_CALL clearRedo(  ) throw (::com::sun::star::document::UndoContextNotClosedException, ::com::sun::star::uno::RuntimeException);
  81         virtual void SAL_CALL reset(  ) throw (::com::sun::star::uno::RuntimeException);
  82         virtual void SAL_CALL addUndoManagerListener( const ::com::sun::star::uno::Reference< ::com::sun::star::document::XUndoManagerListener >& i_listener ) throw (::com::sun::star::uno::RuntimeException);
  83         virtual void SAL_CALL removeUndoManagerListener( const ::com::sun::star::uno::Reference< ::com::sun::star::document::XUndoManagerListener >& i_listener ) throw (::com::sun::star::uno::RuntimeException);
  84
  85         // XLockable, base of XUndoManager
  86         virtual void SAL_CALL lock(  ) throw (::com::sun::star::uno::RuntimeException);
  87         virtual void SAL_CALL unlock(  ) throw (::com::sun::star::util::NotLockedException, ::com::sun::star::uno::RuntimeException);
  88         virtual ::sal_Bool SAL_CALL isLocked(  ) throw (::com::sun::star::uno::RuntimeException);
  89
  90         // XChild, base of XUndoManager
  91         virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getParent(  ) throw (::com::sun::star::uno::RuntimeException);
  92         virtual void SAL_CALL setParent( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& Parent ) throw (::com::sun::star::lang::NoSupportException, ::com::sun::star::uno::RuntimeException);
  93
  94     private:
  95         ::boost::scoped_ptr< DocumentUndoManager_Impl > m_pImpl;
  96     };
  97
  98 //......................................................................................................................
  99 } // namespace sfx2
 100 //......................................................................................................................
 101
 102 #endif // DOCUMENT_UNDO_MANAGER_HXX
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */