xref: /AOO41X/main/offapi/com/sun/star/awt/XControlContainer.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_XControlContainer_idl__
24#define __com_sun_star_awt_XControlContainer_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_XControl_idl__
31#include <com/sun/star/awt/XControl.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module awt {
38
39//=============================================================================
40
41/** Provides access to the controls within an
42    <type>UnoControlContainer</type>.
43 */
44published interface XControlContainer: com::sun::star::uno::XInterface
45{
46    //-------------------------------------------------------------------------
47
48    /** sets the status text in the status bar of the container.
49     */
50    [oneway] void setStatusText( [in] string StatusText );
51
52    //-------------------------------------------------------------------------
53
54    /** returns all controls.
55     */
56    sequence<com::sun::star::awt::XControl> getControls();
57
58    //-------------------------------------------------------------------------
59
60    /** returns the control with the specified name.
61     */
62    com::sun::star::awt::XControl getControl( [in] string aName );
63
64    //-------------------------------------------------------------------------
65
66    /** adds the given control with the specified name to the container.
67     */
68    [oneway] void addControl( [in] string Name,
69             [in] com::sun::star::awt::XControl Control );
70
71    //-------------------------------------------------------------------------
72
73    /** removes the given control from the container.
74     */
75    [oneway] void removeControl( [in] com::sun::star::awt::XControl Control );
76
77};
78
79//=============================================================================
80
81}; }; }; };
82
83#endif
84