xref: /AOO41X/main/offapi/com/sun/star/awt/XView.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * 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_awt_XView_idl__
#define __com_sun_star_awt_XView_idl__

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

#ifndef __com_sun_star_awt_XGraphics_idl__
#include <com/sun/star/awt/XGraphics.idl>
#endif

#ifndef __com_sun_star_awt_Size_idl__
#include <com/sun/star/awt/Size.idl>
#endif


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

 module com {  module sun {  module star {  module awt {

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

/** makes it possible to attach an oputput device to the object.

	<p>This kind of object is called view-object.</p>
 */
published interface XView: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** sets the output device.
	 */
	boolean setGraphics( [in] com::sun::star::awt::XGraphics aDevice );

	//-------------------------------------------------------------------------

	/** returns the output device which was set using the method
		<member>XView::setGraphics</member>.
	 */
	com::sun::star::awt::XGraphics getGraphics();

	//-------------------------------------------------------------------------

	/** returns the size of the object in device units.

        <p>A device must be set before.</p>
	 */
	com::sun::star::awt::Size getSize();

	//-------------------------------------------------------------------------

	/** draws the object at the specified position.

		<p>If the output should be clipped, the caller has to set the
		clipping region.</p>
	 */
	[oneway] void draw( [in] long nX,
			 [in] long nY );

	//-------------------------------------------------------------------------

	/** sets the zoom factor.

		<p>The zoom factor only affects the content of the view, not the size.</p>
	 */
	[oneway] void setZoom( [in] float fZoomX,
			 [in] float fZoomY );

};

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

}; }; }; };

#endif