Rename ExceptionCode-based exception handling to "legacy"
[WebKit-https.git] / Source / WebCore / html / track / TextTrack.idl
1 /*
2  * Copyright (C) 2011 Google 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 TextTrackMode { "disabled", "hidden", "showing" };
27 enum TextTrackKind { "subtitles", "captions", "descriptions", "chapters", "metadata", "forced" };
28
29 [
30     Conditional=VIDEO_TRACK,
31     GenerateIsReachable=ImplElementRoot,
32     JSCustomMarkFunction,
33     SkipVTableValidation,
34 ] interface TextTrack : EventTarget {
35     readonly attribute DOMString id;
36     [ImplementedAs=kindForBindings] attribute TextTrackKind kind;
37     readonly attribute DOMString label;
38     [CustomSetter] attribute DOMString language;
39     readonly attribute DOMString inBandMetadataTrackDispatchType;
40
41     attribute TextTrackMode mode;
42
43     readonly attribute TextTrackCueList? cues;
44     readonly attribute TextTrackCueList? activeCues;
45
46     // FIXME: cue parameter should not be nullable in addCue and removeCue.
47     [MayThrowLegacyException] void addCue(TextTrackCue? cue);
48     [MayThrowLegacyException] void removeCue(TextTrackCue? cue);
49
50     attribute EventHandler oncuechange;
51
52     readonly attribute VTTRegionList regions;
53     // FIXME: region parameter should not be nullable in addRegion and removeRegion.
54     void addRegion(VTTRegion? region);
55     [MayThrowLegacyException] void removeRegion(VTTRegion? region);
56 };