2949e078dca0086601285823dfd44d29d32655ba
[WebKit-https.git] / Source / WebCore / animation / WebAnimation.idl
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 enum AnimationPlayState {
27     "idle",
28     "running",
29     "paused",
30     "finished"
31 };
32
33 enum AnimationReplaceState {
34     "active",
35     "removed",
36     "persisted"
37 };
38
39 [
40     ActiveDOMObject,
41     EnabledAtRuntime=WebAnimations,
42     InterfaceName=Animation,
43     CustomConstructor(),
44     CustomToJSObject
45 ] interface WebAnimation : EventTarget {
46     attribute DOMString id;
47     attribute AnimationEffect? effect;
48     attribute AnimationTimeline? timeline;
49     attribute double? startTime;
50     [MayThrowException, ImplementedAs=bindingsCurrentTime] attribute double? currentTime;
51     attribute double playbackRate;
52     [ImplementedAs=bindingsPlayState] readonly attribute AnimationPlayState playState;
53     [ImplementedAs=bindingsReplaceState] readonly attribute AnimationReplaceState replaceState;
54     [ImplementedAs=bindingsPending] readonly attribute boolean pending;
55     attribute EventHandler onfinish;
56     attribute EventHandler oncancel;
57     attribute EventHandler onremove;
58     [ImplementedAs=bindingsReady] readonly attribute Promise<WebAnimation> ready;
59     [ImplementedAs=bindingsFinished] readonly attribute Promise<WebAnimation> finished;
60     void cancel();
61     [MayThrowException] void finish();
62     [MayThrowException, ImplementedAs=bindingsPlay] void play();
63     [MayThrowException, ImplementedAs=bindingsPause] void pause();
64     void updatePlaybackRate(double playbackRate);
65     [MayThrowException] void reverse();
66     void persist();
67     [MayThrowException] void commitStyles();
68 };