xref: /trunk/main/offapi/com/sun/star/graphic/GraphicRendererVCL.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_graphic_GraphicRendererVCL_idl
#define com_sun_star_graphic_GraphicRendererVCL_idl

#include <com/sun/star/beans/XPropertySet.idl>
#include <com/sun/star/graphic/XGraphicRenderer.idl>
#include <com/sun/star/awt/Rectangle.idl>

module com { module sun { module star { module graphic
{

/** Service that describes the necessary interfaces and properties
	to render a graphic container of <type>XGraphic</type> type

	<p>To render a <type>XGraphic</type> container, just create an
	instance of this service, set the appropriate properties and use
	the	<type>XGraphicRenderer</type> interface to initiate the rendering
	process itself</p>
 */
service GraphicRendererVCL
{
	/** Interface to initiate the rendering process
	*/
	interface ::com::sun::star::graphic::XGraphicRenderer;

    /** The property interface by which the properties of all
        supported services are exchanged
    */
    interface ::com::sun::star::beans::XPropertySet;

	/** Holds the device onto which the <type>XGraphic</type>
		container should be rendered

		<p>In case of using VCL Devices, this property should
		hold a <type scope="com::sun::star::awt">XDevice</type>
		interface</p>
	*/
	[property] any Device;

	/** Specifies the destination rectangle, into which the graphic
	content is to be rendered onto the device
	*/
	[property] ::com::sun::star::awt::Rectangle DestinationRect;


	/** Additional properties for rendering, unspecified at the moment
	*/
	[optional, property] any RenderData;
};

} ; } ; } ; } ;

#endif