merge the formfield patch from ooo-build
[ooovba.git] / offapi / com / sun / star / embed / XInplaceObject.idl
blob0db0e8017b0d686e3635d75bf606005acc38b5d9
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XInplaceObject.idl,v $
10 * $Revision: 1.6 $
12 * This file is part of OpenOffice.org.
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.
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).
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.
29 ************************************************************************/
30 #ifndef __com_sun_star_embed_XInplaceObject_idl__
31 #define __com_sun_star_embed_XInplaceObject_idl__
33 #ifndef __com_sun_star_uno_XInterface_idl__
34 #include <com/sun/star/uno/XInterface.idl>
35 #endif
37 #ifndef __com_sun_star_awt_Rectangle_idl__
38 #include <com/sun/star/awt/Rectangle.idl>
39 #endif
41 #ifndef __com_sun_star_awt_KeyEvent_idl__
42 #include <com/sun/star/awt/KeyEvent.idl>
43 #endif
45 #ifndef __com_sun_star_embed_WrongStateException_idl__
46 #include <com/sun/star/embed/WrongStateException.idl>
47 #endif
51 //============================================================================
53 module com { module sun { module star { module embed {
55 //============================================================================
56 /** represents common functionality for inplace embedded objects.
58 interface XInplaceObject: com::sun::star::uno::XInterface
60 //------------------------------------------------------------------------
61 /** sets the visible part of the inplace object.
63 <p>
64 Both rectangles are provided in object's parent window coordinates
65 in pixels. The intersection of rectangles specifies the visible part
66 of the object. In case the position window has a size that is
67 different from object's visual area size, the object should either
68 scale or deactivate.
69 </p>
71 <p>
72 The method must activate object repainting.
73 </p>
75 @param aPosRect
76 specifies a new position rectangle
78 @param aClipRect
79 specifies a new clip rectangle
81 @throws com::sun::star::embed::WrongStateException
82 the object is in invalid state
84 @throws com::sun::star::uno::Exception
85 in case of other problems
87 void setObjectRectangles( [in] ::com::sun::star::awt::Rectangle aPosRect,
88 [in] ::com::sun::star::awt::Rectangle aClipRect )
89 raises( ::com::sun::star::embed::WrongStateException,
90 ::com::sun::star::uno::Exception );
92 //------------------------------------------------------------------------
93 /** enables or disables modeless dialogs of the object.
95 <p>
96 In case contaner whants to show a modal dialog it should disable
97 modeless of embedded object dialogs with this call. Later the same
98 call can be used to enable it.
99 </p>
101 @param bEnable
102 <TRUE/> to enable object modeless
103 <FALSE/> to disable it
105 @throws com::sun::star::embed::WrongStateException
106 the object is in wrong state
108 @throws com::sun::star::uno::Exception
109 in case of other problems
111 void enableModeless( [in] boolean bEnable )
112 raises( ::com::sun::star::embed::WrongStateException,
113 ::com::sun::star::uno::Exception );
115 //------------------------------------------------------------------------
116 /** provides accelerator table the container whants to use during inplace
117 editing.
119 @return
120 an accelerator table from container
122 @throws com::sun::star::embed::WrongStateException
123 the object is in unexpected state
125 void translateAccelerators(
126 [in] sequence< ::com::sun::star::awt::KeyEvent > aKeys )
127 raises( ::com::sun::star::embed::WrongStateException );
131 //============================================================================
133 }; }; }; };
135 #endif