offapi/com/sun/star/ui/XDockingAreaAcceptor.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: XDockingAreaAcceptor.idl,v $
  10  * $Revision: 1.5 $
  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_ui_XDockingAreaAcceptor_idl__
  32 #define __com_sun_star_ui_XDockingAreaAcceptor_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_awt_Rectangle_idl__
  39 #include <com/sun/star/awt/Rectangle.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_awt_XWindow_idl__
  43 #include <com/sun/star/awt/XWindow.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module ui {
  49
  50 //=============================================================================
  51
  52 /** this interface enables developer to implement different docking area
  53     acceptors which are used by the frame based layout manager.
  54
  55     <p>
  56     A docking area acceptor is responsible to control the docking area of a
  57     container window. As OLE for example supports inplace and outplace editing,
  58     there are different parts of code responsible for the container window.
  59     This interface enables developer to make support implementations for these
  60     scenarios.
  61
  62     @see com::sun::star::frame::XFrame
  63     </p>
  64
  65     @since OOo 2.0.0
  66 */
  67
  68
  69 interface XDockingAreaAcceptor : com::sun::star::uno::XInterface
  70 {
  71     /** provide the container window where the layout manager can request border
  72         space for docking windows.
  73
  74         <p>
  75         Additionally the layout manager uses this window to create its own child
  76         windows for docking purposes.
  77         </p>
  78     */
  79     com::sun::star::awt::XWindow getContainerWindow();
  80
  81     /** method to ask an implementation if the provided space for docking windows
  82         is available or not.
  83
  84         <p>
  85         The <type scope="com::sun::star::awt">Rectangle</type> parameter is
  86         filled by the caller with pixel data. The members of
  87         <type scope="com::sun::star::awt">Rectangle</type> must be filled
  88         as following:
  89         <ul>
  90             <li>X      = requested area on left side (in pixel)</li>
  91             <li>Y      = requested area on top side (in pixel)</li>
  92             <li>Width  = requested area on right side (in pixel)</li>
  93             <li>Height = requested area on bottom side (in pixel)</li>
  94         </ul>
  95         </p>
  96     */
  97     boolean requestDockingAreaSpace( [in] com::sun::star::awt::Rectangle RequestedSpace );
  98
  99     /** method to brief an implementation that we need new border space.
 100
 101         <p>
 102         The callee must size its document window so that we have the amount
 103         of space we have provided. The <type scope="com::sun::star::awt">Rectangle</type>
 104         parameter is filled by the caller with pixel data. The members of
 105         <type scope="com::sun::star::awt">Rectangle</type> must be filled as
 106         following:
 107         <ul>
 108             <li>X      = new area on left side (in pixel)</li>
 109             <li>Y      = new area on top side (in pixel)</li>
 110             <li>Width  = new area on right side (in pixel)</li>
 111             <li>Height = new area on bottom side (in pixel)</li>
 112         </ul>
 113         </p>
 114     */
 115     void setDockingAreaSpace( [in] com::sun::star::awt::Rectangle BorderSpace );
 116 };
 117
 118 }; }; }; };
 119
 120 //=============================================================================
 121
 122 #endif