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 <wtf/RetainPtr.h>
  37 #elif PLATFORM(QT)
  38 #include <QMenu>
  39 #endif
  40
  41 namespace WebCore {
  42 class MenuEventProxy;
  43
  44     class ContextMenuController;
  45
  46     class ContextMenu : Noncopyable
  47     {
  48     public:
  49         ContextMenu(const HitTestResult&);
  50         ContextMenu(const HitTestResult&, const PlatformMenuDescription);
  51         ~ContextMenu();
  52
  53         void populate();
  54         void addInspectElementItem();
  55         void checkOrEnableIfNeeded(ContextMenuItem&) const;
  56
  57         void insertItem(unsigned position, ContextMenuItem&);
  58         void appendItem(ContextMenuItem&);
  59
  60         ContextMenuItem* itemWithAction(unsigned);
  61         ContextMenuItem* itemAtIndex(unsigned, const PlatformMenuDescription);
  62
  63         unsigned itemCount() const;
  64
  65         HitTestResult hitTestResult() const { return m_hitTestResult; }
  66         ContextMenuController* controller() const;
  67
  68         PlatformMenuDescription platformDescription() const;
  69         void setPlatformDescription(PlatformMenuDescription);
  70
  71         PlatformMenuDescription releasePlatformDescription();
  72
  73     private:
  74         HitTestResult m_hitTestResult;
  75
  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 #else
  82         PlatformMenuDescription m_platformDescription;
  83 #endif
  84     };
  85
  86 }
  87
  88 #endif // ContextMenu_h