include/framework/documentundoguard.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 FRAMEWORK_DOCUMENTUNDOGUARD_HXX
  21 #define FRAMEWORK_DOCUMENTUNDOGUARD_HXX
  22
  23 #include "framework/fwedllapi.h"
  24
  25 #include <com/sun/star/uno/XInterface.hpp>
  26
  27 #include <boost/scoped_ptr.hpp>
  28
  29 //......................................................................................................................
  30 namespace framework
  31 {
  32 //......................................................................................................................
  33
  34     //==================================================================================================================
  35     //= DocumentUndoGuard
  36     //==================================================================================================================
  37     struct DocumentUndoGuard_Data;
  38     /** a helper class guarding the Undo manager of a document
  39
  40         This class guards, within a given scope, the Undo Manager of a document (or another component supporting
  41         the XUndoManagerSupplier interface). When entering the scope (i.e. when the <code>DocumentUndoGuard</code>
  42         instances is constructed), the current state of the undo contexts of the undo manager is examined.
  43         Upon leaving the scope (i.e. when the <code>DocumentUndoGuard</code> is destructed), the guard will execute
  44         as many calls to <member scope="com::sun::star::document">XUndoManager::leaveUndoContext</member> as are
  45         necessary to restore the manager's initial state.
  46     */
  47     class FWE_DLLPUBLIC DocumentUndoGuard
  48     {
  49     public:
  50         DocumentUndoGuard( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& i_undoSupplierComponent );
  51         ~DocumentUndoGuard();
  52
  53     private:
  54         ::boost::scoped_ptr< DocumentUndoGuard_Data >   m_pData;
  55     };
  56
  57 //......................................................................................................................
  58 } // namespace framework
  59 //......................................................................................................................
  60
  61 #endif // FRAMEWORK_DOCUMENTUNDOGUARD_HXX
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */