Render text tracks
[WebKit-https.git] / Source / WebCore / html / shadow / MediaControls.h
1 /*
2  * Copyright (C) 2011 Apple Inc. All rights reserved.
3  * Copyright (C) 2011 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef MediaControls_h
28 #define MediaControls_h
29
30 #if ENABLE(VIDEO)
31
32 #include "HTMLDivElement.h"
33
34 namespace WebCore {
35
36 class MediaControllerInterface;
37
38 class MediaControls : public HTMLDivElement {
39   public:
40     virtual ~MediaControls() {}
41
42     // This function is to be implemented in your port-specific media
43     // controls implementation.
44     static PassRefPtr<MediaControls> create(Document*);
45
46     virtual void setMediaController(MediaControllerInterface*) = 0;
47
48     virtual void show() = 0;
49     virtual void hide() = 0;
50     virtual void makeOpaque() = 0;
51     virtual void makeTransparent() = 0;
52
53     virtual void reset() = 0;
54
55     virtual void playbackProgressed() = 0;
56     virtual void playbackStarted() = 0;
57     virtual void playbackStopped() = 0;
58
59     virtual void changedMute() = 0;
60     virtual void changedVolume() = 0;
61
62     virtual void enteredFullscreen() = 0;
63     virtual void exitedFullscreen() = 0;
64
65     virtual void reportedError() = 0;
66     virtual void loadedMetadata() = 0;
67     virtual void changedClosedCaptionsVisibility() = 0;
68
69     virtual void showVolumeSlider() = 0;
70     virtual void updateTimeDisplay() = 0;
71     virtual void updateStatusDisplay() = 0;
72
73     virtual bool shouldHideControls() = 0;
74
75 #if ENABLE(VIDEO_TRACK)
76     virtual void showTextTrackDisplay() = 0;
77     virtual void hideTextTrackDisplay() = 0;
78     virtual void updateTextTrackDisplay() = 0;
79 #endif
80
81 protected:
82     MediaControls(Document*);
83
84 private:
85     MediaControls();
86
87     virtual bool isMediaControls() const { return true; }
88 };
89
90 inline MediaControls* toMediaControls(Node* node)
91 {
92     ASSERT(!node || node->isMediaControls());
93     return static_cast<MediaControls*>(node);
94 }
95
96 // This will catch anyone doing an unneccessary cast.
97 void toMediaControls(const MediaControls*);
98
99 }
100
101 #endif
102
103 #endif