2010-10-14 Hayato Ito <hayato@chromium.org>
[WebKit-https.git] / WebCore / inspector / InspectorClient.h
1 /*
2  * Copyright (C) 2007 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 COMPUTER, 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 COMPUTER, 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 InspectorClient_h
27 #define InspectorClient_h
28
29 #include "InspectorController.h"
30 #include <wtf/Forward.h>
31
32 namespace WebCore {
33
34 class InspectorController;
35 class Node;
36 class Page;
37
38 class InspectorClient {
39 public:
40     virtual ~InspectorClient() {  }
41
42     virtual void inspectorDestroyed() = 0;
43
44     virtual void openInspectorFrontend(InspectorController*) = 0;
45
46     virtual void highlight(Node*) = 0;
47     virtual void hideHighlight() = 0;
48
49     virtual void populateSetting(const String& key, String* value) = 0;
50     virtual void storeSetting(const String& key, const String& value) = 0;
51
52     virtual bool sendMessageToFrontend(const String& message) = 0;
53
54     // Navigation can cause some WebKit implementations to change the view / page / inspector controller instance.
55     // However, there are some inspector controller states that should survive navigation (such as tracking resources
56     // or recording timeline). Following callbacks allow embedders to track these states.
57     virtual void updateInspectorStateCookie(const String&) { };
58 };
59
60 } // namespace WebCore
61
62 #endif // !defined(InspectorClient_h)