LibreOffice
LibreOffice 6.1 SDK API Reference
com
sun
star
document
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
#ifndef __com_sun_star_document_XUndoManager_idl__
21
#define __com_sun_star_document_XUndoManager_idl__
22
23
#include <
com/sun/star/document/EmptyUndoStackException.idl
>
24
#include <
com/sun/star/document/UndoContextNotClosedException.idl
>
25
#include <
com/sun/star/document/UndoFailedException.idl
>
26
#include <
com/sun/star/util/InvalidStateException.idl
>
27
#include <
com/sun/star/util/XLockable.idl
>
28
#include <
com/sun/star/container/XChild.idl
>
29
#include <
com/sun/star/lang/IllegalArgumentException.idl
>
30
#include <
com/sun/star/lang/WrappedTargetException.idl
>
31
32
33
module
com
{ module sun { module star { module document {
34
35
interface
XUndoAction;
36
interface
XUndoManagerListener;
37
38
72
interface
XUndoManager
73
{
76
interface ::com::sun::star::util::XLockable;
77
83
interface ::com::sun::star::container::XChild;
84
100
void
enterUndoContext(
101
[in]
string
iTitle
102
);
103
133
void
enterHiddenUndoContext()
134
raises(
EmptyUndoStackException
);
135
153
void
leaveUndoContext()
154
raises( ::
com
::sun::star::util::InvalidStateException );
155
171
void
addUndoAction(
172
[in]
XUndoAction
iAction
173
)
174
raises( ::
com
::sun::star::lang::IllegalArgumentException );
175
196
void
undo()
197
raises( ::
com
::sun::star::document::
EmptyUndoStackException
,
198
::
com
::sun::star::document::
UndoContextNotClosedException
,
199
::
com
::sun::star::document::
UndoFailedException
);
200
220
void
redo()
221
raises( ::
com
::sun::star::document::
EmptyUndoStackException
,
222
::
com
::sun::star::document::
UndoContextNotClosedException
,
223
::
com
::sun::star::document::
UndoFailedException
);
224
231
boolean
isUndoPossible();
232
239
boolean
isRedoPossible();
240
248
string
getCurrentUndoActionTitle()
249
raises( ::
com
::sun::star::document::
EmptyUndoStackException
);
250
257
string
getCurrentRedoActionTitle()
258
raises( ::
com
::sun::star::document::
EmptyUndoStackException
);
259
263
sequence<
string
>
264
getAllUndoActionTitles();
265
270
sequence<
string
>
271
getAllRedoActionTitles();
272
281
void
clear()
282
raises( ::
com
::sun::star::document::
UndoContextNotClosedException
);
283
292
void
clearRedo()
293
raises( ::
com
::sun::star::document::
UndoContextNotClosedException
);
294
309
void
reset();
310
313
void
addUndoManagerListener(
314
[in]
XUndoManagerListener
iListener
315
);
316
319
void
removeUndoManagerListener(
320
[in]
XUndoManagerListener
iListener
321
);
322
};
323
324
325
}; }; }; };
326
327
328
#endif
329
330
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XLockable.idl
com::sun::star::document::XUndoAction
represents a single (undoable) action on a document
Definition:
XUndoAction.idl:33
InvalidStateException.idl
com::sun::star::document::XUndoManager
provides access to the undo/redo stacks of a document
Definition:
XUndoManager.idl:72
IllegalArgumentException.idl
com
Definition:
Ambiguous.idl:22
XChild.idl
UndoContextNotClosedException.idl
com::sun::star::document::UndoFailedException
thrown when reverting to re-applying an undoable action fails.
Definition:
UndoFailedException.idl:35
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:33
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:35
WrappedTargetException.idl
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:33
EmptyUndoStackException.idl
UndoFailedException.idl
Generated by
1.8.14