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