Source/WebKit2/Shared/WebContextMenuItem.h

   1 /*
   2  * Copyright (C) 2010 Apple 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 INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef WebContextMenuItem_h
  27 #define WebContextMenuItem_h
  28
  29 #if ENABLE(CONTEXT_MENUS)
  30
  31 #include "APIObject.h"
  32 #include "WebContextMenuItemData.h"
  33
  34 namespace WebKit {
  35
  36 class ImmutableArray;
  37
  38 class WebContextMenuItem : public APIObject {
  39 public:
  40     static const Type APIType = TypeContextMenuItem;
  41
  42     static PassRefPtr<WebContextMenuItem> create(const WebContextMenuItemData& data)
  43     {
  44         return adoptRef(new WebContextMenuItem(data));
  45     }
  46     static PassRefPtr<WebContextMenuItem> create(const String& title, bool enabled, ImmutableArray* submenuItems);
  47     static WebContextMenuItem* separatorItem();
  48
  49     PassRefPtr<ImmutableArray> submenuItemsAsImmutableArray() const;
  50
  51     APIObject* userData() const;
  52     void setUserData(APIObject*);
  53
  54     WebContextMenuItemData* data() { return &m_webContextMenuItemData; }
  55
  56 private:
  57     WebContextMenuItem(const WebContextMenuItemData&);
  58
  59     virtual Type type() const { return APIType; }
  60
  61     WebContextMenuItemData m_webContextMenuItemData;
  62 };
  63
  64 } // namespace WebKit
  65
  66 #endif // ENABLE(CONTEXT_MENUS)
  67 #endif // WebContextMenuItem_h