offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.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: UnoControlSimpleAnimationModel.idl,v $
  10  * $Revision: 1.3 $
  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_awt_UnoControlSimpleAnimationModel_idl__
  31 #define __com_sun_star_awt_UnoControlSimpleAnimationModel_idl__
  32
  33 #ifndef __com_sun_star_awt_UnoControlModel_idl__
  34 #include <com/sun/star/awt/UnoControlModel.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module awt {
  41
  42 //=============================================================================
  43
  44 /** specifies the standard model of an <type>UnoControlSimpleAnimation</type>.
  45
  46     <p>The simple animation control displays a sequence of images.</p>
  47
  48     <p> </p>
  49
  50     @see UnoControlScrollBarModel
  51  */
  52
  53 service UnoControlSimpleAnimationModel
  54 {
  55     service com::sun::star::awt::UnoControlModel;
  56
  57     //-------------------------------------------------------------------------
  58
  59     /** specifies the time in milliseconds between two animation steps.
  60
  61         <pre>This is the minimum time, the actual value might be longer due to
  62         system load. The default value will be 100 ms.</pre>
  63      */
  64     [property] long StepTime;
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** specifies whether the animation will restart again after displaying the last
  69         image.
  70
  71         <p>The default is FALSE.</p>
  72      */
  73     [property] boolean AutoRepeat;
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif