xref: /AOO41X/main/offapi/com/sun/star/presentation/DrawPage.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_presentation_DrawPage_idl__
#define __com_sun_star_presentation_DrawPage_idl__

#ifndef __com_sun_star_drawing_DrawPage_idl__
#include <com/sun/star/drawing/DrawPage.idl>
#endif

#ifndef __com_sun_star_document_LinkTarget_idl__
#include <com/sun/star/document/LinkTarget.idl>
#endif

#ifndef __com_sun_star_presentation_FadeEffect_idl__
#include <com/sun/star/presentation/FadeEffect.idl>
#endif

#ifndef __com_sun_star_presentation_AnimationSpeed_idl__
#include <com/sun/star/presentation/AnimationSpeed.idl>
#endif


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

 module com {  module sun {  module star {  module presentation {

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

/** This is the service provided by a <type scope="com::sun::star::drawing">DrawPage</type> inside a
	<type>PresentationDocument</type>.

	@see PresentationDocument
 */
published service DrawPage
{
	service com::sun::star::drawing::DrawPage;

	/** Every page is a link target inside the document object model.
	 */
	service com::sun::star::document::LinkTarget;

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

	/** specifies how the page change is triggered.

		<p>If this is 0, the user must click to start each object animation
		and to change the page.  If set to 1, the page is
		automatically switched.  If it is set to 2, all object effects run
		automatically, but the user has to click on the page to change it.</p>
	 */
	[property] long Change;

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

	/** If the property <member scope="com::sun::star::drawing">DrawPage::Change</member> is set to 1,
		this is the time in seconds this page is shown before switching
		to the next page.
	 */
	[property] long Duration;

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

	/** This is the effect that is used to fade in this page.
	 */
	[property] com::sun::star::presentation::FadeEffect Effect;

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

	/** If this property is not ZERO, this number specifies a presentation
		layout for this page.
	 */
	[property] short Layout;

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

	/** defines the speed of the fade-in effect of this page.
	 */
	[property] com::sun::star::presentation::AnimationSpeed Speed;

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

	/** defines if a header presentation shape from the master page is visible
		on this page.
	*/

	[optional, property] boolean IsHeaderVisible;

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

	/** defines the text that is displayd in a header textfield rendered on this
		page.
	*/
	[optional, property] string HeaderText;

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

	/** defines if a footer presentation shape from the master page is visible
		on this page.
	*/

	[optional, property] boolean IsFooterVisible;

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

	/** defines the text that is displayd in a footer textfield rendered on this
		page.
	*/
	[optional, property] string FooterText;

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

	/** defines if a page number presentation shape from the master page is visible
		on this page.
	*/

	[optional, property] boolean IsPageNumberVisible;

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

	/** defines if a date and time presentation shape from the master page is visible
		on this page.
	*/

	[optional, property] boolean IsDateTimeVisible;

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

	/** defines if a date and time text field shows a fixed string value or the
		current date on this page.
	*/

	[optional, property] boolean IsDateTimeFixed;

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

	/** defines the text that is displayd in a date and time textfield rendered on this
		page. This value is only used if <code>IsDateTimeFixed</code> is <true/>.
	*/
	[optional, property] string DateTimeText;

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

	/** defines the format that is used to format a date and time text field on
		this page. This is only used if <code>IsDateTimeFixed</code> is <false/>.
	*/
	[optional, property] long DateTimeFormat;
};

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

}; }; }; };

#endif