summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/runtime/XFeatureInvalidation.idl
blob: b435e64a6d81fb2d4b034fd665e34dc44d60c058 (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
/*************************************************************************
 *
 * 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_form_runtime_XFeatureInvalidation_idl__
#define __com_sun_star_form_runtime_XFeatureInvalidation_idl__

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

//=============================================================================

module com { module sun { module star { module form { module runtime {

//=============================================================================

/** implements a callback for a <type>XFormOperations</type> instance, which is called
    when the state of one or more <type>FormFeature</type>s might have changed.

    @see XFormOperations

    @since OpenOffice.org 2.2.0
*/
interface XFeatureInvalidation
{
    /** invalidates the given <type>FormFeature</type>s

        <p>Invalidation means that any user interface representation (such as toolbox buttons), or
        any dispatches associated with the features in question are potentially out-of-date, and
        need to be updated.</p>

        @param Features
            The set of features whose state might have changed.
    */
    void    invalidateFeatures( [in] sequence< short > Features );

    /** invalidates all features

        <p>This method is used of it cannot be exactly and reliably determined
        which features might actually have changed their state. In this case, the callee
        should assume all features it is interested in must be requeried.</p>
    */
    void    invalidateAllFeatures();
};

//=============================================================================

}; }; }; }; };

//=============================================================================

#endif