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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module ui {
  22
  23
  24 /** this interface enables developer to implement different docking area
  25     acceptors which are used by the frame based layout manager.
  26
  27     <p>
  28     A docking area acceptor is responsible to control the docking area of a
  29     container window. As OLE for example supports inplace and outplace editing,
  30     there are different parts of code responsible for the container window.
  31     This interface enables developer to make support implementations for these
  32     scenarios.
  33
  34     @see com::sun::star::frame::XFrame
  35     </p>
  36
  37     @since OOo 2.0
  38 */
  39
  40
  41 interface XDockingAreaAcceptor : com::sun::star::uno::XInterface
  42 {
  43     /** provide the container window where the layout manager can request border
  44         space for docking windows.
  45
  46         <p>
  47         Additionally the layout manager uses this window to create its own child
  48         windows for docking purposes.
  49         </p>
  50     */
  51     com::sun::star::awt::XWindow getContainerWindow();
  52
  53     /** method to ask an implementation if the provided space for docking windows
  54         is available or not.
  55
  56         <p>
  57         The com::sun::star::awt::Rectangle parameter is
  58         filled by the caller with pixel data. The members of
  59         com::sun::star::awt::Rectangle must be filled
  60         as following:
  61         <ul>
  62             <li>X      = requested area on left side (in pixel)</li>
  63             <li>Y      = requested area on top side (in pixel)</li>
  64             <li>Width  = requested area on right side (in pixel)</li>
  65             <li>Height = requested area on bottom side (in pixel)</li>
  66         </ul>
  67         </p>
  68     */
  69     boolean requestDockingAreaSpace( [in] com::sun::star::awt::Rectangle RequestedSpace );
  70
  71     /** method to brief an implementation that we need new border space.
  72
  73         <p>
  74         The callee must size its document window so that we have the amount
  75         of space we have provided. The com::sun::star::awt::Rectangle
  76         parameter is filled by the caller with pixel data. The members of
  77         com::sun::star::awt::Rectangle must be filled as
  78         following:
  79         <ul>
  80             <li>X      = new area on left side (in pixel)</li>
  81             <li>Y      = new area on top side (in pixel)</li>
  82             <li>Width  = new area on right side (in pixel)</li>
  83             <li>Height = new area on bottom side (in pixel)</li>
  84         </ul>
  85         </p>
  86     */
  87     void setDockingAreaSpace( [in] com::sun::star::awt::Rectangle BorderSpace );
  88 };
  89
  90 }; }; }; };
  91
  92
  93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */