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