/*************************************************************************
 *
 * 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_drawing_framework_XPane_idl__
#define __com_sun_star_drawing_framework_XPane_idl__

#ifndef __com_sun_star_awt_XWindow_idl__
#include <com/sun/star/awt/XWindow.idl>
#endif
#ifndef __com_sun_star_rendering_XCcanvas_idl__
#include <com/sun/star/rendering/XCanvas.idl>
#endif
#ifndef __com_sun_star_drawing_framework_XResource_idl__
#include <com/sun/star/drawing/framework/XResource.idl>
#endif
#ifndef __com_sun_star_drawing_framework_XRelocatableResource_idl__
#include <com/sun/star/drawing/framework/XRelocatableResource.idl>
#endif

module com { module sun { module star { module drawing { module framework {

/** A pane is an abstraction of a window and is one of the resources managed
    by the drawing framework.
    <p>Apart from the area that displays a view a pane may contain other
    parts like title, menu, closer button.</p>
    <p>The URL prefix of panes is <code>private:resource/floater</code></p>
*/
interface XPane
{
    interface XResource;

    /** Return the <type scope="com::sun::star::awt">XWindow</type> of the
        pane that is used to display a view.
    */
    ::com::sun::star::awt::XWindow getWindow ();

    /** Return the <type scope="com::sun::star::awt">XCanvas</type> of the pane.  The
        <type scope="com::sun::star::rendering">XCanvas</type> object is expected to 
        be associated with the <type
        scope="com::sun::star::awt">XWindow</type> object returned by
        <member>getWindow()</member>.
        @return
            When the <type scope="com::sun::star::rendering">XCanvas</type>
            interface is not supported then an empty reference is returned.
    */
    ::com::sun::star::rendering::XCanvas getCanvas ();
};

}; }; }; }; }; // ::com::sun::star::drawing::framework

#endif
