/*************************************************************************
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_document_XUndoAction_idl__
#define __com_sun_star_document_XUndoAction_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/document/UndoFailedException.idl>

//==================================================================================================================

module com { module sun { module star { module document { 

//==================================================================================================================

/** represents a single (undoable) action on a document
 */
interface XUndoAction
{
    /** reverts the action represented by the instance

        @throws UndoFailedException
            if reverting the action failed. In this case, the caller should assume that this is a permanent failure,
            and take appropriate action, such as discarding the <code>XUndoAction</code> instance, and any possibly
            depending instances.
    */
    void    undo()
            raises  (   ::com::sun::star::document::UndoFailedException
                    );

    /** repeats the action represented by the instance, after it had previously been reverted.

        @throws UndoFailedException
            if repeating the action failed. In this case, the caller should assume that this is a permanent failure,
            and take appropriate action, such as discarding the <code>XUndoAction</code> instance, and any possibly
            depending instances.
    */
    void    redo()
            raises  (   ::com::sun::star::document::UndoFailedException
                    );

    /** is the human-readable, localized description of the action.
    */
    [attribute, readonly]   string  Title;
};

//==================================================================================================================

}; }; }; };

//==================================================================================================================

#endif
