xref: /aoo41x/main/offapi/com/sun/star/ui/XToolPanel.idl (revision cdf0e10c)

/*************************************************************************
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
************************************************************************/

#ifndef __com_sun_star_ui_XToolPanel_idl__
#define __com_sun_star_ui_XToolPanel_idl__

#include <com/sun/star/awt/XWindow.idl>
#include <com/sun/star/accessibility/XAccessible.idl>

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

module com { module sun { module star { module ui {

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

/** describes the basic interface to be implemented by a tool panel
 */
published interface XToolPanel
{
    /** provides access to the tool panel's main window.

    <p>It is allowed for an implementation to return <NULL/> here, but in this case some functionality, for instance
    automatic positioning of the tool panel, might not be available, and must be implemented by the tool panel itself.</p>
    */
    [attribute, readonly] ::com::sun::star::awt::XWindow    Window;

    /** creates the root of the Accessibility object tree for the tool panel
        @param ParentAccessible
            the parent object in the Accessibility object tree
    */
    ::com::sun::star::accessibility::XAccessible
        createAccessible( [in] ::com::sun::star::accessibility::XAccessible ParentAccessible );
};

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

}; }; }; };

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

#endif