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