1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_embed_XInplaceObject_idl__
24#define __com_sun_star_embed_XInplaceObject_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_awt_Rectangle_idl__
31#include <com/sun/star/awt/Rectangle.idl>
32#endif
33
34#ifndef __com_sun_star_awt_KeyEvent_idl__
35#include <com/sun/star/awt/KeyEvent.idl>
36#endif
37
38#ifndef __com_sun_star_embed_WrongStateException_idl__
39#include <com/sun/star/embed/WrongStateException.idl>
40#endif
41
42
43
44//============================================================================
45
46 module com {  module sun {  module star {  module embed {
47
48//============================================================================
49/** represents common functionality for inplace embedded objects.
50 */
51published interface XInplaceObject: com::sun::star::uno::XInterface
52{
53	//------------------------------------------------------------------------
54    /** sets the visible part of the inplace object.
55
56		<p>
57		Both rectangles are provided in object's parent window coordinates
58		in pixels. The intersection of rectangles specifies the visible part
59		of the object. In case the position window has a size that is
60		different from object's visual area size, the object should either
61		scale or deactivate.
62		</p>
63
64		<p>
65		The method must activate object repainting.
66		</p>
67
68        @param aPosRect
69			specifies a new position rectangle
70
71		@param aClipRect
72			specifies a new clip rectangle
73
74        @throws com::sun::star::embed::WrongStateException
75			the object is in invalid state
76
77        @throws com::sun::star::uno::Exception
78			in case of other problems
79	 */
80	void setObjectRectangles( [in] ::com::sun::star::awt::Rectangle aPosRect,
81						 [in] ::com::sun::star::awt::Rectangle aClipRect )
82		raises( ::com::sun::star::embed::WrongStateException,
83		        ::com::sun::star::uno::Exception );
84
85	//------------------------------------------------------------------------
86    /** enables or disables modeless dialogs of the object.
87
88		<p>
89		In case contaner whants to show a modal dialog it should disable
90		modeless of embedded object dialogs with this call. Later the same
91		call can be used to enable it.
92		</p>
93
94		@param bEnable
95			<TRUE/> to enable object modeless
96			<FALSE/> to disable it
97
98        @throws com::sun::star::embed::WrongStateException
99			the object is in wrong state
100
101        @throws com::sun::star::uno::Exception
102			in case of other problems
103	 */
104	void enableModeless( [in] boolean bEnable )
105		raises( ::com::sun::star::embed::WrongStateException,
106		        ::com::sun::star::uno::Exception );
107
108	//------------------------------------------------------------------------
109    /** provides accelerator table the container whants to use during inplace
110		editing.
111
112		@return
113			an accelerator table from container
114
115        @throws com::sun::star::embed::WrongStateException
116		    the object is in unexpected state
117	 */
118	void translateAccelerators(
119			[in] sequence< ::com::sun::star::awt::KeyEvent > aKeys )
120		raises( ::com::sun::star::embed::WrongStateException );
121
122};
123
124//============================================================================
125
126}; }; }; };
127
128#endif
129
130