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