Quelle  XUndoAction.idl   Sprache: unbekannt

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */


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


/** represents a single (undoable) action on a document
    @since OOo 3.4
 */
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;
};


}; }; }; };


/* vim:set shiftwidth=4 softtabstop=4 expandtab: */