Source/WebKit/chromium/public/WebContextMenuData.h

   1 /*
   2  * Copyright (C) 2009 Google 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 are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebContextMenuData_h
  32 #define WebContextMenuData_h
  33
  34 #include "WebHistoryItem.h"
  35 #include "WebMenuItemInfo.h"
  36 #include "WebNode.h"
  37 #include "platform/WebPoint.h"
  38 #include "platform/WebString.h"
  39 #include "platform/WebURL.h"
  40 #include "platform/WebVector.h"
  41
  42 #define WEBCONTEXT_MEDIATYPEFILE_DEFINED
  43
  44 namespace WebKit {
  45
  46 // This struct is passed to WebViewClient::ShowContextMenu.
  47 struct WebContextMenuData {
  48     enum MediaType {
  49         // No special node is in context.
  50         MediaTypeNone,
  51         // An image node is selected.
  52         MediaTypeImage,
  53         // A video node is selected.
  54         MediaTypeVideo,
  55         // An audio node is selected.
  56         MediaTypeAudio,
  57         // A file node is selected.
  58         MediaTypeFile,
  59         // A plugin node is selected.
  60         MediaTypePlugin,
  61     };
  62     // The type of media the context menu is being invoked on.
  63     MediaType mediaType;
  64
  65     // The x and y position of the mouse pointer (relative to the webview).
  66     WebPoint mousePosition;
  67
  68     // The absolute URL of the link that is in context.
  69     WebURL linkURL;
  70
  71     // The absolute URL of the image/video/audio that is in context.
  72     WebURL srcURL;
  73
  74     // Whether the image in context has been blocked.
  75     bool isImageBlocked;
  76
  77     // The absolute URL of the page in context.
  78     WebURL pageURL;
  79
  80     // The absolute keyword search URL including the %s search tag when the
  81     // "Add as search engine..." option is clicked (left empty if not used).
  82     WebURL keywordURL;
  83
  84     // The absolute URL of the subframe in context.
  85     WebURL frameURL;
  86
  87     // The encoding for the frame in context.
  88     WebString frameEncoding;
  89
  90     // History state of the subframe in context.
  91     WebHistoryItem frameHistoryItem;
  92
  93     enum MediaFlags {
  94         MediaNone = 0x0,
  95         MediaInError = 0x1,
  96         MediaPaused = 0x2,
  97         MediaMuted = 0x4,
  98         MediaLoop = 0x8,
  99         MediaCanSave = 0x10,
 100         MediaHasAudio = 0x20,
 101         MediaHasVideo = 0x40,
 102         MediaControlRootElement = 0x80,
 103         MediaCanPrint = 0x100,
 104     };
 105
 106     // Extra attributes describing media elements.
 107     int mediaFlags;
 108
 109     // The raw text of the selection in context.
 110     WebString selectedText;
 111
 112     // Whether speech input is enabled.
 113     bool isSpeechInputEnabled;
 114
 115     // Whether spell checking is enabled.
 116     bool isSpellCheckingEnabled;
 117
 118     // The editable (possibily) misspelled word.
 119     WebString misspelledWord;
 120
 121     // If misspelledWord is not empty, holds suggestions from the dictionary.
 122     WebVector<WebString> dictionarySuggestions;
 123
 124     // Whether context is editable.
 125     bool isEditable;
 126
 127     enum CheckableMenuItemFlags {
 128         CheckableMenuItemDisabled = 0x0,
 129         CheckableMenuItemEnabled = 0x1,
 130         CheckableMenuItemChecked = 0x2,
 131     };
 132
 133     // Writing direction menu items - values are unions of
 134     // CheckableMenuItemFlags.
 135     // Currently only used on OS X.
 136     int writingDirectionDefault;
 137     int writingDirectionLeftToRight;
 138     int writingDirectionRightToLeft;
 139
 140     enum EditFlags {
 141         CanDoNone = 0x0,
 142         CanUndo = 0x1,
 143         CanRedo = 0x2,
 144         CanCut = 0x4,
 145         CanCopy = 0x8,
 146         CanPaste = 0x10,
 147         CanDelete = 0x20,
 148         CanSelectAll = 0x40,
 149         CanTranslate = 0x80,
 150     };
 151
 152     // Which edit operations are available in the context.
 153     int editFlags;
 154
 155     // Security information for the context.
 156     WebCString securityInfo;
 157
 158     // Custom context menu items provided by the WebCore internals.
 159     WebVector<WebMenuItemInfo> customItems;
 160
 161     // The node that was clicked.
 162     WebNode node;
 163
 164     WebContextMenuData()
 165         : mediaType(MediaTypeNone)
 166         , isImageBlocked(false)
 167         , mediaFlags(MediaNone)
 168         , isSpeechInputEnabled(false)
 169         , isSpellCheckingEnabled(false)
 170         , isEditable(false)
 171         , writingDirectionDefault(CheckableMenuItemDisabled)
 172         , writingDirectionLeftToRight(CheckableMenuItemEnabled)
 173         , writingDirectionRightToLeft(CheckableMenuItemEnabled)
 174         , editFlags(0) { }
 175 };
 176
 177 } // namespace WebKit
 178
 179 #endif