offapi/com/sun/star/presentation/EffectCommands.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: EffectCommands.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_presentation_EffectCommands_idl__
  31 #define __com_sun_star_presentation_EffectCommands_idl__
  32
  33 //=============================================================================
  34
  35  module com {  module sun {  module star {  module presentation {
  36
  37 //=============================================================================
  38
  39 /**
  40     @see ::com::sun::star::animations::XCommand
  41 */
  42 constants EffectCommands
  43 {
  44     /** the command is user defined
  45     */
  46     const short CUSTOM = 0;
  47
  48     /** the command is an ole verb.
  49         Required parameters are
  50             "Verb" of type long that specifies the verb to execute.
  51     */
  52     const short VERB = 1;
  53
  54     /** the command starts playing on a media object.
  55         Optional parameters are
  56             "MediaTime" of type double that specifies the start
  57             time in mili seconds. If not given, play continues at
  58             last position known.
  59     */
  60     const short PLAY = 2;
  61
  62     /** the command toggles the pause status on a media object.
  63     */
  64     const short TOGGLEPAUSE = 3;
  65
  66     /** the command stops the animation on a media object
  67     */
  68     const short STOP = 4;
  69
  70     /** the command stops all currently running sound effects.
  71     */
  72     const short STOPAUDIO = 5;
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 #endif