third_party/WebKit/Source/platform/ContextMenuItem.h

   1 /*
   2  * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
   3  * Copyright (C) 2010 Igalia S.L
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef ContextMenuItem_h
  28 #define ContextMenuItem_h
  29
  30 #include "platform/PlatformExport.h"
  31 #include "wtf/OwnPtr.h"
  32 #include "wtf/text/WTFString.h"
  33
  34 namespace blink {
  35
  36 class ContextMenu;
  37
  38 enum ContextMenuAction {
  39     ContextMenuItemBaseCustomTag = 5000,
  40     ContextMenuItemCustomTagNoAction = 5998,
  41     ContextMenuItemLastCustomTag = 5999
  42 };
  43
  44 enum ContextMenuItemType {
  45     ActionType,
  46     CheckableActionType,
  47     SeparatorType,
  48     SubmenuType
  49 };
  50
  51 class PLATFORM_EXPORT ContextMenuItem {
  52     WTF_MAKE_FAST_ALLOCATED(ContextMenuItem);
  53 public:
  54     ContextMenuItem(ContextMenuItemType, ContextMenuAction, const String& title, const String& icon, ContextMenu* subMenu = 0);
  55     ContextMenuItem(ContextMenuItemType, ContextMenuAction, const String& title, const String& icon, bool enabled, bool checked);
  56
  57     ~ContextMenuItem();
  58
  59     void setType(ContextMenuItemType);
  60     ContextMenuItemType type() const;
  61
  62     void setAction(ContextMenuAction);
  63     ContextMenuAction action() const;
  64
  65     void setChecked(bool = true);
  66     bool checked() const;
  67
  68     void setEnabled(bool = true);
  69     bool enabled() const;
  70
  71     void setSubMenu(ContextMenu*);
  72
  73     ContextMenuItem(ContextMenuAction, const String&, bool enabled, bool checked, const Vector<ContextMenuItem>& subMenuItems);
  74
  75     void setTitle(const String& title) { m_title = title; }
  76     const String& title() const { return m_title; }
  77
  78     void setIcon(const String& icon) { m_icon = icon; }
  79     const String& icon() const { return m_icon; }
  80
  81     const Vector<ContextMenuItem>& subMenuItems() const { return m_subMenuItems; }
  82
  83 private:
  84     ContextMenuItemType m_type;
  85     ContextMenuAction m_action;
  86     String m_title;
  87     String m_icon;
  88     bool m_enabled;
  89     bool m_checked;
  90     Vector<ContextMenuItem> m_subMenuItems;
  91 };
  92
  93 }
  94
  95 #endif // ContextMenuItem_h