xref: /aoo42x/main/offapi/com/sun/star/ui/XToolPanel.idl (revision d1766043)
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
24#ifndef __com_sun_star_ui_XToolPanel_idl__
25#define __com_sun_star_ui_XToolPanel_idl__
26
27#include <com/sun/star/awt/XWindow.idl>
28#include <com/sun/star/accessibility/XAccessible.idl>
29
30//=============================================================================
31
32module com { module sun { module star { module ui {
33
34//=============================================================================
35
36/** describes the basic interface to be implemented by a tool panel
37 */
38published interface XToolPanel
39{
40    /** provides access to the tool panel's main window.
41
42    <p>It is allowed for an implementation to return <NULL/> here, but in this case some functionality, for instance
43    automatic positioning of the tool panel, might not be available, and must be implemented by the tool panel itself.</p>
44    */
45    [attribute, readonly] ::com::sun::star::awt::XWindow    Window;
46
47    /** creates the root of the Accessibility object tree for the tool panel
48        @param ParentAccessible
49            the parent object in the Accessibility object tree
50    */
51    ::com::sun::star::accessibility::XAccessible
52        createAccessible( [in] ::com::sun::star::accessibility::XAccessible ParentAccessible );
53};
54
55//=============================================================================
56
57}; }; }; };
58
59//=============================================================================
60
61#endif
62