offapi/com/sun/star/frame/XControllerBorder.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XControllerBorder.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_frame_XControllerBorder_idl__
  31 #define __com_sun_star_frame_XControllerBorder_idl__
  32
  33 #ifndef __com_sun_star_frame_BorderWidths_idl__
  34 #include <com/sun/star/frame/BorderWidths.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_frame_XBorderResizeListener_idl__
  38 #include <com/sun/star/frame/XBorderResizeListener.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_Rectangle_idl__
  42 #include <com/sun/star/awt/Rectangle.idl>
  43 #endif
  44
  45
  46 //============================================================================
  47
  48  module com {  module sun {  module star {  module frame {
  49
  50 //============================================================================
  51 /** allows to retrieve information about controller's border.
  52  */
  53 interface XControllerBorder: com::sun::star::uno::XInterface
  54 {
  55     //------------------------------------------------------------------------
  56     /** allows to get current border sizes of the document.
  57
  58         @return
  59             <type>BorderWidths</type> representing the sizes of border
  60      */
  61     BorderWidths getBorder();
  62
  63     //------------------------------------------------------------------------
  64     /** adds the specified listener to receive events about controller's
  65         border resizing.
  66      */
  67     void addBorderResizeListener( [in] XBorderResizeListener xListener );
  68
  69     //------------------------------------------------------------------------
  70     /** removes the specified listener.
  71      */
  72     void removeBorderResizeListener( [in] XBorderResizeListener xListener );
  73
  74     //------------------------------------------------------------------------
  75     /** allows to get suggestion for resizing of object area surrounded
  76         by the border.
  77
  78         <p> If the view is going to be resized/moved this method can be
  79         used to get suggested object area. Pixels are used as units.
  80         </p>
  81
  82         @return
  83             suggestion for the resizing
  84      */
  85     ::com::sun::star::awt::Rectangle queryBorderedArea(
  86             [in] ::com::sun::star::awt::Rectangle aPreliminaryRectangle );
  87 };
  88
  89 //============================================================================
  90
  91 }; }; }; };
  92
  93 #endif
  94