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 __com_sun_star_document_XUndoAction_idl__ 25#define __com_sun_star_document_XUndoAction_idl__ 26 27#include <com/sun/star/uno/XInterface.idl> 28#include <com/sun/star/document/UndoFailedException.idl> 29 30//================================================================================================================== 31 32module com { module sun { module star { module document { 33 34//================================================================================================================== 35 36/** represents a single (undoable) action on a document 37 @since OpenOffice 3.4 38 */ 39published interface XUndoAction 40{ 41 /** reverts the action represented by the instance 42 43 @throws UndoFailedException 44 if reverting the action failed. In this case, the caller should assume that this is a permanent failure, 45 and take appropriate action, such as discarding the <code>XUndoAction</code> instance, and any possibly 46 depending instances. 47 */ 48 void undo() 49 raises ( ::com::sun::star::document::UndoFailedException 50 ); 51 52 /** repeats the action represented by the instance, after it had previously been reverted. 53 54 @throws UndoFailedException 55 if repeating the action failed. In this case, the caller should assume that this is a permanent failure, 56 and take appropriate action, such as discarding the <code>XUndoAction</code> instance, and any possibly 57 depending instances. 58 */ 59 void redo() 60 raises ( ::com::sun::star::document::UndoFailedException 61 ); 62 63 /** is the human-readable, localized description of the action. 64 */ 65 [attribute, readonly] string Title; 66}; 67 68//================================================================================================================== 69 70}; }; }; }; 71 72//================================================================================================================== 73 74#endif 75