src/third_party/WebKit/Source/core/inspector/InspectorClient.h

   1 /*
   2  * Copyright (C) 2007 Apple Inc.  All rights reserved.
   3  * Copyright (C) 2011 Google Inc.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef InspectorClient_h
  28 #define InspectorClient_h
  29
  30 #include "core/inspector/InspectorStateClient.h"
  31 #include "core/page/ContextMenuProvider.h"
  32 #include "wtf/Forward.h"
  33 #include "wtf/PassRefPtr.h"
  34
  35 namespace blink {
  36
  37 class PlatformKeyboardEvent;
  38 class PlatformMouseEvent;
  39
  40 class InspectorClient : public InspectorStateClient {
  41 public:
  42     virtual void highlight() = 0;
  43     virtual void hideHighlight() = 0;
  44
  45     virtual void clearBrowserCache() { }
  46     virtual void clearBrowserCookies() { }
  47
  48     typedef void (*TraceEventCallback)(char phase, const unsigned char*, const char* name, unsigned long long id,
  49         int numArgs, const char* const* argNames, const unsigned char* argTypes, const unsigned long long* argValues,
  50         unsigned char flags, double timestamp);
  51     virtual void setTraceEventCallback(const String& categoryFilter, TraceEventCallback) { }
  52     virtual void resetTraceEventCallback() { }
  53     virtual void enableTracing(const String& categoryFilter) { }
  54     virtual void disableTracing() { }
  55
  56     virtual void startGPUEventsRecording() { }
  57     virtual void stopGPUEventsRecording() { }
  58
  59     virtual void setDeviceMetricsOverride(int /*width*/, int /*height*/, float /*deviceScaleFactor*/, bool /*mobile*/, bool /*fitWindow*/, float /* scale */, float /* offsetX */, float /* offsetY */) { }
  60     virtual void clearDeviceMetricsOverride() { }
  61     virtual void setTouchEventEmulationEnabled(bool) { }
  62
  63     virtual bool overridesShowPaintRects() { return false; }
  64     virtual void setShowPaintRects(bool) { }
  65     virtual void setShowDebugBorders(bool) { }
  66     virtual void setShowFPSCounter(bool) { }
  67     virtual void setContinuousPaintingEnabled(bool) { }
  68     virtual void setShowScrollBottleneckRects(bool) { }
  69
  70     virtual void resetScrollAndPageScaleFactor() { }
  71     virtual float minimumPageScaleFactor() { return 1; }
  72     virtual float maximumPageScaleFactor() { return 1; }
  73     virtual void setPageScaleFactor(float) { }
  74     virtual void showContextMenu(float x, float y, PassRefPtrWillBeRawPtr<ContextMenuProvider>) { }
  75
  76     virtual void dispatchKeyEvent(const PlatformKeyboardEvent&) { }
  77     virtual void dispatchMouseEvent(const PlatformMouseEvent&) { }
  78
  79     virtual void resumeStartup() { }
  80
  81 protected:
  82     virtual ~InspectorClient() { }
  83 };
  84
  85 } // namespace blink
  86
  87 #endif // !defined(InspectorClient_h)