src/third_party/WebKit/Source/modules/vibration/NavigatorVibration.h

   1 /*
   2  *  Copyright (C) 2012 Samsung Electronics
   3  *
   4  *  This library is free software; you can redistribute it and/or
   5  *  modify it under the terms of the GNU Library General Public
   6  *  License as published by the Free Software Foundation; either
   7  *  version 2 of the License, or (at your option) any later version.
   8  *
   9  *  This library is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  *  Library General Public License for more details.
  13  *
  14  *  You should have received a copy of the GNU Library General Public License
  15  *  along with this library; see the file COPYING.LIB.  If not, write to
  16  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  *  Boston, MA 02110-1301, USA.
  18  */
  19
  20 #ifndef NavigatorVibration_h
  21 #define NavigatorVibration_h
  22
  23 #include "core/page/Page.h"
  24 #include "core/page/PageLifecycleObserver.h"
  25 #include "platform/Timer.h"
  26 #include "wtf/PassOwnPtr.h"
  27 #include "wtf/Vector.h"
  28
  29 namespace blink {
  30
  31 class LocalFrame;
  32 class Navigator;
  33
  34 class NavigatorVibration FINAL
  35     : public NoBaseWillBeGarbageCollectedFinalized<NavigatorVibration>
  36     , public WillBeHeapSupplement<Page>
  37     , public PageLifecycleObserver {
  38     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(NavigatorVibration);
  39 public:
  40     typedef Vector<unsigned> VibrationPattern;
  41
  42     virtual ~NavigatorVibration();
  43
  44     bool vibrate(const VibrationPattern&);
  45     void cancelVibration();
  46     void timerStartFired(Timer<NavigatorVibration>*);
  47     void timerStopFired(Timer<NavigatorVibration>*);
  48
  49     // Inherited from PageLifecycleObserver
  50     virtual void pageVisibilityChanged() OVERRIDE;
  51     virtual void didCommitLoad(LocalFrame*) OVERRIDE;
  52
  53     static bool vibrate(Navigator&, unsigned time);
  54     static bool vibrate(Navigator&, const VibrationPattern&);
  55     static NavigatorVibration& from(Page&);
  56
  57     bool isVibrating() const { return m_isVibrating; }
  58
  59     VibrationPattern pattern() const { return m_pattern; }
  60
  61     virtual void trace(Visitor* visitor) OVERRIDE { WillBeHeapSupplement<Page>::trace(visitor); }
  62
  63 private:
  64     explicit NavigatorVibration(Page&);
  65     static const char* supplementName();
  66
  67     Timer<NavigatorVibration> m_timerStart;
  68     Timer<NavigatorVibration> m_timerStop;
  69     bool m_isVibrating;
  70     VibrationPattern m_pattern;
  71 };
  72
  73 } // namespace blink
  74
  75 #endif // NavigatorVibration_h