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