5e97ec9a3739c132734973387921cdbc0d955c64
[WebKit-https.git] / Source / WebCore / html / track / TextTrackCueGeneric.h
1 /*
2  * Copyright (C) 2013 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 COMPUTER, 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 COMPUTER, 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 #ifndef TextTrackCueGeneric_h
27 #define TextTrackCueGeneric_h
28
29 #if ENABLE(VIDEO_TRACK)
30
31 #include "Color.h"
32 #include "TextTrackCue.h"
33 #include <wtf/RefCounted.h>
34
35 namespace WebCore {
36
37 class GenericCueData;
38
39 // A "generic" cue is a non-WebVTT cue, so it is not positioned/sized with the WebVTT logic.
40 class TextTrackCueGeneric : public TextTrackCue {
41 public:
42     static PassRefPtr<TextTrackCueGeneric> create(ScriptExecutionContext* context, double start, double end, const String& content)
43     {
44         return adoptRef(new TextTrackCueGeneric(context, start, end, content));
45     }
46     
47     virtual ~TextTrackCueGeneric() { }
48
49     virtual PassRefPtr<TextTrackCueBox> createDisplayTree() OVERRIDE;
50
51     virtual void setLine(int, ExceptionCode&) OVERRIDE;
52     virtual void setPosition(int, ExceptionCode&) OVERRIDE;
53
54     bool useDefaultPosition() const { return m_defaultPosition; }
55     
56     double baseFontSizeRelativeToVideoHeight() const { return m_baseFontSizeRelativeToVideoHeight; }
57     void setBaseFontSizeRelativeToVideoHeight(double size) { m_baseFontSizeRelativeToVideoHeight = size; }
58
59     double fontSizeMultiplier() const { return m_fontSizeMultiplier; }
60     void setFontSizeMultiplier(double size) { m_fontSizeMultiplier = size; }
61
62     String fontName() const { return m_fontName; }
63     void setFontName(String name) { m_fontName = name; }
64
65     Color foregroundColor() const { return m_foregroundColor; }
66     void setForegroundColor(RGBA32 color) { m_foregroundColor.setRGB(color); }
67     
68     Color backgroundColor() const { return m_backgroundColor; }
69     void setBackgroundColor(RGBA32 color) { m_backgroundColor.setRGB(color); }
70
71     virtual bool operator==(const TextTrackCue&) const OVERRIDE;
72     virtual bool operator!=(const TextTrackCue& cue) const OVERRIDE
73     {
74         return !(*this == cue);
75     }
76
77     virtual TextTrackCue::CueType cueType() const OVERRIDE { return TextTrackCue::Generic; }
78
79 private:
80     TextTrackCueGeneric(ScriptExecutionContext*, double start, double end, const String&);
81     
82     Color m_foregroundColor;
83     Color m_backgroundColor;
84     double m_baseFontSizeRelativeToVideoHeight;
85     double m_fontSizeMultiplier;
86     String m_fontName;
87     bool m_defaultPosition;
88 };
89
90 } // namespace WebCore
91
92 #endif
93 #endif