1/*
2 * Copyright (C) 2008 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 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 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 WebNetscapePluginEventHandler_h
27#define WebNetscapePluginEventHandler_h
28
29#import "WebNetscapePluginView.h"
30
31#if ENABLE(NETSCAPE_PLUGIN_API)
32
33@class NSEvent;
34@class WebNetscapePluginView;
35
36struct CGRect;
37
38class WebNetscapePluginEventHandler {
39public:
40    static WebNetscapePluginEventHandler* create(WebNetscapePluginView*);
41    virtual ~WebNetscapePluginEventHandler() { }
42
43    virtual void drawRect(CGContextRef, const NSRect&) = 0;
44
45    virtual void mouseDown(NSEvent*) = 0;
46    virtual void mouseDragged(NSEvent*) = 0;
47    virtual void mouseEntered(NSEvent*) = 0;
48    virtual void mouseExited(NSEvent*) = 0;
49    virtual void mouseMoved(NSEvent*) = 0;
50    virtual void mouseUp(NSEvent*) = 0;
51    virtual bool scrollWheel(NSEvent*) = 0;
52
53    virtual void keyDown(NSEvent*) = 0;
54    virtual void keyUp(NSEvent*) = 0;
55    virtual void flagsChanged(NSEvent*) = 0;
56    virtual void syntheticKeyDownWithCommandModifier(int keyCode, char character) = 0;
57
58    virtual void focusChanged(bool hasFocus) = 0;
59    virtual void windowFocusChanged(bool hasFocus) = 0;
60
61    virtual void startTimers(bool throttleTimers) { }
62    virtual void stopTimers() { }
63
64    // Returns the platform specific window used in NPP_SetWindow
65    virtual void* platformWindow(NSWindow*) = 0;
66
67    bool currentEventIsUserGesture() const { return m_currentEventIsUserGesture; }
68protected:
69    WebNetscapePluginEventHandler(WebNetscapePluginView* pluginView)
70        : m_pluginView(pluginView)
71        , m_currentEventIsUserGesture(false)
72    {
73    }
74
75    WebNetscapePluginView* m_pluginView;
76    bool m_currentEventIsUserGesture;
77};
78
79#endif // ENABLE(NETSCAPE_PLUGIN_API)
80
81#endif // WebNetscapePluginEventHandler_h
82
83
84