xref: /aoo4110/main/offapi/com/sun/star/drawing/framework/XPane.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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>
*/
published 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