offapi/com/sun/star/embed/XInplaceObject.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_XInplaceObject_idl__
  20 #define __com_sun_star_embed_XInplaceObject_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/awt/Rectangle.idl>
  24 #include <com/sun/star/awt/KeyEvent.idl>
  25 #include <com/sun/star/embed/WrongStateException.idl>
  26
  27
  28
  29
  30  module com {  module sun {  module star {  module embed {
  31
  32 /** represents common functionality for inplace embedded objects.
  33  */
  34 published interface XInplaceObject: com::sun::star::uno::XInterface
  35 {
  36     /** sets the visible part of the inplace object.
  37
  38         <p>
  39         Both rectangles are provided in object's parent window coordinates
  40         in pixels. The intersection of rectangles specifies the visible part
  41         of the object. In case the position window has a size that is
  42         different from object's visual area size, the object should either
  43         scale or deactivate.
  44         </p>
  45
  46         <p>
  47         The method must activate object repainting.
  48         </p>
  49
  50         @param aPosRect
  51             specifies a new position rectangle
  52
  53         @param aClipRect
  54             specifies a new clip rectangle
  55
  56         @throws com::sun::star::embed::WrongStateException
  57             the object is in invalid state
  58
  59         @throws com::sun::star::uno::Exception
  60             in case of other problems
  61      */
  62     void setObjectRectangles( [in] ::com::sun::star::awt::Rectangle aPosRect,
  63                          [in] ::com::sun::star::awt::Rectangle aClipRect )
  64         raises( ::com::sun::star::embed::WrongStateException,
  65                 ::com::sun::star::uno::Exception );
  66
  67     /** enables or disables modeless dialogs of the object.
  68
  69         <p>
  70         In case container wants to show a modal dialog it should disable
  71         modeless of embedded object dialogs with this call. Later the same
  72         call can be used to enable it.
  73         </p>
  74
  75         @param bEnable
  76             `TRUE` to enable object modeless
  77             `FALSE` to disable it
  78
  79         @throws com::sun::star::embed::WrongStateException
  80             the object is in wrong state
  81
  82         @throws com::sun::star::uno::Exception
  83             in case of other problems
  84      */
  85     void enableModeless( [in] boolean bEnable )
  86         raises( ::com::sun::star::embed::WrongStateException,
  87                 ::com::sun::star::uno::Exception );
  88
  89     /** provides accelerator table the container wants to use during inplace
  90         editing.
  91
  92         @return
  93             an accelerator table from container
  94
  95         @throws com::sun::star::embed::WrongStateException
  96             the object is in unexpected state
  97      */
  98     void translateAccelerators(
  99             [in] sequence< ::com::sun::star::awt::KeyEvent > aKeys )
 100         raises( ::com::sun::star::embed::WrongStateException );
 101
 102 };
 103
 104
 105 }; }; }; };
 106
 107 #endif
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */