include/dbaccess/dbaundomanager.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 DBACCESS_DBAUNDOMANAGER_HXX
  21 #define DBACCESS_DBAUNDOMANAGER_HXX
  22
  23 #include "dbaccessdllapi.h"
  24
  25 #include <com/sun/star/document/XUndoManager.hpp>
  26
  27 #include <cppuhelper/implbase1.hxx>
  28
  29 #include <boost/scoped_ptr.hpp>
  30
  31 class SfxUndoManager;
  32
  33 //......................................................................................................................
  34 namespace dbaui
  35 {
  36 //......................................................................................................................
  37
  38     //==================================================================================================================
  39     //= UndoManager
  40     //==================================================================================================================
  41     struct UndoManager_Impl;
  42     typedef ::cppu::ImplHelper1< ::com::sun::star::document::XUndoManager > UndoManager_Base;
  43     class DBACCESS_DLLPUBLIC UndoManager : public UndoManager_Base
  44     {
  45     public:
  46         UndoManager( ::cppu::OWeakObject& i_parent, ::osl::Mutex& i_mutex );
  47         virtual ~UndoManager();
  48
  49         SfxUndoManager& GetSfxUndoManager() const;
  50
  51         // XInterface
  52         virtual void SAL_CALL acquire(  ) throw ();
  53         virtual void SAL_CALL release(  ) throw ();
  54
  55         // XComponent equivalents
  56         void disposing();
  57
  58         // XUndoManager
  59         virtual void SAL_CALL enterUndoContext( const OUString& i_title ) throw (::com::sun::star::uno::RuntimeException);
  60         virtual void SAL_CALL enterHiddenUndoContext(  ) throw (::com::sun::star::document::EmptyUndoStackException, ::com::sun::star::uno::RuntimeException);
  61         virtual void SAL_CALL leaveUndoContext(  ) throw (::com::sun::star::util::InvalidStateException, ::com::sun::star::uno::RuntimeException);
  62         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);
  63         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);
  64         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);
  65         virtual ::sal_Bool SAL_CALL isUndoPossible(  ) throw (::com::sun::star::uno::RuntimeException);
  66         virtual ::sal_Bool SAL_CALL isRedoPossible(  ) throw (::com::sun::star::uno::RuntimeException);
  67         virtual OUString SAL_CALL getCurrentUndoActionTitle(  ) throw (::com::sun::star::document::EmptyUndoStackException, ::com::sun::star::uno::RuntimeException);
  68         virtual OUString SAL_CALL getCurrentRedoActionTitle(  ) throw (::com::sun::star::document::EmptyUndoStackException, ::com::sun::star::uno::RuntimeException);
  69         virtual ::com::sun::star::uno::Sequence< OUString > SAL_CALL getAllUndoActionTitles(  ) throw (::com::sun::star::uno::RuntimeException);
  70         virtual ::com::sun::star::uno::Sequence< OUString > SAL_CALL getAllRedoActionTitles(  ) throw (::com::sun::star::uno::RuntimeException);
  71         virtual void SAL_CALL clear(  ) throw (::com::sun::star::document::UndoContextNotClosedException, ::com::sun::star::uno::RuntimeException);
  72         virtual void SAL_CALL clearRedo(  ) throw (::com::sun::star::document::UndoContextNotClosedException, ::com::sun::star::uno::RuntimeException);
  73         virtual void SAL_CALL reset(  ) throw (::com::sun::star::uno::RuntimeException);
  74         virtual void SAL_CALL addUndoManagerListener( const ::com::sun::star::uno::Reference< ::com::sun::star::document::XUndoManagerListener >& i_listener ) throw (::com::sun::star::uno::RuntimeException);
  75         virtual void SAL_CALL removeUndoManagerListener( const ::com::sun::star::uno::Reference< ::com::sun::star::document::XUndoManagerListener >& i_listener ) throw (::com::sun::star::uno::RuntimeException);
  76
  77         // XLockable (base of XUndoManager)
  78         virtual void SAL_CALL lock(  ) throw (::com::sun::star::uno::RuntimeException);
  79         virtual void SAL_CALL unlock(  ) throw (::com::sun::star::util::NotLockedException, ::com::sun::star::uno::RuntimeException);
  80         virtual ::sal_Bool SAL_CALL isLocked(  ) throw (::com::sun::star::uno::RuntimeException);
  81
  82         // XChild (base of XUndoManager)
  83         virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getParent(  ) throw (::com::sun::star::uno::RuntimeException);
  84         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);
  85
  86     private:
  87         ::boost::scoped_ptr< UndoManager_Impl > m_pImpl;
  88     };
  89
  90 //......................................................................................................................
  91 } // namespace dbaui
  92 //......................................................................................................................
  93
  94 #endif // DBACCESS_DBAUNDOMANAGER_HXX
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */