summaryrefslogtreecommitdiffstats
path: root/webkit/api/public/WebContextMenuData.h
blob: 24a26b18f7ce1acf7106e63f59fd8a776b64935e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
/*
 * Copyright (C) 2009 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef WebContextMenuData_h
#define WebContextMenuData_h

#include "WebPoint.h"
#include "WebString.h"
#include "WebURL.h"

namespace WebKit {

    // This struct is passed to WebViewClient::ShowContextMenu.
    struct WebContextMenuData {
        enum MediaType {
            // No special node is in context.
            MediaTypeNone,
            // An image node is selected.
            MediaTypeImage,
            // A video node is selected.
            MediaTypeVideo,
            // An audio node is selected.
            MediaTypeAudio,
        };
        // The type of media the context menu is being invoked on.
        MediaType mediaType;

        // The x and y position of the mouse pointer (relative to the webview).
        WebPoint mousePosition;

        // The absolute URL of the link that is in context.
        WebURL linkURL;

        // The absolute URL of the image/video/audio that is in context.
        WebURL srcURL;

        // The absolute URL of the page in context.
        WebURL pageURL;

        // The absolute URL of the subframe in context.
        WebURL frameURL;

        // The encoding for the frame in context.
        WebString frameEncoding;

        enum MediaFlags {
            MediaNone = 0x0,
            MediaInError = 0x1,
            MediaPaused = 0x2,
            MediaMuted = 0x4,
            MediaLoop = 0x8,
            MediaCanSave = 0x10,
            MediaHasAudio = 0x20,
        };

        // Extra attributes describing media elements.
        int mediaFlags;

        // The raw text of the selection in context.
        WebString selectedText;

        // Whether spell checking is enabled.
        bool isSpellCheckingEnabled;

        // The editable (possibily) misspelled word.
        WebString misspelledWord;

        // Whether context is editable.
        bool isEditable;

        enum EditFlags {
            CanDoNone = 0x0,
            CanUndo = 0x1,
            CanRedo = 0x2,
            CanCut = 0x4,
            CanCopy = 0x8,
            CanPaste = 0x10,
            CanDelete = 0x20,
            CanSelectAll = 0x40,
        };

        // Which edit operations are available in the context.
        int editFlags;

        // Security information for the context.
        WebCString securityInfo;
    };

} // namespace WebKit

#endif