offapi/com/sun/star/frame/XControllerBorder.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 #ifndef __com_sun_star_frame_XControllerBorder_idl__
  28 #define __com_sun_star_frame_XControllerBorder_idl__
  29
  30 #ifndef __com_sun_star_frame_BorderWidths_idl__
  31 #include <com/sun/star/frame/BorderWidths.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_frame_XBorderResizeListener_idl__
  35 #include <com/sun/star/frame/XBorderResizeListener.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_awt_Rectangle_idl__
  39 #include <com/sun/star/awt/Rectangle.idl>
  40 #endif
  41
  42
  43 //============================================================================
  44
  45  module com {  module sun {  module star {  module frame {
  46
  47 //============================================================================
  48 /** allows to retrieve information about controller's border.
  49  */
  50 interface XControllerBorder: com::sun::star::uno::XInterface
  51 {
  52     //------------------------------------------------------------------------
  53     /** allows to get current border sizes of the document.
  54
  55         @return
  56             <type>BorderWidths</type> representing the sizes of border
  57      */
  58     BorderWidths getBorder();
  59
  60     //------------------------------------------------------------------------
  61     /** adds the specified listener to receive events about controller's
  62         border resizing.
  63      */
  64     void addBorderResizeListener( [in] XBorderResizeListener xListener );
  65
  66     //------------------------------------------------------------------------
  67     /** removes the specified listener.
  68      */
  69     void removeBorderResizeListener( [in] XBorderResizeListener xListener );
  70
  71     //------------------------------------------------------------------------
  72     /** allows to get suggestion for resizing of object area surrounded
  73         by the border.
  74
  75         <p> If the view is going to be resized/moved this method can be
  76         used to get suggested object area. Pixels are used as units.
  77         </p>
  78
  79         @return
  80             suggestion for the resizing
  81      */
  82     ::com::sun::star::awt::Rectangle queryBorderedArea(
  83             [in] ::com::sun::star::awt::Rectangle aPreliminaryRectangle );
  84 };
  85
  86 //============================================================================
  87
  88 }; }; }; };
  89
  90 #endif
  91