summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XTabController.idl
blob: 65294dde712db5acd3a44263cbd90946d4625a1a (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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XTabController.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 21:55:13 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_XTabController_idl__
#define __com_sun_star_awt_XTabController_idl__

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

#ifndef __com_sun_star_awt_XTabControllerModel_idl__
#include <com/sun/star/awt/XTabControllerModel.idl>
#endif

#ifndef __com_sun_star_awt_XControlContainer_idl__
#include <com/sun/star/awt/XControlContainer.idl>
#endif

#ifndef __com_sun_star_awt_XControl_idl__
#include <com/sun/star/awt/XControl.idl>
#endif


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

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

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

/** specifies the basic operations for a tab controller.
 */
published interface XTabController: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** sets the tab controller model.
     */
    [oneway] void setModel( [in] com::sun::star::awt::XTabControllerModel Model );

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

    /** returns the tab controller model.
     */
    com::sun::star::awt::XTabControllerModel getModel();

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

    /** set the control container.
     */
    [oneway] void setContainer( [in] com::sun::star::awt::XControlContainer Container );

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

    /** returns the control container.
     */
    com::sun::star::awt::XControlContainer getContainer();

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

    /** returns all controls of the control container.
     */
    sequence<com::sun::star::awt::XControl> getControls();

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

    /** enables automatic tab order.
     */
    [oneway] void autoTabOrder();

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

    /** activates tab order.
     */
    [oneway] void activateTabOrder();

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

    /** sets the focus to the first control that can be reached with the
        TAB key.
     */
    [oneway] void activateFirst();

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

    /** sets the focus to the last control that can be reached with the
        TAB key.
     */
    [oneway] void activateLast();

};

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

}; }; }; };

#endif