summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/XFormControllerListener.idl
blob: ec61cb3d493d2684ff270a4ca4c1cbe6f534c4a6 (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_form_XFormControllerListener_idl__
#define __com_sun_star_form_XFormControllerListener_idl__

#include <com/sun/star/lang/XEventListener.idl>

#include <com/sun/star/lang/EventObject.idl>


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

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

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

/** allows to be notified when the activation status of a <type>FormController</type> changes.

    <p> A form controller is activated if a form control gains the
    focus and none of its controls currently owned the focus before.</p>

    @see      XFormController
 */
published interface XFormControllerListener: com::sun::star::lang::XEventListener
{
    //-------------------------------------------------------------------------

    /** is invoked when a control of the controller gained the focus and
        the controller was not previously activated.

        @param rEvent
            the event happened.
     */
    [oneway] void formActivated( [in] com::sun::star::lang::EventObject rEvent );

    //-------------------------------------------------------------------------

    /** is invoked when a control of the "XFormController" lost the focus
        and no control of the controller received the focus. In other
        words, no control of the controller owns the focus.

        @param rEvent
            the event happened.
     */
    [oneway] void formDeactivated( [in] com::sun::star::lang::EventObject rEvent );

};

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

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif