1/*************************************************************************
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * Copyright 2000, 2010 Oracle and/or its affiliates.
5 *
6 * OpenOffice.org - a multi-platform office productivity suite
7 *
8 * This file is part of OpenOffice.org.
9 *
10 * OpenOffice.org is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Lesser General Public License version 3
12 * only, as published by the Free Software Foundation.
13 *
14 * OpenOffice.org is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU Lesser General Public License version 3 for more details
18 * (a copy is included in the LICENSE file that accompanied this code).
19 *
20 * You should have received a copy of the GNU Lesser General Public License
21 * version 3 along with OpenOffice.org.  If not, see
22 * <http://www.openoffice.org/license.html>
23 * for a copy of the LGPLv3 License.
24 *
25 ************************************************************************/
26
27#ifndef __com_sun_star_document_XUndoAction_idl__
28#define __com_sun_star_document_XUndoAction_idl__
29
30#include <com/sun/star/uno/XInterface.idl>
31#include <com/sun/star/document/UndoFailedException.idl>
32
33//==================================================================================================================
34
35module com { module sun { module star { module document {
36
37//==================================================================================================================
38
39/** represents a single (undoable) action on a document
40 */
41published interface XUndoAction
42{
43    /** reverts the action represented by the instance
44
45        @throws UndoFailedException
46            if reverting the action failed. In this case, the caller should assume that this is a permanent failure,
47            and take appropriate action, such as discarding the <code>XUndoAction</code> instance, and any possibly
48            depending instances.
49    */
50    void    undo()
51            raises  (   ::com::sun::star::document::UndoFailedException
52                    );
53
54    /** repeats the action represented by the instance, after it had previously been reverted.
55
56        @throws UndoFailedException
57            if repeating the action failed. In this case, the caller should assume that this is a permanent failure,
58            and take appropriate action, such as discarding the <code>XUndoAction</code> instance, and any possibly
59            depending instances.
60    */
61    void    redo()
62            raises  (   ::com::sun::star::document::UndoFailedException
63                    );
64
65    /** is the human-readable, localized description of the action.
66    */
67    [attribute, readonly]   string  Title;
68};
69
70//==================================================================================================================
71
72}; }; }; };
73
74//==================================================================================================================
75
76#endif
77