src/third_party/WebKit/Source/core/html/track/vtt/VTTElement.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 #include "core/html/HTMLElement.h"
  27
  28 namespace blink {
  29
  30 enum VTTNodeType {
  31     VTTNodeTypeNone = 0,
  32     VTTNodeTypeClass,
  33     VTTNodeTypeItalic,
  34     VTTNodeTypeLanguage,
  35     VTTNodeTypeBold,
  36     VTTNodeTypeUnderline,
  37     VTTNodeTypeRuby,
  38     VTTNodeTypeRubyText,
  39     VTTNodeTypeVoice
  40 };
  41
  42 class VTTElement FINAL : public Element {
  43 public:
  44     static PassRefPtrWillBeRawPtr<VTTElement> create(const VTTNodeType, Document*);
  45     static PassRefPtrWillBeRawPtr<VTTElement> create(const QualifiedName&, Document*);
  46     PassRefPtrWillBeRawPtr<HTMLElement> createEquivalentHTMLElement(Document&);
  47
  48     virtual PassRefPtrWillBeRawPtr<Element> cloneElementWithoutAttributesAndChildren() OVERRIDE;
  49
  50     void setVTTNodeType(VTTNodeType type) { m_webVTTNodeType = static_cast<unsigned>(type); }
  51     VTTNodeType webVTTNodeType() const { return static_cast<VTTNodeType>(m_webVTTNodeType); }
  52
  53     bool isPastNode() const { return m_isPastNode; }
  54     void setIsPastNode(bool value) { m_isPastNode = value; }
  55
  56     virtual bool isVTTElement() const OVERRIDE { return true; }
  57     AtomicString language() const { return m_language; }
  58     void setLanguage(AtomicString value) { m_language = value; }
  59
  60     static const QualifiedName& voiceAttributeName()
  61     {
  62         DEFINE_STATIC_LOCAL(QualifiedName, voiceAttr, (nullAtom, "voice", nullAtom));
  63         return voiceAttr;
  64     }
  65
  66     static const QualifiedName& langAttributeName()
  67     {
  68         DEFINE_STATIC_LOCAL(QualifiedName, voiceAttr, (nullAtom, "lang", nullAtom));
  69         return voiceAttr;
  70     }
  71
  72 private:
  73     VTTElement(const QualifiedName&, Document*);
  74     VTTElement(VTTNodeType, Document*);
  75
  76     unsigned m_isPastNode : 1;
  77     unsigned m_webVTTNodeType : 4;
  78
  79     AtomicString m_language;
  80 };
  81
  82 DEFINE_ELEMENT_TYPE_CASTS(VTTElement, isVTTElement());
  83
  84 } // namespace blink
  85