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
  21 module com { module sun { module star { module awt {
  22
  23
  24 /** allows administrating a set of images, to be displayed as animated seres.
  25
  26     <p>Components implementing this interface maintain a variable number of image sets. Components displaying
  27     those images will choose the best-fitting image set depending on the available space, and possibly other
  28     restrictions.</p>
  29
  30     @since OOo 3.4
  31  */
  32 interface XAnimatedImages
  33 {
  34     /** specifies the time in milliseconds between two animation steps.
  35
  36         <p>This is the minimum time, the actual value might be longer due to
  37         system load. The default value will be 100 ms.</p>
  38     */
  39     [attribute] long    StepTime;
  40
  41     /** specifies whether the animation should start over with the first image of the image series when the last image
  42         has been played.
  43
  44         <p>The default value for this attribute is `TRUE`.</p>
  45     */
  46     [attribute] boolean AutoRepeat;
  47
  48     /** controls the way the images are scaled up or down, when the available space is larger or smaller
  49         than what is needed for them.
  50
  51         <p>Allowed values are those from the ImageScaleMode constants group.</p>
  52     */
  53     [attribute] short ScaleMode
  54     {
  55         set raises (::com::sun::star::lang::IllegalArgumentException);
  56     };
  57
  58     /** returns the number of images sets maintained by the component.
  59     */
  60     long
  61         getImageSetCount();
  62
  63     /** returns the URLs of the image set with the given index
  64
  65         @param iIndex
  66             the index of the set those image URLs are to be retrieved. Must be greater than or equal to <code>0</code>,
  67             and smaller than the value returned by getImageSetCount().
  68
  69         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  70             if the <code>iIndex</code> is not a valid index.
  71     */
  72     sequence< string >
  73         getImageSet
  74         (
  75             [in] long iIndex
  76         )
  77         raises
  78         (
  79             ::com::sun::star::lang::IndexOutOfBoundsException
  80         );
  81
  82     /** sets the URLs of the image set with the given index
  83
  84         @param iIndex
  85             the index at which a new image set should be inserted. Must be greater than or equal to <code>0</code>,
  86             and smaller than or equal to the value returned by getImageSetCount().
  87         @param iImageURLs
  88             the URLs for the images for the given set. Will be resolved using a com::sun::star::graphic::GraphicProvider.
  89
  90         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  91             if the <code>iIndex</code> is not a valid index.
  92     */
  93     void
  94         insertImageSet
  95         (
  96             [in] long iIndex,
  97             [in] sequence< string > iImageURLs
  98         )
  99         raises
 100         (
 101             ::com::sun::star::lang::IndexOutOfBoundsException
 102         );
 103
 104     /** replaces the image set given by index with a new one
 105
 106         @param iIndex
 107             the index of the set those image URLs are to be replaced. Must be greater than or equal to <code>0</code>,
 108             and smaller than the value returned by getImageSetCount().
 109
 110         @param iImageURLs
 111             the URLs for the images for the given set. Will be resolved using a com::sun::star::graphic::GraphicProvider.
 112
 113         @throws ::com::sun::star::lang::IndexOutOfBoundsException
 114             if the <code>iIndex</code> is not a valid index.
 115     */
 116     void
 117         replaceImageSet
 118         (
 119             [in] long iIndex,
 120             [in] sequence< string > iImageURLs
 121         )
 122         raises
 123         (
 124             ::com::sun::star::lang::IndexOutOfBoundsException
 125         );
 126
 127
 128     /** removes the image set with the given index
 129
 130         @param iIndex
 131             the index of the set to remove. Must be greater than or equal to <code>0</code>,
 132             and smaller than the value returned by getImageSetCount().
 133
 134         @throws ::com::sun::star::lang::IndexOutOfBoundsException
 135             if the <code>iIndex</code> is not a valid index.
 136     */
 137     void
 138         removeImageSet
 139         (
 140             [in] long iIndex
 141         )
 142         raises
 143         (
 144             ::com::sun::star::lang::IndexOutOfBoundsException
 145         );
 146
 147
 148     /** allows other components to observer the insertion, removal, and replacement of image sets
 149     */
 150     interface ::com::sun::star::container::XContainer;
 151 };
 152
 153
 154 }; }; }; };
 155
 156
 157 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */