xref: /aoo41x/main/offapi/com/sun/star/embed/XInplaceObject.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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 whants 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 whants 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