Source/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 "PlatformMenuDescription.h"
  33 #include "PlatformString.h"
  34 #if PLATFORM(MAC)
  35 #include <wtf/RetainPtr.h>
  36 #elif PLATFORM(QT)
  37 #include <QMenu>
  38 #elif PLATFORM(WIN)
  39 #include <windows.h>
  40 #endif
  41
  42 #if ENABLE(TIZEN_CONTEXT_MENU)
  43 #include "HitTestResult.h"
  44 #endif
  45
  46 namespace WebCore {
  47
  48     class ContextMenuController;
  49 #if ENABLE(TIZEN_CONTEXT_MENU)
  50     class ContextMenuClientEfl;
  51     class ContextMenuClient;
  52 #endif
  53
  54     class ContextMenu {
  55         WTF_MAKE_NONCOPYABLE(ContextMenu); WTF_MAKE_FAST_ALLOCATED;
  56     public:
  57         ContextMenu();
  58
  59         ContextMenuItem* itemWithAction(unsigned);
  60
  61 #if USE(CROSS_PLATFORM_CONTEXT_MENUS)
  62 #if PLATFORM(WIN)
  63         typedef HMENU NativeMenu;
  64 #elif PLATFORM(EFL)
  65         typedef void* NativeMenu;
  66 #endif
  67         explicit ContextMenu(NativeMenu);
  68
  69         NativeMenu nativeMenu() const;
  70
  71         static NativeMenu createNativeMenuFromItems(const Vector<ContextMenuItem>&);
  72         static void getContextMenuItems(NativeMenu, Vector<ContextMenuItem>&);
  73
  74         // FIXME: When more platforms switch over, this should return const ContextMenuItem*'s.
  75         ContextMenuItem* itemAtIndex(unsigned index) { return &m_items[index]; }
  76
  77         void setItems(const Vector<ContextMenuItem>& items) { m_items = items; }
  78         const Vector<ContextMenuItem>& items() const { return m_items; }
  79
  80         void appendItem(const ContextMenuItem& item) { m_items.append(item); }
  81 #else
  82         ContextMenu(const PlatformMenuDescription);
  83         ~ContextMenu();
  84
  85         void insertItem(unsigned position, ContextMenuItem&);
  86         void appendItem(ContextMenuItem&);
  87
  88         ContextMenuItem* itemAtIndex(unsigned, const PlatformMenuDescription);
  89
  90         unsigned itemCount() const;
  91
  92         PlatformMenuDescription platformDescription() const;
  93         void setPlatformDescription(PlatformMenuDescription);
  94
  95         PlatformMenuDescription releasePlatformDescription();
  96 #if ENABLE(TIZEN_CONTEXT_MENU)
  97         ContextMenu(const HitTestResult&);
  98         ContextMenu(const HitTestResult&, const PlatformMenuDescription);
  99
 100         ContextMenuController* controller() const;
 101         HitTestResult hitTestResult() const { return m_hitTestResult; }
 102 #endif
 103 #if PLATFORM(WX)
 104         static ContextMenuItem* itemWithId(int);
 105 #endif
 106
 107 #endif // USE(CROSS_PLATFORM_CONTEXT_MENUS)
 108
 109     private:
 110 #if ENABLE(TIZEN_CONTEXT_MENU)
 111        HitTestResult m_hitTestResult;
 112        ContextMenuClient* m_contextMenuClient;
 113 #endif
 114
 115 #if USE(CROSS_PLATFORM_CONTEXT_MENUS)
 116         Vector<ContextMenuItem> m_items;
 117 #else
 118 #if PLATFORM(MAC)
 119         // Keep this in sync with the PlatformMenuDescription typedef
 120         RetainPtr<NSMutableArray> m_platformDescription;
 121 #elif PLATFORM(QT)
 122         QList<ContextMenuItem> m_items;
 123 #elif PLATFORM(CHROMIUM)
 124         Vector<ContextMenuItem> m_items;
 125 #elif ENABLE(TIZEN_CONTEXT_MENU_WEBKIT_2)
 126         Vector<ContextMenuItem> m_items;
 127 #else
 128         PlatformMenuDescription m_platformDescription;
 129 #if OS(WINCE)
 130         unsigned m_itemCount;
 131 #endif
 132 #endif
 133
 134 #endif // USE(CROSS_PLATFORM_CONTEXT_MENUS)
 135     };
 136
 137 #if !USE(CROSS_PLATFORM_CONTEXT_MENUS)
 138 Vector<ContextMenuItem> contextMenuItemVector(PlatformMenuDescription);
 139 PlatformMenuDescription platformMenuDescription(Vector<ContextMenuItem>&);
 140 #endif
 141
 142 }
 143
 144 #endif // ContextMenu_h