Source/WebCore/plugins/PluginViewBase.h

   1 /*
   2  * Copyright (C) 2010 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. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  */
  24
  25 #ifndef PluginWidget_h
  26 #define PluginWidget_h
  27
  28 #include "PlatformLayer.h"
  29 #include "ScrollTypes.h"
  30 #include "Widget.h"
  31 #include <wtf/text/WTFString.h>
  32
  33 namespace JSC {
  34     class ExecState;
  35     class JSGlobalObject;
  36     class JSObject;
  37 }
  38
  39 namespace WebCore {
  40
  41 class Scrollbar;
  42
  43 // PluginViewBase is a widget that all plug-in views inherit from, both in Webkit and WebKit2.
  44 // It's intended as a stopgap measure until we can merge all plug-in views into a single plug-in view.
  45 class PluginViewBase : public Widget {
  46 public:
  47 #if USE(ACCELERATED_COMPOSITING)
  48     virtual PlatformLayer* platformLayer() const { return 0; }
  49 #endif
  50
  51     virtual JSC::JSObject* scriptObject(JSC::JSGlobalObject*) { return 0; }
  52     virtual void storageBlockingStateChanged() { }
  53     virtual void privateBrowsingStateChanged(bool) { }
  54     virtual bool getFormValue(String&) { return false; }
  55     virtual bool scroll(ScrollDirection, ScrollGranularity) { return false; }
  56
  57     // A plug-in can ask WebKit to handle scrollbars for it.
  58     virtual Scrollbar* horizontalScrollbar() { return 0; }
  59     virtual Scrollbar* verticalScrollbar() { return 0; }
  60
  61     // FIXME: This is a hack that works around the fact that the WebKit2 PluginView isn't a ScrollableArea.
  62     virtual bool wantsWheelEvents() { return false; }
  63     virtual bool supportsKeyboardFocus() const { return false; }
  64     virtual bool canProcessDrag() const { return false; }
  65
  66     virtual bool shouldAlwaysAutoStart() const { return false; }
  67
  68     virtual bool shouldAllowNavigationFromDrags() const { return false; }
  69
  70     virtual bool isPluginViewBase() const { return true; }
  71
  72 protected:
  73     explicit PluginViewBase(PlatformWidget widget = 0) : Widget(widget) { }
  74 };
  75
  76 inline PluginViewBase* toPluginViewBase(Widget* widget)
  77 {
  78     ASSERT(!widget || widget->isPluginViewBase());
  79     return static_cast<PluginViewBase*>(widget);
  80 }
  81
  82 inline const PluginViewBase* toPluginViewBase(const Widget* widget)
  83 {
  84     ASSERT(!widget || widget->isPluginViewBase());
  85     return static_cast<const PluginViewBase*>(widget);
  86 }
  87
  88 // This will catch anyone doing an unnecessary cast.
  89 void toPluginViewBase(const PluginViewBase*);
  90
  91 } // namespace WebCore
  92
  93 #endif // PluginWidget_h