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