xref: /aoo42x/main/offapi/com/sun/star/animations/AnimationRestart.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_animations_AnimationRestart_idl__
#define __com_sun_star_animations_AnimationRestart_idl__

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

 module com {  module sun {  module star {  module animations {

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

/** defines the restart behaviour

	@see <member>XTiming::Restart</member>
	@see <member>XTiming::RestartDefault</member>
	@see http://www.w3.org/TR/smil20/smil-timing.html#adef-restart
*/
constants AnimationRestart
{
    /** The restart behavior for the element is determined by the value of the <member>XTiming::RestartDefault</member> attribute.
	    This is the default value for the <member>XTiming::Restart</member> attribute.
	*/
	const short DEFAULT = 0;

	/**  Specifies that the value of this attribute (and of the restart behavior) are
		 inherited from the <member>XTiming::RestartDefault</member> value of the parent element.
		 If there is no parent element, the value is <const>AnimationRestart::ALWAYS</const>.
		 This is the default value for the <member>XTiming::RestartDefault</member> attribute.
	*/
	const short INHERIT = 0;

	/** The element can be restarted at any time.
	*/
	const short ALWAYS = 1;

	/** The element can only be restarted when it is not active (i.e. it can be restarted after the active end).
		Attempts to restart the element during its active duration are ignored.
	*/
	const short WHEN_NOT_ACTIVE = 2;

	/** The element cannot be restarted for the remainder of the current simple
		duration of the parent time container.
	*/
	const short NEVER = 3;
};

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

}; }; }; };

#endif