1 /************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24 #ifndef FRAMEWORK_DOCUMENTUNDOGUARD_HXX 25 #define FRAMEWORK_DOCUMENTUNDOGUARD_HXX 26 27 #include "framework/fwedllapi.h" 28 29 /** === begin UNO includes === **/ 30 #include <com/sun/star/uno/XInterface.hpp> 31 /** === end UNO includes === **/ 32 33 #include <boost/scoped_ptr.hpp> 34 35 //...................................................................................................................... 36 namespace framework 37 { 38 //...................................................................................................................... 39 40 //================================================================================================================== 41 //= DocumentUndoGuard 42 //================================================================================================================== 43 struct DocumentUndoGuard_Data; 44 /** a helper class guarding the Undo manager of a document 45 46 This class guards, within a given scope, the Undo Manager of a document (or another component supporting 47 the XUndoManagerSupplier interface). When entering the scope (i.e. when the <code>DocumentUndoGuard</code> 48 instances is constructed), the current state of the undo contexts of the undo manager is examined. 49 Upon leaving the scope (i.e. when the <code>DocumentUndoGuard</code> is destructed), the guard will execute 50 as many calls to <member scope="com::sun::star::document">XUndoManager::leaveUndoContext</member> as are 51 necessary to restore the manager's initial state. 52 */ 53 class FWE_DLLPUBLIC DocumentUndoGuard 54 { 55 public: 56 DocumentUndoGuard( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& i_undoSupplierComponent ); 57 ~DocumentUndoGuard(); 58 59 private: 60 ::boost::scoped_ptr< DocumentUndoGuard_Data > m_pData; 61 }; 62 63 //...................................................................................................................... 64 } // namespace framework 65 //...................................................................................................................... 66 67 #endif // FRAMEWORK_DOCUMENTUNDOGUARD_HXX 68