offapi/com/sun/star/embed/XInplaceClient.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_XInplaceClient_idl__
  20 #define __com_sun_star_embed_XInplaceClient_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/container/XIndexAccess.idl>
  24 #include <com/sun/star/frame/XDispatchProvider.idl>
  25 #include <com/sun/star/frame/XLayoutManager.idl>
  26 #include <com/sun/star/awt/XWindow.idl>
  27 #include <com/sun/star/awt/Rectangle.idl>
  28 #include <com/sun/star/awt/Size.idl>
  29 #include <com/sun/star/awt/KeyEvent.idl>
  30 #include <com/sun/star/embed/WrongStateException.idl>
  31
  32
  33
  34  module com {  module sun {  module star {  module embed {
  35
  36 /** represents common functionality for inplace clients.
  37  */
  38 interface XInplaceClient: com::sun::star::uno::XInterface
  39 {
  40     /** checks if the container can activate the object inplace.
  41
  42         @return
  43             `TRUE` the container can activate the object inplace.
  44             `FALSE` otherwise.
  45      */
  46     boolean canInplaceActivate();
  47
  48     /** notifies container through the client that the object is to be
  49         inplace activated.
  50
  51         @throws com::sun::star::embed::WrongStateException
  52             the container is not ready for activation
  53      */
  54     void activatingInplace()
  55         raises( ::com::sun::star::embed::WrongStateException );
  56
  57     /** notifies container through the client that the object is to be
  58         UI-activated.
  59
  60         @throws com::sun::star::embed::WrongStateException
  61             the container is not ready for activation
  62      */
  63     void activatingUI()
  64         raises( ::com::sun::star::embed::WrongStateException );
  65
  66     /** notifies container through the client that the object is deactivated.
  67
  68         @throws com::sun::star::embed::WrongStateException
  69             the container is not ready for deactivation
  70      */
  71     void deactivatedInplace()
  72         raises( ::com::sun::star::embed::WrongStateException );
  73
  74     /** notifies container through the client that the object is
  75         UI-deactivated.
  76
  77         <p>
  78         After this notification the container can restore it's own UI and take focus.
  79         </p>
  80
  81         @throws com::sun::star::embed::WrongStateException
  82             the container is not ready for deactivation
  83      */
  84     void deactivatedUI()
  85         raises( ::com::sun::star::embed::WrongStateException );
  86
  87     /** allows to retrieve the
  88         com::sun::star::frame::LayoutManager of the
  89         container.
  90
  91         @return
  92             reference to object representing the
  93             com::sun::star::frame::LayoutManager of the
  94             container
  95
  96         @throws com::sun::star::embed::WrongStateException
  97             the object is in unexpected state to make such request
  98      */
  99     ::com::sun::star::frame::XLayoutManager getLayoutManager()
 100         raises( ::com::sun::star::embed::WrongStateException );
 101
 102     /** allows to retrieve the container's dispatch provider.
 103
 104         @return
 105             reference to object implementing the
 106             com::sun::star::frame::XDispatchProvider
 107
 108         @throws com::sun::star::embed::WrongStateException
 109             the object is in unexpected state to make such request
 110      */
 111     ::com::sun::star::frame::XDispatchProvider getInplaceDispatchProvider()
 112         raises( ::com::sun::star::embed::WrongStateException );
 113
 114     /** gets the inplace object position rectangle.
 115
 116         <p>
 117         The rectangle is provided in object's parent window coordinates in
 118         pixels. The intersection of position and clip rectangles specifies
 119         the visible part of the object. In case the position window has a size
 120         that is bigger than object's size, the object should either scale or
 121         deactivate.
 122         </p>
 123
 124         @return
 125             specifies a new position rectangle
 126
 127         @throws com::sun::star::embed::WrongStateException
 128             the object is in unexpected state to make such request
 129      */
 130     ::com::sun::star::awt::Rectangle getPlacement()
 131         raises( ::com::sun::star::embed::WrongStateException );
 132
 133     /** gets the inplace object clip rectangle.
 134
 135         <p>
 136         The rectangle is provided in object's parent window coordinates in
 137         pixels. The intersection of position and clip rectangles specifies
 138         the visible part of the object.
 139         </p>
 140
 141         @return
 142             specifies a new clip rectangle
 143
 144         @throws com::sun::star::embed::WrongStateException
 145             the object is in unexpected state to make such request
 146      */
 147     ::com::sun::star::awt::Rectangle getClipRectangle()
 148         raises( ::com::sun::star::embed::WrongStateException );
 149
 150     /** provides accelerator table the object wants to use while it is
 151         inplace active.
 152
 153         @param aKeys
 154             an accelerator table from object
 155
 156         @throws com::sun::star::embed::WrongStateException
 157             the object is in unexpected state
 158     */
 159     void translateAccelerators( [in] sequence< ::com::sun::star::awt::KeyEvent > aKeys )
 160         raises( ::com::sun::star::embed::WrongStateException );
 161
 162     /** scrolls the object.
 163
 164         @param aOffset
 165             scrolls the object to specified offset in pixels
 166
 167         @throws com::sun::star::embed::WrongStateException
 168             the object is in unexpected state
 169      */
 170     void scrollObject( [in] ::com::sun::star::awt::Size aOffset )
 171         raises( ::com::sun::star::embed::WrongStateException );
 172
 173     /** notifies the container that the position of the object is changed.
 174
 175         @param aPosRect
 176             specifies a new position rectangle
 177
 178         @throws com::sun::star::embed::WrongStateException
 179             the object state is not correct
 180
 181         @throws com::sun::star::uno::Exception
 182             in case of other problems
 183      */
 184     void changedPlacement( [in] ::com::sun::star::awt::Rectangle aPosRect )
 185         raises( ::com::sun::star::embed::WrongStateException,
 186                 ::com::sun::star::uno::Exception );
 187 };
 188
 189
 190 }; }; }; };
 191
 192 #endif
 193
 194 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */