offapi/com/sun/star/drawing/framework/XPane.idl

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