1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_embed_XActionsApproval_idl__
28#define __com_sun_star_embed_XActionsApproval_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34//============================================================================
35
36 module com {  module sun {  module star {  module embed {
37
38//============================================================================
39/** allows to request an approval for an action.
40
41	<p>
42	An implementation of this interface is usually provided to another object
43	to allow this object to request an approval for actions. The list of
44	possible actions must be documented in documentation of the object.
45	</p>
46 */
47published interface XActionsApproval: com::sun::star::uno::XInterface
48{
49	//------------------------------------------------------------------------
50    /** requests an approval for the specified action.
51
52		@param nAction
53			a value specifying the action that should be approved. Could take
54			values from <type>Actions</type> constants set. The explicit set
55			of the actions should be documented by the object that is going
56			to use this interface for approval as for example
57			<type>InstanceLocker</type> does.
58
59		@return
60			returns <TRUE/> in case the specified action is approved.
61	 */
62	boolean approveAction( [in] long nAction );
63};
64
65//============================================================================
66
67}; }; }; };
68
69#endif
70
71