Reviewed by Ada.
[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 "PlatformString.h"
34
35 #if PLATFORM(MAC)
36 #ifdef __OBJC__
37 @class NSMutableArray;
38 #else
39 class NSMutableArray;
40 #endif
41 #elif PLATFORM(WIN)
42 typedef struct HMENU__* HMENU;
43 #elif PLATFORM(QT)
44 class QMenu;
45 #endif
46
47 namespace WebCore {
48
49     class ContextMenuController;
50
51 #if PLATFORM(MAC)
52     typedef NSMutableArray* PlatformMenuDescription;
53 #elif PLATFORM(WIN)
54     typedef HMENU PlatformMenuDescription;
55 #elif PLATFORM(QT)
56     typedef QMenu* PlatformMenuDescription;
57 #endif
58
59     class ContextMenu : Noncopyable
60     {
61     public:
62         ContextMenu(const HitTestResult&);
63         ~ContextMenu();
64
65         void populate();
66
67         void show();
68         void hide();
69
70         void insertItem(unsigned position, const ContextMenuItem&);
71         void appendItem(const ContextMenuItem&);
72         
73         ContextMenuItem at(unsigned index);
74
75         unsigned itemCount() const;
76
77         HitTestResult hitTestResult() const { return m_hitTestResult; }
78         ContextMenuController* controller() const;
79
80         PlatformMenuDescription platformDescription() const { return m_platformDescription; }
81         void setPlatformDescription(PlatformMenuDescription);
82
83     private:
84         HitTestResult m_hitTestResult;
85         PlatformMenuDescription m_platformDescription;
86     };
87
88 }
89
90 #endif // ContextMenu_h