offapi/com/sun/star/document/XUndoAction.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_document_XUndoAction_idl__
  21 #define __com_sun_star_document_XUndoAction_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/document/UndoFailedException.idl>
  25
  26
  27 module com { module sun { module star { module document {
  28
  29
  30 /** represents a single (undoable) action on a document
  31     @since OOo 3.4
  32  */
  33 interface 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
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */