offapi/com/sun/star/frame/XControllerBorder.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
  22  module com {  module sun {  module star {  module frame {
  23
  24 /** allows to retrieve information about controller's border.
  25  */
  26 interface XControllerBorder: com::sun::star::uno::XInterface
  27 {
  28     /** allows to get current border sizes of the document.
  29
  30         @return
  31             BorderWidths representing the sizes of border
  32      */
  33     BorderWidths getBorder();
  34
  35     /** adds the specified listener to receive events about controller's
  36         border resizing.
  37      */
  38     void addBorderResizeListener( [in] XBorderResizeListener xListener );
  39
  40     /** removes the specified listener.
  41      */
  42     void removeBorderResizeListener( [in] XBorderResizeListener xListener );
  43
  44     /** allows to get suggestion for resizing of object area surrounded
  45         by the border.
  46
  47         <p> If the view is going to be resized/moved this method can be
  48         used to get suggested object area. Pixels are used as units.
  49         </p>
  50
  51         @return
  52             suggestion for the resizing
  53      */
  54     ::com::sun::star::awt::Rectangle queryBorderedArea(
  55             [in] ::com::sun::star::awt::Rectangle aPreliminaryRectangle );
  56 };
  57
  58
  59 }; }; }; };
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */