1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_drawing_framework_XPane_idl__
29#define __com_sun_star_drawing_framework_XPane_idl__
30
31#ifndef __com_sun_star_awt_XWindow_idl__
32#include <com/sun/star/awt/XWindow.idl>
33#endif
34#ifndef __com_sun_star_rendering_XCcanvas_idl__
35#include <com/sun/star/rendering/XCanvas.idl>
36#endif
37#ifndef __com_sun_star_drawing_framework_XResource_idl__
38#include <com/sun/star/drawing/framework/XResource.idl>
39#endif
40#ifndef __com_sun_star_drawing_framework_XRelocatableResource_idl__
41#include <com/sun/star/drawing/framework/XRelocatableResource.idl>
42#endif
43
44module com { module sun { module star { module drawing { module framework {
45
46/** A pane is an abstraction of a window and is one of the resources managed
47    by the drawing framework.
48    <p>Apart from the area that displays a view a pane may contain other
49    parts like title, menu, closer button.</p>
50    <p>The URL prefix of panes is <code>private:resource/floater</code></p>
51*/
52published interface XPane
53{
54    interface XResource;
55
56    /** Return the <type scope="com::sun::star::awt">XWindow</type> of the
57        pane that is used to display a view.
58    */
59    ::com::sun::star::awt::XWindow getWindow ();
60
61    /** Return the <type scope="com::sun::star::awt">XCanvas</type> of the pane.  The
62        <type scope="com::sun::star::rendering">XCanvas</type> object is expected to
63        be associated with the <type
64        scope="com::sun::star::awt">XWindow</type> object returned by
65        <member>getWindow()</member>.
66        @return
67            When the <type scope="com::sun::star::rendering">XCanvas</type>
68            interface is not supported then an empty reference is returned.
69    */
70    ::com::sun::star::rendering::XCanvas getCanvas ();
71};
72
73}; }; }; }; }; // ::com::sun::star::drawing::framework
74
75#endif
76