/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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
 */
published 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