WebCore:
[WebKit-https.git] / WebCore / platform / ContextMenu.h
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 "RetainPtr.h"
37 #endif
38
39 namespace WebCore {
40
41     class ContextMenuController;
42
43     class ContextMenu : Noncopyable
44     {
45     public:
46         ContextMenu(const HitTestResult&);
47         ContextMenu(const HitTestResult&, const PlatformMenuDescription);
48         ~ContextMenu();
49
50         void populate();
51
52         void show();
53         void hide();
54
55         void insertItem(unsigned position, const ContextMenuItem&);
56         void appendItem(const ContextMenuItem&);
57         
58         ContextMenuItem at(unsigned index);
59
60         unsigned itemCount() const;
61
62         HitTestResult hitTestResult() const { return m_hitTestResult; }
63         ContextMenuController* controller() const;
64
65         PlatformMenuDescription platformDescription() const;
66         void setPlatformDescription(PlatformMenuDescription);
67
68     private:
69         HitTestResult m_hitTestResult;
70         
71 #if PLATFORM(MAC)
72         // Keep this in sync with the PlatformMenuDescription typedef
73         RetainPtr<NSMutableArray> m_platformDescription;
74 #else
75         PlatformMenuDescription m_platformDescription;
76 #endif
77     };
78
79 }
80
81 #endif // ContextMenu_h