blob: 55e6e73d8045b84a6804a1ccd06f7750b0b34c51 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_util_XChangesBatch_idl__
#define __com_sun_star_util_XChangesBatch_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/WrappedTargetException.idl>
#include <com/sun/star/util/ChangesSet.idl>
//=============================================================================
module com { module sun { module star { module util {
//=============================================================================
/** this interface enables applying a set of changes in one batch transaction.
<p>An object implementing this interface allows other interfaces to change
its state locally. It will keep a list of pending changes until such changes
are committed or canceled. </p>
<p>Only when they are explicitly committed will these changes take effect
persistently or globally. </p>
@see XChangesNotifier
@see XChangesSet
@see XCancellable
*/
published interface XChangesBatch: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** commits any pending changes.
<p>The exact action depends on the concrete service. </p>
*/
void commitChanges()
raises( com::sun::star::lang::WrappedTargetException );
//-------------------------------------------------------------------------
/** checks whether this object has any pending changes that can be committed.
*/
boolean hasPendingChanges();
//-------------------------------------------------------------------------
/** queries for any pending changes that can be committed.
*/
ChangesSet getPendingChanges();
};
//=============================================================================
}; }; }; };
#endif
|
