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