1/*
2 * Copyright (C) 2006 Apple Computer, 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 ContextMenu_h
27#define ContextMenu_h
28
29#include <wtf/Noncopyable.h>
30
31#include "ContextMenuItem.h"
32#include "HitTestResult.h"
33#include "PlatformMenuDescription.h"
34#include "PlatformString.h"
35#if PLATFORM(MAC)
36#include <wtf/RetainPtr.h>
37#elif PLATFORM(QT)
38#include <QMenu>
39#endif
40
41namespace WebCore {
42
43    class ContextMenuController;
44
45    class ContextMenu : public Noncopyable
46    {
47    public:
48        ContextMenu(const HitTestResult&);
49        ContextMenu(const HitTestResult&, const PlatformMenuDescription);
50        ~ContextMenu();
51
52        void populate();
53        void addInspectElementItem();
54        void checkOrEnableIfNeeded(ContextMenuItem&) const;
55
56        void insertItem(unsigned position, ContextMenuItem&);
57        void appendItem(ContextMenuItem&);
58
59        ContextMenuItem* itemWithAction(unsigned);
60        ContextMenuItem* itemAtIndex(unsigned, const PlatformMenuDescription);
61
62        unsigned itemCount() const;
63
64        HitTestResult hitTestResult() const { return m_hitTestResult; }
65        ContextMenuController* controller() const;
66
67        PlatformMenuDescription platformDescription() const;
68        void setPlatformDescription(PlatformMenuDescription);
69
70        PlatformMenuDescription releasePlatformDescription();
71#if PLATFORM(WX)
72        static ContextMenuItem* itemWithId(int);
73#endif
74    private:
75        HitTestResult m_hitTestResult;
76#if PLATFORM(MAC)
77        // Keep this in sync with the PlatformMenuDescription typedef
78        RetainPtr<NSMutableArray> m_platformDescription;
79#elif PLATFORM(QT)
80        QList<ContextMenuItem> m_items;
81#elif PLATFORM(CHROMIUM)
82        Vector<ContextMenuItem> m_items;
83#else
84        PlatformMenuDescription m_platformDescription;
85#endif
86    };
87
88}
89
90#endif // ContextMenu_h
91