offapi/com/sun/star/embed/XHatchWindowController.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_embed_XHatchWindowController_idl__
  20 #define __com_sun_star_embed_XHatchWindowController_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/awt/Rectangle.idl>
  24
  25
  26  module com {  module sun {  module star {  module embed {
  27
  28
  29 /** specifies the operations for a hatch window.
  30
  31     <p>
  32     A hatch window owner is responsible to handle resize/move requests
  33     sent by the window. It is also responsible to validate tracking
  34     rectangle size.
  35     </p>
  36  */
  37 published interface XHatchWindowController: com::sun::star::uno::XInterface
  38 {
  39     /** requests window owner to resize/move the window.
  40
  41         @param aRect
  42             the new requested position and size of the window
  43      */
  44     void requestPositioning( [in] com::sun::star::awt::Rectangle aRect );
  45
  46     /** returns the closest valid rectangle to the provided one.
  47
  48         @param aRect
  49             a new selected position and size of the tracking rectangle
  50
  51         @returns
  52             the closest valid position and size to the provided one
  53      */
  54     com::sun::star::awt::Rectangle calcAdjustedRectangle(
  55                     [in] com::sun::star::awt::Rectangle aRect );
  56
  57     void activated();
  58     void deactivated();
  59 };
  60
  61
  62 }; }; }; };
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */