Source/WebKit2/UIProcess/WebVibrationProxy.h

   1 /*
   2  * Copyright (C) 2012 Intel Corporation. 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 INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef WebVibrationProxy_h
  27 #define WebVibrationProxy_h
  28
  29 #if ENABLE(VIBRATION)
  30
  31 #include "APIObject.h"
  32 #include "MessageID.h"
  33 #include "WebVibrationProvider.h"
  34 #include <wtf/Forward.h>
  35
  36 namespace CoreIPC {
  37 class ArgumentDecoder;
  38 class Connection;
  39 }
  40
  41 namespace WebKit {
  42
  43 class WebContext;
  44
  45 class WebVibrationProxy : public APIObject {
  46 public:
  47     static const Type APIType = TypeVibration;
  48
  49     static PassRefPtr<WebVibrationProxy> create(WebContext*);
  50     virtual ~WebVibrationProxy();
  51
  52     void invalidate();
  53     void clearContext() { m_context = 0; }
  54
  55     void initializeProvider(const WKVibrationProvider*);
  56
  57     void didReceiveMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*);
  58
  59 private:
  60     explicit WebVibrationProxy(WebContext*);
  61
  62     virtual Type type() const { return APIType; }
  63
  64     // Implemented in generated WebVibrationProxyMessageReceiver.cpp
  65     void didReceiveWebVibrationProxyMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*);
  66
  67     void vibrate(uint64_t vibrationTime);
  68     void cancelVibration();
  69
  70     WebContext* m_context;
  71     WebVibrationProvider m_provider;
  72 };
  73
  74 } // namespace WebKit
  75
  76 #endif // ENABLE(VIBRATION)
  77
  78 #endif // WebVibrationProxy_h