xref: /AOO41X/main/offapi/com/sun/star/awt/XTabController.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_XTabController_idl__
24#define __com_sun_star_awt_XTabController_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_awt_XTabControllerModel_idl__
31#include <com/sun/star/awt/XTabControllerModel.idl>
32#endif
33
34#ifndef __com_sun_star_awt_XControlContainer_idl__
35#include <com/sun/star/awt/XControlContainer.idl>
36#endif
37
38#ifndef __com_sun_star_awt_XControl_idl__
39#include <com/sun/star/awt/XControl.idl>
40#endif
41
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module awt {
46
47//=============================================================================
48
49/** specifies the basic operations for a tab controller.
50 */
51published interface XTabController: com::sun::star::uno::XInterface
52{
53    //-------------------------------------------------------------------------
54
55    /** sets the tab controller model.
56     */
57    [oneway] void setModel( [in] com::sun::star::awt::XTabControllerModel Model );
58
59    //-------------------------------------------------------------------------
60
61    /** returns the tab controller model.
62     */
63    com::sun::star::awt::XTabControllerModel getModel();
64
65    //-------------------------------------------------------------------------
66
67    /** set the control container.
68     */
69    [oneway] void setContainer( [in] com::sun::star::awt::XControlContainer Container );
70
71    //-------------------------------------------------------------------------
72
73    /** returns the control container.
74     */
75    com::sun::star::awt::XControlContainer getContainer();
76
77    //-------------------------------------------------------------------------
78
79    /** returns all controls of the control container.
80     */
81    sequence<com::sun::star::awt::XControl> getControls();
82
83    //-------------------------------------------------------------------------
84
85    /** enables automatic tab order.
86     */
87    [oneway] void autoTabOrder();
88
89    //-------------------------------------------------------------------------
90
91    /** activates tab order.
92     */
93    [oneway] void activateTabOrder();
94
95    //-------------------------------------------------------------------------
96
97    /** sets the focus to the first control that can be reached with the
98        TAB key.
99     */
100    [oneway] void activateFirst();
101
102    //-------------------------------------------------------------------------
103
104    /** sets the focus to the last control that can be reached with the
105        TAB key.
106     */
107    [oneway] void activateLast();
108
109};
110
111//=============================================================================
112
113}; }; }; };
114
115#endif
116