xref: /aoo42x/main/offapi/com/sun/star/presentation/EffectCommands.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_presentation_EffectCommands_idl__
#define __com_sun_star_presentation_EffectCommands_idl__

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

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

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

/**
	@see ::com::sun::star::animations::XCommand
*/
constants EffectCommands
{
	/** the command is user defined
	*/
	const short CUSTOM = 0;

	/** the command is an ole verb.
		Required parameters are
			"Verb" of type long that specifies the verb to execute.
	*/
	const short VERB = 1;

	/** the command starts playing on a media object.
		Optional parameters are
			"MediaTime" of type double that specifies the start
			time in mili seconds. If not given, play continues at
			last position known.
	*/
	const short PLAY = 2;

	/** the command toggles the pause status on a media object.
	*/
	const short TOGGLEPAUSE = 3;

	/** the command stops the animation on a media object
	*/
	const short STOP = 4;

	/** the command stops all currently running sound effects.
	*/
	const short STOPAUDIO = 5;
};

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

}; }; }; };

#endif