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''
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23 * THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef WebPageGroup_h
27#define WebPageGroup_h
28
29#include "APIObject.h"
30#include "WebPageGroupData.h"
31#include <wtf/Forward.h>
32#include <wtf/HashSet.h>
33
34namespace WebKit {
35
36class WebPreferences;
37class WebPageProxy;
38
39class WebPageGroup : public APIObject {
40public:
41    static const Type APIType = TypePageGroup;
42
43    static PassRefPtr<WebPageGroup> create(const String& identifier = String(), bool visibleToInjectedBundle = true, bool visibleToHistoryClient = true);
44    static WebPageGroup* get(uint64_t pageGroupID);
45
46    virtual ~WebPageGroup();
47
48    void addPage(WebPageProxy*);
49    void removePage(WebPageProxy*);
50
51    const String& identifier() const { return m_data.identifer; }
52    uint64_t pageGroupID() const { return m_data.pageGroupID; }
53
54    const WebPageGroupData& data() { return m_data; }
55
56    void setPreferences(WebPreferences*);
57    WebPreferences* preferences() const;
58    void preferencesDidChange();
59
60private:
61    WebPageGroup(const String& identifier, bool visibleToInjectedBundle, bool visibleToHistoryClient);
62
63    virtual Type type() const { return APIType; }
64
65    WebPageGroupData m_data;
66    mutable RefPtr<WebPreferences> m_preferences;
67    HashSet<WebPageProxy*> m_pages;
68};
69
70} // namespace WebKit
71
72#endif // WebPageGroup_h
73