LibreOffice LibreOffice 25.2 SDK API Reference

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
23 interface XUndoAction;
24 interface XUndoManagerListener;
25
26
60 interface XUndoManager
61{
64 interface ::com::sun::star::util::XLockable;
65
71 interface ::com::sun::star::container::XChild;
72
88 void enterUndoContext(
89 [in] string iTitle
90 );
91
121 void enterHiddenUndoContext()
122 raises( EmptyUndoStackException );
123
141 void leaveUndoContext()
142 raises( ::com::sun::star::util::InvalidStateException );
143
159 void addUndoAction(
160 [in] XUndoAction iAction
161 )
162 raises( ::com::sun::star::lang::IllegalArgumentException );
163
184 void undo()
185 raises( ::com::sun::star::document::EmptyUndoStackException,
186 ::com::sun::star::document::UndoContextNotClosedException,
187 ::com::sun::star::document::UndoFailedException );
188
208 void redo()
209 raises( ::com::sun::star::document::EmptyUndoStackException,
210 ::com::sun::star::document::UndoContextNotClosedException,
211 ::com::sun::star::document::UndoFailedException );
212
219 boolean isUndoPossible();
220
227 boolean isRedoPossible();
228
236 string getCurrentUndoActionTitle()
237 raises( ::com::sun::star::document::EmptyUndoStackException );
238
245 string getCurrentRedoActionTitle()
246 raises( ::com::sun::star::document::EmptyUndoStackException );
247
251 sequence< string >
252 getAllUndoActionTitles();
253
258 sequence< string >
259 getAllRedoActionTitles();
260
269 void clear()
270 raises( ::com::sun::star::document::UndoContextNotClosedException );
271
280 void clearRedo()
281 raises( ::com::sun::star::document::UndoContextNotClosedException );
282
297 void reset();
298
301 void addUndoManagerListener(
302 [in] XUndoManagerListener iListener
303 );
304
307 void removeUndoManagerListener(
308 [in] XUndoManagerListener iListener
309 );
310};
311
312
313}; }; }; };
314
315
316/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::document::EmptyUndoStackException
is raised when an operation is attemption at an XUndoManager which requires a non-empty stack of undo...
Definition: EmptyUndoStackException.idl:29
com::sun::star::document::UndoContextNotClosedException
is thrown when an operation is attempted at an XUndoManager which requires all undo contexts to be cl...
Definition: UndoContextNotClosedException.idl:29
com::sun::star::document::UndoFailedException
thrown when reverting to re-applying an undoable action fails.
Definition: UndoFailedException.idl:31
com::sun::star::document::XUndoAction
represents a single (undoable) action on a document
Definition: XUndoAction.idl:28
com::sun::star::document::XUndoManagerListener
implemented by components which want to be notified of changes in the Undo/Redo stacks of an Undo man...
Definition: XUndoManagerListener.idl:30
com::sun::star::document::XUndoManager
provides access to the undo/redo stacks of a document
Definition: XUndoManager.idl:61
com::sun::star::document::XUndoManager::enterUndoContext
void enterUndoContext([in] string iTitle)
enters a new undo context.
com::sun::star::document::XUndoManager::enterHiddenUndoContext
void enterHiddenUndoContext()
enters a new undo context, creating a hidden undo action.
com
Definition: Ambiguous.idl:20