LibreOffice
LibreOffice 24.8 SDK API Reference
 
Loading...
Searching...
No Matches
XUndoManager.idl
Go to the documentation of this file.
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
21module com { module sun { module star { module document {
22
23interface XUndoAction;
24interface XUndoManagerListener;
25
26
60interface XUndoManager
61{
64 interface ::com::sun::star::util::XLockable;
65
71 interface ::com::sun::star::container::XChild;
72
89 [in] string iTitle
90 );
91
122 raises( EmptyUndoStackException );
123
142 raises( ::com::sun::star::util::InvalidStateException );
143
160 [in] XUndoAction iAction
161 )
162 raises( ::com::sun::star::lang::IllegalArgumentException );
163
184 void undo()
188
208 void redo()
212
219 boolean isUndoPossible();
220
227 boolean isRedoPossible();
228
238
247
251 sequence< string >
253
258 sequence< string >
260
269 void clear()
271
282
297 void reset();
298
302 [in] XUndoManagerListener iListener
303 );
304
308 [in] XUndoManagerListener iListener
309 );
310};
311
312
313}; }; }; };
314
315
316/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
is raised when an operation is attemption at an XUndoManager which requires a non-empty stack of undo...
Definition EmptyUndoStackException.idl:29
is thrown when an operation is attempted at an XUndoManager which requires all undo contexts to be cl...
Definition UndoContextNotClosedException.idl:29
thrown when reverting to re-applying an undoable action fails.
Definition UndoFailedException.idl:31
represents a single (undoable) action on a document
Definition XUndoAction.idl:28
implemented by components which want to be notified of changes in the Undo/Redo stacks of an Undo man...
Definition XUndoManagerListener.idl:30
provides access to the undo/redo stacks of a document
Definition XUndoManager.idl:61
string getCurrentRedoActionTitle()
returns the title of the top-most action on the Redo stack
boolean isRedoPossible()
determines whether redo() can reasonably be expected to succeed.
void undo()
reverts the most recent action on the document.
void clearRedo()
clears the redo stack.
void enterUndoContext([in] string iTitle)
enters a new undo context.
void enterHiddenUndoContext()
enters a new undo context, creating a hidden undo action.
boolean isUndoPossible()
determines whether undo() can reasonably be expected to succeed.
void addUndoAction([in] XUndoAction iAction)
adds the given undo action to the undo stack.
string getCurrentUndoActionTitle()
returns the title of the top-most action on the undo stack
sequence< string > getAllUndoActionTitles()
returns the titles of all actions currently on the undo stack, from top to bottom
void removeUndoManagerListener([in] XUndoManagerListener iListener)
removes a previously added listener
void addUndoManagerListener([in] XUndoManagerListener iListener)
adds a listener to be notified of changes in the Undo/Redo stacks.
void leaveUndoContext()
leaves the undo context previously opened via enterUndoContext() respectively enterHiddenUndoContext(...
void redo()
replays the action on the document which has most recently been undone
void clear()
clears the undo and the redo stack.
void reset()
resets the Undo manager
sequence< string > getAllRedoActionTitles()
returns the titles of all actions currently on the Redo stack, from top to bottom
Office document related interfaces.
Definition AmbigousFilterRequest.idl:21
General UNO concepts like factories etc.
Definition ArrayIndexOutOfBoundsException.idl:22
Miscellaneous interfaces for sorting, connecting objects etc.
Definition XVndSunStarExpandUrl.idl:20
the module com::sun::star is the root module of the UNO API.
Definition Ambiguous.idl:20
Definition Ambiguous.idl:20
Definition Ambiguous.idl:20