1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10cdf0e10cSrcweir * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12cdf0e10cSrcweir * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19cdf0e10cSrcweir * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22cdf0e10cSrcweir#ifndef __com_sun_star_document_XUndoAction_idl__ 23cdf0e10cSrcweir#define __com_sun_star_document_XUndoAction_idl__ 24cdf0e10cSrcweir 25cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 26cdf0e10cSrcweir#include <com/sun/star/document/UndoFailedException.idl> 27cdf0e10cSrcweir 28cdf0e10cSrcweirmodule com { module sun { module star { module document { 29cdf0e10cSrcweir 30cdf0e10cSrcweir/** represents a single (undoable) action on a document 31f55dbc43SAriel Constenla-Haile @since OpenOffice 3.4 32cdf0e10cSrcweir */ 33*f82eb0bbSAriel Constenla-Haileinterface XUndoAction 34cdf0e10cSrcweir{ 35cdf0e10cSrcweir /** reverts the action represented by the instance 36cdf0e10cSrcweir 37cdf0e10cSrcweir @throws UndoFailedException 38cdf0e10cSrcweir if reverting the action failed. In this case, the caller should assume that this is a permanent failure, 39cdf0e10cSrcweir and take appropriate action, such as discarding the <code>XUndoAction</code> instance, and any possibly 40cdf0e10cSrcweir depending instances. 41cdf0e10cSrcweir */ 42cdf0e10cSrcweir void undo() 43cdf0e10cSrcweir raises ( ::com::sun::star::document::UndoFailedException 44cdf0e10cSrcweir ); 45cdf0e10cSrcweir 46cdf0e10cSrcweir /** repeats the action represented by the instance, after it had previously been reverted. 47cdf0e10cSrcweir 48cdf0e10cSrcweir @throws UndoFailedException 49cdf0e10cSrcweir if repeating the action failed. In this case, the caller should assume that this is a permanent failure, 50cdf0e10cSrcweir and take appropriate action, such as discarding the <code>XUndoAction</code> instance, and any possibly 51cdf0e10cSrcweir depending instances. 52cdf0e10cSrcweir */ 53cdf0e10cSrcweir void redo() 54cdf0e10cSrcweir raises ( ::com::sun::star::document::UndoFailedException 55cdf0e10cSrcweir ); 56cdf0e10cSrcweir 57cdf0e10cSrcweir /** is the human-readable, localized description of the action. 58cdf0e10cSrcweir */ 59cdf0e10cSrcweir [attribute, readonly] string Title; 60cdf0e10cSrcweir}; 61cdf0e10cSrcweir 62cdf0e10cSrcweir}; }; }; }; 63cdf0e10cSrcweir 64cdf0e10cSrcweir#endif 65