summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/embed/XActionsApproval.idl
blob: 8da5b738fa502c992ccbf5e6612f4581ea3db568 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_embed_XActionsApproval_idl__
#define __com_sun_star_embed_XActionsApproval_idl__

#include <com/sun/star/uno/XInterface.idl>


 module com {  module sun {  module star {  module embed {

/** allows to request an approval for an action.

    <p>
    An implementation of this interface is usually provided to another object
    to allow this object to request an approval for actions. The list of
    possible actions must be documented in documentation of the object.
    </p>
 */
published interface XActionsApproval: com::sun::star::uno::XInterface
{
    /** requests an approval for the specified action.

        @param nAction
            a value specifying the action that should be approved. Could take
            values from Actions constants set. The explicit set
            of the actions should be documented by the object that is going
            to use this interface for approval as for example
            InstanceLocker does.

        @return
            returns `TRUE` in case the specified action is approved.
     */
    boolean approveAction( [in] long nAction );
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */