xref: /AOO41X/main/offapi/com/sun/star/drawing/framework/XPane.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_drawing_framework_XPane_idl__
25cdf0e10cSrcweir#define __com_sun_star_drawing_framework_XPane_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_awt_XWindow_idl__
28cdf0e10cSrcweir#include <com/sun/star/awt/XWindow.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir#ifndef __com_sun_star_rendering_XCcanvas_idl__
31cdf0e10cSrcweir#include <com/sun/star/rendering/XCanvas.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir#ifndef __com_sun_star_drawing_framework_XResource_idl__
34cdf0e10cSrcweir#include <com/sun/star/drawing/framework/XResource.idl>
35cdf0e10cSrcweir#endif
36cdf0e10cSrcweir#ifndef __com_sun_star_drawing_framework_XRelocatableResource_idl__
37cdf0e10cSrcweir#include <com/sun/star/drawing/framework/XRelocatableResource.idl>
38cdf0e10cSrcweir#endif
39cdf0e10cSrcweir
40cdf0e10cSrcweirmodule com { module sun { module star { module drawing { module framework {
41cdf0e10cSrcweir
42cdf0e10cSrcweir/** A pane is an abstraction of a window and is one of the resources managed
43cdf0e10cSrcweir    by the drawing framework.
44cdf0e10cSrcweir    <p>Apart from the area that displays a view a pane may contain other
45cdf0e10cSrcweir    parts like title, menu, closer button.</p>
46cdf0e10cSrcweir    <p>The URL prefix of panes is <code>private:resource/floater</code></p>
47cdf0e10cSrcweir*/
48cdf0e10cSrcweirpublished interface XPane
49cdf0e10cSrcweir{
50cdf0e10cSrcweir    interface XResource;
51cdf0e10cSrcweir
52cdf0e10cSrcweir    /** Return the <type scope="com::sun::star::awt">XWindow</type> of the
53cdf0e10cSrcweir        pane that is used to display a view.
54cdf0e10cSrcweir    */
55cdf0e10cSrcweir    ::com::sun::star::awt::XWindow getWindow ();
56cdf0e10cSrcweir
57cdf0e10cSrcweir    /** Return the <type scope="com::sun::star::awt">XCanvas</type> of the pane.  The
58cdf0e10cSrcweir        <type scope="com::sun::star::rendering">XCanvas</type> object is expected to
59cdf0e10cSrcweir        be associated with the <type
60cdf0e10cSrcweir        scope="com::sun::star::awt">XWindow</type> object returned by
61cdf0e10cSrcweir        <member>getWindow()</member>.
62cdf0e10cSrcweir        @return
63cdf0e10cSrcweir            When the <type scope="com::sun::star::rendering">XCanvas</type>
64cdf0e10cSrcweir            interface is not supported then an empty reference is returned.
65cdf0e10cSrcweir    */
66cdf0e10cSrcweir    ::com::sun::star::rendering::XCanvas getCanvas ();
67cdf0e10cSrcweir};
68cdf0e10cSrcweir
69cdf0e10cSrcweir}; }; }; }; }; // ::com::sun::star::drawing::framework
70cdf0e10cSrcweir
71cdf0e10cSrcweir#endif
72