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

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