offapi/com/sun/star/embed/XInplaceClient.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: XInplaceClient.idl,v $
  10  * $Revision: 1.7 $
  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_XInplaceClient_idl__
  31 #define __com_sun_star_embed_XInplaceClient_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_container_XIndexAccess_idl__
  38 #include <com/sun/star/container/XIndexAccess.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_frame_XDispatchProvider_idl__
  42 #include <com/sun/star/frame/XDispatchProvider.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_frame_XLayoutManager_idl__
  46 #include <com/sun/star/frame/XLayoutManager.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_awt_XWindow_idl__
  50 #include <com/sun/star/awt/XWindow.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_awt_Rectangle_idl__
  54 #include <com/sun/star/awt/Rectangle.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_awt_Size_idl__
  58 #include <com/sun/star/awt/Size.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_awt_KeyEvent_idl__
  62 #include <com/sun/star/awt/KeyEvent.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_embed_WrongStateException_idl__
  66 #include <com/sun/star/embed/WrongStateException.idl>
  67 #endif
  68
  69
  70 //============================================================================
  71
  72  module com {  module sun {  module star {  module embed {
  73
  74 //============================================================================
  75 /** represents common functionality for inplace clients.
  76  */
  77 interface XInplaceClient: com::sun::star::uno::XInterface
  78 {
  79     //------------------------------------------------------------------------
  80     /** checks if the container can activate the object inplace.
  81
  82         @return
  83             <TRUE/> the container can activate the object inplace.
  84             <FALSE/> otherwise.
  85      */
  86     boolean canInplaceActivate();
  87
  88     //------------------------------------------------------------------------
  89     /** notifies container through the client that the object is to be
  90         inplace activated.
  91
  92         @throws com::sun::star::embed::WrongStateException
  93             the container is not ready for activation
  94      */
  95     void activatingInplace()
  96         raises( ::com::sun::star::embed::WrongStateException );
  97
  98     //------------------------------------------------------------------------
  99     /** notifies container through the client that the object is to be
 100         UI-activated.
 101
 102         @throws com::sun::star::embed::WrongStateException
 103             the container is not ready for activation
 104      */
 105     void activatingUI()
 106         raises( ::com::sun::star::embed::WrongStateException );
 107
 108     //------------------------------------------------------------------------
 109     /** notifies container through the client that the object is deactivated.
 110
 111         @throws com::sun::star::embed::WrongStateException
 112             the container is not ready for deactivation
 113      */
 114     void deactivatedInplace()
 115         raises( ::com::sun::star::embed::WrongStateException );
 116
 117     //------------------------------------------------------------------------
 118     /** notifies container through the client that the object is
 119         UI-deactivated.
 120
 121         <p>
 122         After this notification the container can restore it's own UI and take focus.
 123         </p>
 124
 125         @throws com::sun::star::embed::WrongStateException
 126             the container is not ready for deactivation
 127      */
 128     void deactivatedUI()
 129         raises( ::com::sun::star::embed::WrongStateException );
 130
 131     //------------------------------------------------------------------------
 132     /** allows to retrieve the
 133         <type scope="com::sun::star::frame">LayoutManager</type> of the
 134         container.
 135
 136         @return
 137             reference to object representing the
 138             <type scope="com::sun::star::frame">LayoutManager</type> of the
 139             container
 140
 141         @throws com::sun::star::embed::WrongStateException
 142             the object is in unexpected state to make such request
 143      */
 144     ::com::sun::star::frame::XLayoutManager getLayoutManager()
 145         raises( ::com::sun::star::embed::WrongStateException );
 146
 147     //------------------------------------------------------------------------
 148     /** allows to retrieve the container's dispatch provider.
 149
 150         @return
 151             reference to object implementing the
 152             <type scope="com::sun::star::frame">XDispatchProvider</type>
 153
 154         @throws com::sun::star::embed::WrongStateException
 155             the object is in unexpected state to make such request
 156      */
 157     ::com::sun::star::frame::XDispatchProvider getInplaceDispatchProvider()
 158         raises( ::com::sun::star::embed::WrongStateException );
 159
 160     //------------------------------------------------------------------------
 161     /** gets the inplace object position rectangle.
 162
 163         <p>
 164         The rectangle is provided in object's parent window coordinates in
 165         pixels. The intersection of position and clip rectangles specifies
 166         the visible part of the object. In case the position window has a size
 167         that is bigger than object's size, the object should either scale or
 168         deactivate.
 169         </p>
 170
 171         @return
 172             specifies a new position rectangle
 173
 174         @throws com::sun::star::embed::WrongStateException
 175             the object is in unexpected state to make such request
 176      */
 177     ::com::sun::star::awt::Rectangle getPlacement()
 178         raises( ::com::sun::star::embed::WrongStateException );
 179
 180     //------------------------------------------------------------------------
 181     /** gets the inplace object clip rectangle.
 182
 183         <p>
 184         The rectangle is provided in object's parent window coordinates in
 185         pixels. The intersection of position and clip rectangles specifies
 186         the visible part of the object.
 187         </p>
 188
 189         @return
 190             specifies a new clip rectangle
 191
 192         @throws com::sun::star::embed::WrongStateException
 193             the object is in unexpected state to make such request
 194      */
 195     ::com::sun::star::awt::Rectangle getClipRectangle()
 196         raises( ::com::sun::star::embed::WrongStateException );
 197
 198     //------------------------------------------------------------------------
 199     /** provides accelerator table the object whants to use while it is
 200         inplace active.
 201
 202         @param aKeys
 203             an accelerator table from object
 204
 205         @throws com::sun::star::embed::WrongStateException
 206             the object is in unexpected state
 207     */
 208     void translateAccelerators( [in] sequence< ::com::sun::star::awt::KeyEvent > aKeys )
 209         raises( ::com::sun::star::embed::WrongStateException );
 210
 211     //------------------------------------------------------------------------
 212     /** scrolls the object.
 213
 214         @param aOffset
 215             scrolls the object to specified offset in pixels
 216
 217         @throws com::sun::star::embed::WrongStateException
 218             the object is in unexpected state
 219      */
 220     void scrollObject( [in] ::com::sun::star::awt::Size aOffset )
 221         raises( ::com::sun::star::embed::WrongStateException );
 222
 223     //------------------------------------------------------------------------
 224     /** notifies the container that the position of the object is changed.
 225
 226         @param aPosRect
 227             specifies a new position rectangle
 228
 229         @throws com::sun::star::embed::WrongStateException
 230             the object state is not correct
 231
 232         @throws com::sun::star::uno::Exception
 233             in case of other problems
 234      */
 235     void changedPlacement( [in] ::com::sun::star::awt::Rectangle aPosRect )
 236         raises( ::com::sun::star::embed::WrongStateException,
 237                 ::com::sun::star::uno::Exception );
 238 };
 239
 240 //============================================================================
 241
 242 }; }; }; };
 243
 244 #endif
 245