Home | History | Annotate | Download | only in web
      1 /*
      2  * Copyright (C) 2013 Google 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 are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef WebUserGestureToken_h
     32 #define WebUserGestureToken_h
     33 
     34 #include "../platform/WebPrivatePtr.h"
     35 
     36 namespace WebCore {
     37 class UserGestureToken;
     38 }
     39 
     40 namespace WebKit {
     41 
     42 // A WebUserGestureToken allows for storing the user gesture state of the
     43 // currently active context and reinstantiating it later on to continue
     44 // processing the user gesture in case it was not consumed meanwhile.
     45 class WebUserGestureToken {
     46 public:
     47     WebUserGestureToken() { }
     48     WebUserGestureToken(const WebUserGestureToken& other) { assign(other); }
     49     WebUserGestureToken& operator=(const WebUserGestureToken& other)
     50     {
     51         assign(other);
     52         return *this;
     53     }
     54     ~WebUserGestureToken() { reset(); }
     55 
     56     WEBKIT_EXPORT bool hasGestures() const;
     57     WEBKIT_EXPORT void setOutOfProcess();
     58     WEBKIT_EXPORT void setJavascriptPrompt();
     59     bool isNull() const { return m_token.isNull(); }
     60 
     61 #if WEBKIT_IMPLEMENTATION
     62     explicit WebUserGestureToken(PassRefPtr<WebCore::UserGestureToken>);
     63     operator PassRefPtr<WebCore::UserGestureToken>() const;
     64 #endif
     65 
     66 private:
     67     WEBKIT_EXPORT void assign(const WebUserGestureToken&);
     68     WEBKIT_EXPORT void reset();
     69 
     70     WebPrivatePtr<WebCore::UserGestureToken> m_token;
     71 };
     72 
     73 } // namespace WebKit
     74 
     75 #endif // WebUserGestureToken_h
     76