offapi/com/sun/star/ui/XDockingAreaAcceptor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_ui_XDockingAreaAcceptor_idl__
  29 #define __com_sun_star_ui_XDockingAreaAcceptor_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_awt_Rectangle_idl__
  36 #include <com/sun/star/awt/Rectangle.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_awt_XWindow_idl__
  40 #include <com/sun/star/awt/XWindow.idl>
  41 #endif
  42
  43 //=============================================================================
  44
  45 module com { module sun { module star { module ui {
  46
  47 //=============================================================================
  48
  49 /** this interface enables developer to implement different docking area
  50     acceptors which are used by the frame based layout manager.
  51
  52     <p>
  53     A docking area acceptor is responsible to control the docking area of a
  54     container window. As OLE for example supports inplace and outplace editing,
  55     there are different parts of code responsible for the container window.
  56     This interface enables developer to make support implementations for these
  57     scenarios.
  58
  59     @see com::sun::star::frame::XFrame
  60     </p>
  61
  62     @since OOo 2.0.0
  63 */
  64
  65
  66 interface XDockingAreaAcceptor : com::sun::star::uno::XInterface
  67 {
  68     /** provide the container window where the layout manager can request border
  69         space for docking windows.
  70
  71         <p>
  72         Additionally the layout manager uses this window to create its own child
  73         windows for docking purposes.
  74         </p>
  75     */
  76     com::sun::star::awt::XWindow getContainerWindow();
  77
  78     /** method to ask an implementation if the provided space for docking windows
  79         is available or not.
  80
  81         <p>
  82         The <type scope="com::sun::star::awt">Rectangle</type> parameter is
  83         filled by the caller with pixel data. The members of
  84         <type scope="com::sun::star::awt">Rectangle</type> must be filled
  85         as following:
  86         <ul>
  87             <li>X      = requested area on left side (in pixel)</li>
  88             <li>Y      = requested area on top side (in pixel)</li>
  89             <li>Width  = requested area on right side (in pixel)</li>
  90             <li>Height = requested area on bottom side (in pixel)</li>
  91         </ul>
  92         </p>
  93     */
  94     boolean requestDockingAreaSpace( [in] com::sun::star::awt::Rectangle RequestedSpace );
  95
  96     /** method to brief an implementation that we need new border space.
  97
  98         <p>
  99         The callee must size its document window so that we have the amount
 100         of space we have provided. The <type scope="com::sun::star::awt">Rectangle</type>
 101         parameter is filled by the caller with pixel data. The members of
 102         <type scope="com::sun::star::awt">Rectangle</type> must be filled as
 103         following:
 104         <ul>
 105             <li>X      = new area on left side (in pixel)</li>
 106             <li>Y      = new area on top side (in pixel)</li>
 107             <li>Width  = new area on right side (in pixel)</li>
 108             <li>Height = new area on bottom side (in pixel)</li>
 109         </ul>
 110         </p>
 111     */
 112     void setDockingAreaSpace( [in] com::sun::star::awt::Rectangle BorderSpace );
 113 };
 114
 115 }; }; }; };
 116
 117 //=============================================================================
 118
 119 #endif