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_drawing_framework_XPane_idl__
25#define __com_sun_star_drawing_framework_XPane_idl__
26
27#ifndef __com_sun_star_awt_XWindow_idl__
28#include <com/sun/star/awt/XWindow.idl>
29#endif
30#ifndef __com_sun_star_rendering_XCcanvas_idl__
31#include <com/sun/star/rendering/XCanvas.idl>
32#endif
33#ifndef __com_sun_star_drawing_framework_XResource_idl__
34#include <com/sun/star/drawing/framework/XResource.idl>
35#endif
36#ifndef __com_sun_star_drawing_framework_XRelocatableResource_idl__
37#include <com/sun/star/drawing/framework/XRelocatableResource.idl>
38#endif
39
40module com { module sun { module star { module drawing { module framework {
41
42/** A pane is an abstraction of a window and is one of the resources managed
43    by the drawing framework.
44    <p>Apart from the area that displays a view a pane may contain other
45    parts like title, menu, closer button.</p>
46    <p>The URL prefix of panes is <code>private:resource/floater</code></p>
47*/
48published interface XPane
49{
50    interface XResource;
51
52    /** Return the <type scope="com::sun::star::awt">XWindow</type> of the
53        pane that is used to display a view.
54    */
55    ::com::sun::star::awt::XWindow getWindow ();
56
57    /** Return the <type scope="com::sun::star::awt">XCanvas</type> of the pane.  The
58        <type scope="com::sun::star::rendering">XCanvas</type> object is expected to
59        be associated with the <type
60        scope="com::sun::star::awt">XWindow</type> object returned by
61        <member>getWindow()</member>.
62        @return
63            When the <type scope="com::sun::star::rendering">XCanvas</type>
64            interface is not supported then an empty reference is returned.
65    */
66    ::com::sun::star::rendering::XCanvas getCanvas ();
67};
68
69}; }; }; }; }; // ::com::sun::star::drawing::framework
70
71#endif
72