offapi/com/sun/star/embed/XHatchWindowController.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: XHatchWindowController.idl,v $
  10  * $Revision: 1.5 $
  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_embed_XHatchWindowController_idl__
  31 #define __com_sun_star_embed_XHatchWindowController_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_Rectangle_idl__
  38 #include <com/sun/star/awt/Rectangle.idl>
  39 #endif
  40
  41 //============================================================================
  42
  43  module com {  module sun {  module star {  module embed {
  44
  45 //============================================================================
  46
  47 /** specifies the operations for a hatch window.
  48
  49     <p>
  50     A hatch window owner is responsible to handle resize/move requests
  51     sent by the window. It is also responsible to validate tracking
  52     rectangle size.
  53     </p>
  54  */
  55 interface XHatchWindowController: com::sun::star::uno::XInterface
  56 {
  57     //------------------------------------------------------------------------
  58     /** requests window owner to resize/move the window.
  59
  60         @param aRect
  61             the new requested position and size of the window
  62      */
  63     void requestPositioning( [in] com::sun::star::awt::Rectangle aRect );
  64
  65     //------------------------------------------------------------------------
  66     /** returns the closest valid rectangle to the provided one.
  67
  68         @param aRect
  69             a new selected position and size of the tracking rectangle
  70
  71         @returns
  72             the closest valid position and size to the provided one
  73      */
  74     com::sun::star::awt::Rectangle calcAdjustedRectangle(
  75                     [in] com::sun::star::awt::Rectangle aRect );
  76
  77     void activated();
  78     void deactivated();
  79 };
  80
  81 //============================================================================
  82
  83 }; }; }; };
  84
  85 #endif
  86