1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_embed_XInplaceObject_idl__ 28#define __com_sun_star_embed_XInplaceObject_idl__ 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34#ifndef __com_sun_star_awt_Rectangle_idl__ 35#include <com/sun/star/awt/Rectangle.idl> 36#endif 37 38#ifndef __com_sun_star_awt_KeyEvent_idl__ 39#include <com/sun/star/awt/KeyEvent.idl> 40#endif 41 42#ifndef __com_sun_star_embed_WrongStateException_idl__ 43#include <com/sun/star/embed/WrongStateException.idl> 44#endif 45 46 47 48//============================================================================ 49 50 module com { module sun { module star { module embed { 51 52//============================================================================ 53/** represents common functionality for inplace embedded objects. 54 */ 55published interface XInplaceObject: com::sun::star::uno::XInterface 56{ 57 //------------------------------------------------------------------------ 58 /** sets the visible part of the inplace object. 59 60 <p> 61 Both rectangles are provided in object's parent window coordinates 62 in pixels. The intersection of rectangles specifies the visible part 63 of the object. In case the position window has a size that is 64 different from object's visual area size, the object should either 65 scale or deactivate. 66 </p> 67 68 <p> 69 The method must activate object repainting. 70 </p> 71 72 @param aPosRect 73 specifies a new position rectangle 74 75 @param aClipRect 76 specifies a new clip rectangle 77 78 @throws com::sun::star::embed::WrongStateException 79 the object is in invalid state 80 81 @throws com::sun::star::uno::Exception 82 in case of other problems 83 */ 84 void setObjectRectangles( [in] ::com::sun::star::awt::Rectangle aPosRect, 85 [in] ::com::sun::star::awt::Rectangle aClipRect ) 86 raises( ::com::sun::star::embed::WrongStateException, 87 ::com::sun::star::uno::Exception ); 88 89 //------------------------------------------------------------------------ 90 /** enables or disables modeless dialogs of the object. 91 92 <p> 93 In case contaner whants to show a modal dialog it should disable 94 modeless of embedded object dialogs with this call. Later the same 95 call can be used to enable it. 96 </p> 97 98 @param bEnable 99 <TRUE/> to enable object modeless 100 <FALSE/> to disable it 101 102 @throws com::sun::star::embed::WrongStateException 103 the object is in wrong state 104 105 @throws com::sun::star::uno::Exception 106 in case of other problems 107 */ 108 void enableModeless( [in] boolean bEnable ) 109 raises( ::com::sun::star::embed::WrongStateException, 110 ::com::sun::star::uno::Exception ); 111 112 //------------------------------------------------------------------------ 113 /** provides accelerator table the container whants to use during inplace 114 editing. 115 116 @return 117 an accelerator table from container 118 119 @throws com::sun::star::embed::WrongStateException 120 the object is in unexpected state 121 */ 122 void translateAccelerators( 123 [in] sequence< ::com::sun::star::awt::KeyEvent > aKeys ) 124 raises( ::com::sun::star::embed::WrongStateException ); 125 126}; 127 128//============================================================================ 129 130}; }; }; }; 131 132#endif 133 134