summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XTabListener.idl
blob: e7018bb284af1c7e3664ce3ed3898ddbdc5e5cd0 (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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/*************************************************************************
 *
 * 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_awt_XTabListener_idl__
#define __com_sun_star_awt_XTabListener_idl__

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

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

#ifndef __com_sun_star_beans_NamedValue_idl__
#include <com/sun/star/beans/NamedValue.idl>
#endif

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

 module com {  module sun {  module star {  module awt {

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

/** such listener will be informed if tab's was inserted/removed from
    an XSimpleTabController instance or if the properties of a tab was changed.
 */
interface XTabListener : com::sun::star::lang::XEventListener
{
    //-------------------------------------------------------------------------
    /** a new tab was inserted.

        @param  ID
                this is the unique ID of this new tab.
     */
    void inserted( [in] long ID );

    //-------------------------------------------------------------------------
    /** a tab was removed.

        @param  ID
                this was the unique ID of this tab.
     */
    void removed( [in] long ID );

    //-------------------------------------------------------------------------
    /** a tab was changed within it's properties.

        @param  ID
                the unique ID of the changed tab.

        @param  Properties
                the current set of properties for this tab.
     */
    void changed( [in] long                                          ID         ,
                  [in] sequence< com::sun::star::beans::NamedValue > Properties );

    //-------------------------------------------------------------------------
    /** a tab was activated (e.g. by using mouse/keyboard or
        method XSimpleTabController::activateTab()
     */
    void activated( [in] long ID );

    //-------------------------------------------------------------------------
    /** a tab was deactivated, because another tab becames the new active state.
     */
    void deactivated( [in] long ID );
};

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

}; }; }; };

#endif