xref: /aoo42x/main/offapi/com/sun/star/ui/XToolPanel.idl (revision cdf0e10c)
1/*************************************************************************
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * Copyright 2000, 2010 Oracle and/or its affiliates.
5 *
6 * OpenOffice.org - a multi-platform office productivity suite
7 *
8 * This file is part of OpenOffice.org.
9 *
10 * OpenOffice.org is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Lesser General Public License version 3
12 * only, as published by the Free Software Foundation.
13 *
14 * OpenOffice.org is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU Lesser General Public License version 3 for more details
18 * (a copy is included in the LICENSE file that accompanied this code).
19 *
20 * You should have received a copy of the GNU Lesser General Public License
21 * version 3 along with OpenOffice.org.  If not, see
22 * <http://www.openoffice.org/license.html>
23 * for a copy of the LGPLv3 License.
24 *
25************************************************************************/
26
27#ifndef __com_sun_star_ui_XToolPanel_idl__
28#define __com_sun_star_ui_XToolPanel_idl__
29
30#include <com/sun/star/awt/XWindow.idl>
31#include <com/sun/star/accessibility/XAccessible.idl>
32
33//=============================================================================
34
35module com { module sun { module star { module ui {
36
37//=============================================================================
38
39/** describes the basic interface to be implemented by a tool panel
40 */
41published interface XToolPanel
42{
43    /** provides access to the tool panel's main window.
44
45    <p>It is allowed for an implementation to return <NULL/> here, but in this case some functionality, for instance
46    automatic positioning of the tool panel, might not be available, and must be implemented by the tool panel itself.</p>
47    */
48    [attribute, readonly] ::com::sun::star::awt::XWindow    Window;
49
50    /** creates the root of the Accessibility object tree for the tool panel
51        @param ParentAccessible
52            the parent object in the Accessibility object tree
53    */
54    ::com::sun::star::accessibility::XAccessible
55        createAccessible( [in] ::com::sun::star::accessibility::XAccessible ParentAccessible );
56};
57
58//=============================================================================
59
60}; }; }; };
61
62//=============================================================================
63
64#endif
65