offapi/com/sun/star/awt/XAnimatedImages.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_awt_XAnimatedImages_idl__
  21 #define __com_sun_star_awt_XAnimatedImages_idl__
  22
  23 #include <com/sun/star/container/XContainerListener.idl>
  24 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  25 #include <com/sun/star/container/XContainer.idl>
  26 #include <com/sun/star/lang/IllegalArgumentException.idl>
  27
  28
  29 module com { module sun { module star { module awt {
  30
  31
  32 /** allows administrating a set of images, to be displayed as animated seres.
  33
  34     <p>Components implementing this interface maintain a variable number of image sets. Components displaying
  35     those images will choose the best-fitting image set depending on the available space, and possibly other
  36     restrictions.</p>
  37
  38     @since OOo 3.4
  39  */
  40 interface XAnimatedImages
  41 {
  42     /** specifies the time in milliseconds between two animation steps.
  43
  44         <p>This is the minimum time, the actual value might be longer due to
  45         system load. The default value will be 100 ms.</p>
  46     */
  47     [attribute] long    StepTime;
  48
  49     /** specifies whether the animation should start over with the first image of the image series when the last image
  50         has been played.
  51
  52         <p>The default value for this attribute is `TRUE`.</p>
  53     */
  54     [attribute] boolean AutoRepeat;
  55
  56     /** controls the way the images are scaled up or down, when the available space is larger or smaller
  57         than what is needed for them.
  58
  59         <p>Allowed values are those from the ImageScaleMode constants group.</p>
  60     */
  61     [attribute] short ScaleMode
  62     {
  63         set raises (::com::sun::star::lang::IllegalArgumentException);
  64     };
  65
  66     /** returns the number of images sets maintained by the component.
  67     */
  68     long
  69         getImageSetCount();
  70
  71     /** returns the URLs of the image set with the given index
  72
  73         @param iIndex
  74             the index of the set those image URLs are to be retrieved. Must be greater than or equal to <code>0</code>,
  75             and smaller than the value returned by getImageSetCount().
  76
  77         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  78             if the <code>iIndex</code> is not a valid index.
  79     */
  80     sequence< string >
  81         getImageSet
  82         (
  83             [in] long iIndex
  84         )
  85         raises
  86         (
  87             ::com::sun::star::lang::IndexOutOfBoundsException
  88         );
  89
  90     /** sets the URLs of the image set with the given index
  91
  92         @param iIndex
  93             the index at which a new image set should be inserted. Must be greater than or equal to <code>0</code>,
  94             and smaller than or equal to the value returned by getImageSetCount().
  95         @param iImageURLs
  96             the URLs for the images for the given set. Will be resolved using a com::sun::star::graphic::GraphicProvider.
  97
  98         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  99             if the <code>iIndex</code> is not a valid index.
 100     */
 101     void
 102         insertImageSet
 103         (
 104             [in] long iIndex,
 105             [in] sequence< string > iImageURLs
 106         )
 107         raises
 108         (
 109             ::com::sun::star::lang::IndexOutOfBoundsException
 110         );
 111
 112     /** replaces the image set given by index with a new one
 113
 114         @param iIndex
 115             the index of the set those image URLs are to be replaced. Must be greater than or equal to <code>0</code>,
 116             and smaller than the value returned by getImageSetCount().
 117
 118         @param iImageURLs
 119             the URLs for the images for the given set. Will be resolved using a com::sun::star::graphic::GraphicProvider.
 120
 121         @throws ::com::sun::star::lang::IndexOutOfBoundsException
 122             if the <code>iIndex</code> is not a valid index.
 123     */
 124     void
 125         replaceImageSet
 126         (
 127             [in] long iIndex,
 128             [in] sequence< string > iImageURLs
 129         )
 130         raises
 131         (
 132             ::com::sun::star::lang::IndexOutOfBoundsException
 133         );
 134
 135
 136     /** removes the image set with the given index
 137
 138         @param iIndex
 139             the index of the set to remove. Must be greater than or equal to <code>0</code>,
 140             and smaller than the value returned by getImageSetCount().
 141
 142         @throws ::com::sun::star::lang::IndexOutOfBoundsException
 143             if the <code>iIndex</code> is not a valid index.
 144     */
 145     void
 146         removeImageSet
 147         (
 148             [in] long iIndex
 149         )
 150         raises
 151         (
 152             ::com::sun::star::lang::IndexOutOfBoundsException
 153         );
 154
 155
 156     /** allows other components to observer the insertion, removal, and replacement of image sets
 157     */
 158     interface ::com::sun::star::container::XContainer;
 159 };
 160
 161
 162 }; }; }; };
 163
 164
 165 #endif
 166
 167 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */