src/third_party/WebKit/Source/modules/speech/SpeechSynthesisUtterance.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 SpeechSynthesisUtterance_h
  27 #define SpeechSynthesisUtterance_h
  28
  29 #include "core/dom/ContextLifecycleObserver.h"
  30 #include "modules/EventTargetModules.h"
  31 #include "modules/speech/SpeechSynthesisVoice.h"
  32 #include "platform/heap/Handle.h"
  33 #include "platform/speech/PlatformSpeechSynthesisUtterance.h"
  34
  35 namespace blink {
  36
  37 class SpeechSynthesisUtterance FINAL : public RefCountedGarbageCollectedWillBeGarbageCollectedFinalized<SpeechSynthesisUtterance>, public PlatformSpeechSynthesisUtteranceClient, public ContextLifecycleObserver, public EventTargetWithInlineData {
  38     DEFINE_EVENT_TARGET_REFCOUNTING_WILL_BE_REMOVED(RefCountedGarbageCollected<SpeechSynthesisUtterance>);
  39     USING_GARBAGE_COLLECTED_MIXIN(SpeechSynthesisUtterance);
  40 public:
  41     static SpeechSynthesisUtterance* create(ExecutionContext*, const String&);
  42
  43     virtual ~SpeechSynthesisUtterance();
  44
  45     const String& text() const { return m_platformUtterance->text(); }
  46     void setText(const String& text) { m_platformUtterance->setText(text); }
  47
  48     const String& lang() const { return m_platformUtterance->lang(); }
  49     void setLang(const String& lang) { m_platformUtterance->setLang(lang); }
  50
  51     SpeechSynthesisVoice* voice() const;
  52     void setVoice(SpeechSynthesisVoice*);
  53
  54     float volume() const { return m_platformUtterance->volume(); }
  55     void setVolume(float volume) { m_platformUtterance->setVolume(volume); }
  56
  57     float rate() const { return m_platformUtterance->rate(); }
  58     void setRate(float rate) { m_platformUtterance->setRate(rate); }
  59
  60     float pitch() const { return m_platformUtterance->pitch(); }
  61     void setPitch(float pitch) { m_platformUtterance->setPitch(pitch); }
  62
  63     double startTime() const { return m_platformUtterance->startTime(); }
  64     void setStartTime(double startTime) { m_platformUtterance->setStartTime(startTime); }
  65
  66     DEFINE_ATTRIBUTE_EVENT_LISTENER(start);
  67     DEFINE_ATTRIBUTE_EVENT_LISTENER(end);
  68     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
  69     DEFINE_ATTRIBUTE_EVENT_LISTENER(pause);
  70     DEFINE_ATTRIBUTE_EVENT_LISTENER(resume);
  71     DEFINE_ATTRIBUTE_EVENT_LISTENER(mark);
  72     DEFINE_ATTRIBUTE_EVENT_LISTENER(boundary);
  73
  74     virtual ExecutionContext* executionContext() const OVERRIDE;
  75
  76     PlatformSpeechSynthesisUtterance* platformUtterance() const { return m_platformUtterance; }
  77
  78     virtual void trace(Visitor*) OVERRIDE;
  79
  80 private:
  81     SpeechSynthesisUtterance(ExecutionContext*, const String&);
  82
  83     // EventTarget
  84     virtual const AtomicString& interfaceName() const OVERRIDE;
  85
  86     Member<PlatformSpeechSynthesisUtterance> m_platformUtterance;
  87     Member<SpeechSynthesisVoice> m_voice;
  88 };
  89
  90 } // namespace blink
  91
  92 #endif // SpeechSynthesisUtterance_h