xref: /trunk/main/offapi/com/sun/star/sheet/SpreadsheetDrawPage.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_sheet_SpreadsheetDrawPage_idl__
#define __com_sun_star_sheet_SpreadsheetDrawPage_idl__

#ifndef __com_sun_star_drawing_XDrawPage_idl__
#include <com/sun/star/drawing/XDrawPage.idl>
#endif

#ifndef __com_sun_star_drawing_XShapeGrouper_idl__
#include <com/sun/star/drawing/XShapeGrouper.idl>
#endif

#ifndef __com_sun_star_lang_XServiceInfo_idl__
#include <com/sun/star/lang/XServiceInfo.idl>
#endif

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

 module com {  module sun {  module star {  module sheet {

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

/** This abstract service is implemented by every page of a
	<type>SpreadsheetDocument</type>.

	@example create and insert a couple of <type scope="com::sun::star::drawing">LineShape</type>s:

	<listing>
	xPage = xDoc.DrawPages(0)
	for x% = 0 to 200
    xShape = xProv.createInstance( "com.sun.star.drawing.LineShape" )
	xShape.LineColor = rgb( 255, 0, n%+20 )
	xShape.LineWidth = 20
	xShape.Position = Point( x%, 2*x% )
	xShape.Size = Size( 300-x%, 20 )
	xPage.add( xShape )
	next x%
	</listing>

    @since OOo 1.1.2
 */
published service SpreadsheetDrawPage
{


	/** manages the <type scope="com::sun::star::drawing">Shape</type>s of this page.

				<p>It also lets you add new <type scope="com::sun::star::drawing">Shape</type>s. The program currently
				requires that these <type scope="com::sun::star::drawing">Shape</type>s be created by the factory of
				the	document.

				@see SpreadsheetDocument
	 */
	interface com::sun::star::drawing::XDrawPage;


	/** With this interface you can group/ungroup a collection of
				<type scope="com::sun::star::drawing">Shape</type>s.
	 */
	interface com::sun::star::drawing::XShapeGrouper;


	/** returns the services implemented by this instance.
	 */
	interface com::sun::star::lang::XServiceInfo;
};

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

}; }; }; };

#endif