xref: /trunk/main/offapi/com/sun/star/embed/XInplaceObject.idl (revision a893be29)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_embed_XInplaceObject_idl__
#define __com_sun_star_embed_XInplaceObject_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_awt_Rectangle_idl__
#include <com/sun/star/awt/Rectangle.idl>
#endif

#ifndef __com_sun_star_awt_KeyEvent_idl__
#include <com/sun/star/awt/KeyEvent.idl>
#endif

#ifndef __com_sun_star_embed_WrongStateException_idl__
#include <com/sun/star/embed/WrongStateException.idl>
#endif



//============================================================================

 module com {  module sun {  module star {  module embed {

//============================================================================
/** represents common functionality for inplace embedded objects.
 */
published interface XInplaceObject: com::sun::star::uno::XInterface
{
	//------------------------------------------------------------------------
    /** sets the visible part of the inplace object.

		<p>
		Both rectangles are provided in object's parent window coordinates
		in pixels. The intersection of rectangles specifies the visible part
		of the object. In case the position window has a size that is
		different from object's visual area size, the object should either
		scale or deactivate.
		</p>

		<p>
		The method must activate object repainting.
		</p>

        @param aPosRect
			specifies a new position rectangle

		@param aClipRect
			specifies a new clip rectangle

        @throws com::sun::star::embed::WrongStateException
			the object is in invalid state

        @throws com::sun::star::uno::Exception
			in case of other problems
	 */
	void setObjectRectangles( [in] ::com::sun::star::awt::Rectangle aPosRect,
						 [in] ::com::sun::star::awt::Rectangle aClipRect )
		raises( ::com::sun::star::embed::WrongStateException,
		        ::com::sun::star::uno::Exception );

	//------------------------------------------------------------------------
    /** enables or disables modeless dialogs of the object.

		<p>
		In case contaner wants to show a modal dialog it should disable
		modeless of embedded object dialogs with this call. Later the same
		call can be used to enable it.
		</p>

		@param bEnable
			<TRUE/> to enable object modeless
			<FALSE/> to disable it

        @throws com::sun::star::embed::WrongStateException
			the object is in wrong state

        @throws com::sun::star::uno::Exception
			in case of other problems
	 */
	void enableModeless( [in] boolean bEnable )
		raises( ::com::sun::star::embed::WrongStateException,
		        ::com::sun::star::uno::Exception );

	//------------------------------------------------------------------------
    /** provides accelerator table the container wants to use during inplace
		editing.

		@return
			an accelerator table from container

        @throws com::sun::star::embed::WrongStateException
		    the object is in unexpected state
	 */
	void translateAccelerators(
			[in] sequence< ::com::sun::star::awt::KeyEvent > aKeys )
		raises( ::com::sun::star::embed::WrongStateException );

};

//============================================================================

}; }; }; };

#endif