WebKitContextMenu.html 39.6 KB
Newer Older
1 2 3 4
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Alberto Garcia's avatar
Alberto Garcia committed
5
<title>WebKitContextMenu: WebKitGTK Reference Manual</title>
Alberto Garcia's avatar
Alberto Garcia committed
6
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Alberto Garcia's avatar
Alberto Garcia committed
7
<link rel="home" href="index.html" title="WebKitGTK Reference Manual">
8
<link rel="up" href="ch01.html" title="Class Overview">
9
<link rel="prev" href="webkit2gtk-4.0-WebKitVersion.html" title="WebKitVersion">
10
<link rel="next" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem">
Alberto Garcia's avatar
Alberto Garcia committed
11
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
12 13 14
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16
<td width="100%" align="left" class="shortcuts">
17 18
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#WebKitContextMenu.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19
                  <a href="#WebKitContextMenu.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
20 21 22
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23
<td><a accesskey="p" href="webkit2gtk-4.0-WebKitVersion.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24 25
<td><a accesskey="n" href="WebKitContextMenuItem.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
26 27 28 29 30
<div class="refentry">
<a name="WebKitContextMenu"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="WebKitContextMenu.top_of_page"></a>WebKitContextMenu</span></h2>
Alberto Garcia's avatar
Alberto Garcia committed
31
<p>WebKitContextMenu — Represents the context menu in a <a class="link" href="WebKitWebView.html" title="The main frame document title of this #WebKitWebView. If the title has not been received yet, it will be %NULL."><span class="type">WebKitWebView</span></a></p>
32
</td>
33
<td class="gallery_image" valign="top" align="right"></td>
34
</tr></table></div>
35 36
<div class="refsect1">
<a name="WebKitContextMenu.functions"></a><h2>Functions</h2>
37
<div class="informaltable"><table class="informaltable" width="100%" border="0">
38
<colgroup>
Alberto Garcia's avatar
Alberto Garcia committed
39 40
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
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 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="returnvalue">WebKitContextMenu</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-new" title="webkit_context_menu_new ()">webkit_context_menu_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="returnvalue">WebKitContextMenu</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-new-with-items" title="webkit_context_menu_new_with_items ()">webkit_context_menu_new_with_items</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-prepend" title="webkit_context_menu_prepend ()">webkit_context_menu_prepend</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-append" title="webkit_context_menu_append ()">webkit_context_menu_append</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-insert" title="webkit_context_menu_insert ()">webkit_context_menu_insert</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-move-item" title="webkit_context_menu_move_item ()">webkit_context_menu_move_item</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-get-items" title="webkit_context_menu_get_items ()">webkit_context_menu_get_items</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-get-n-items" title="webkit_context_menu_get_n_items ()">webkit_context_menu_get_n_items</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="returnvalue">WebKitContextMenuItem</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-first" title="webkit_context_menu_first ()">webkit_context_menu_first</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="returnvalue">WebKitContextMenuItem</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-last" title="webkit_context_menu_last ()">webkit_context_menu_last</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="returnvalue">WebKitContextMenuItem</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-get-item-at-position" title="webkit_context_menu_get_item_at_position ()">webkit_context_menu_get_item_at_position</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-remove" title="webkit_context_menu_remove ()">webkit_context_menu_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-remove-all" title="webkit_context_menu_remove_all ()">webkit_context_menu_remove_all</a> <span class="c_punctuation">()</span>
</td>
</tr>
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-set-user-data" title="webkit_context_menu_set_user_data ()">webkit_context_menu_set_user_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-get-user-data" title="webkit_context_menu_get_user_data ()">webkit_context_menu_get_user_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
163 164 165 166 167
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="WebKitContextMenu.other"></a><h2>Types and Values</h2>
168
<div class="informaltable"><table class="informaltable" width="100%" border="0">
169
<colgroup>
Alberto Garcia's avatar
Alberto Garcia committed
170 171
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
172 173 174 175 176 177
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="WebKitContextMenu.html#WebKitContextMenu-struct" title="WebKitContextMenu">WebKitContextMenu</a></td>
</tr></tbody>
</table></div>
178 179 180
</div>
<div class="refsect1">
<a name="WebKitContextMenu.object-hierarchy"></a><h2>Object Hierarchy</h2>
181
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
182
    <span class="lineart">╰──</span> WebKitContextMenu
183 184 185 186
</pre>
</div>
<div class="refsect1">
<a name="WebKitContextMenu.description"></a><h2>Description</h2>
Alberto Garcia's avatar
Alberto Garcia committed
187
<p><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> represents a context menu containing
Alberto Garcia's avatar
Alberto Garcia committed
188 189
<a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a>s in a <a class="link" href="WebKitWebView.html" title="The main frame document title of this #WebKitWebView. If the title has not been received yet, it will be %NULL."><span class="type">WebKitWebView</span></a>.</p>
<p>When a <a class="link" href="WebKitWebView.html" title="The main frame document title of this #WebKitWebView. If the title has not been received yet, it will be %NULL."><span class="type">WebKitWebView</span></a> is about to display the context menu, it
Alberto Garcia's avatar
Alberto Garcia committed
190 191 192 193 194 195 196
emits the <a class="link" href="WebKitWebView.html#WebKitWebView-context-menu" title="The “context-menu” signal"><span class="type">“context-menu”</span></a> signal, which has the
<a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> as an argument. You can modify it, adding new
submenus that you can create with <a class="link" href="WebKitContextMenu.html#webkit-context-menu-new" title="webkit_context_menu_new ()"><code class="function">webkit_context_menu_new()</code></a>, adding
new <a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a>s with
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-prepend" title="webkit_context_menu_prepend ()"><code class="function">webkit_context_menu_prepend()</code></a>, <a class="link" href="WebKitContextMenu.html#webkit-context-menu-append" title="webkit_context_menu_append ()"><code class="function">webkit_context_menu_append()</code></a> or
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-insert" title="webkit_context_menu_insert ()"><code class="function">webkit_context_menu_insert()</code></a>, maybe after having removed the
existing ones with <a class="link" href="WebKitContextMenu.html#webkit-context-menu-remove-all" title="webkit_context_menu_remove_all ()"><code class="function">webkit_context_menu_remove_all()</code></a>.</p>
197 198
</div>
<div class="refsect1">
199
<a name="WebKitContextMenu.functions_details"></a><h2>Functions</h2>
200
<div class="refsect2">
201 202 203
<a name="webkit-context-menu-new"></a><h3>webkit_context_menu_new ()</h3>
<pre class="programlisting"><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="returnvalue">WebKitContextMenu</span></a> *
webkit_context_menu_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
204
<p>Creates a new <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> object to be used as a submenu of an existing
Alberto Garcia's avatar
Alberto Garcia committed
205
<a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a>. The context menu of a <a class="link" href="WebKitWebView.html" title="The main frame document title of this #WebKitWebView. If the title has not been received yet, it will be %NULL."><span class="type">WebKitWebView</span></a> is created by the view
Alberto Garcia's avatar
Alberto Garcia committed
206 207 208 209 210 211 212 213 214
and passed as an argument of <a class="link" href="WebKitWebView.html#WebKitWebView-context-menu" title="The “context-menu” signal"><span class="type">“context-menu”</span></a> signal.
To add items to the menu use <a class="link" href="WebKitContextMenu.html#webkit-context-menu-prepend" title="webkit_context_menu_prepend ()"><code class="function">webkit_context_menu_prepend()</code></a>,
<a class="link" href="WebKitContextMenu.html#webkit-context-menu-append" title="webkit_context_menu_append ()"><code class="function">webkit_context_menu_append()</code></a> or <a class="link" href="WebKitContextMenu.html#webkit-context-menu-insert" title="webkit_context_menu_insert ()"><code class="function">webkit_context_menu_insert()</code></a>.
See also <a class="link" href="WebKitContextMenu.html#webkit-context-menu-new-with-items" title="webkit_context_menu_new_with_items ()"><code class="function">webkit_context_menu_new_with_items()</code></a> to create a <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> with
a list of initial items.</p>
<div class="refsect3">
<a name="webkit-context-menu-new.returns"></a><h4>Returns</h4>
<p> The newly created <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> object</p>
</div>
215 216 217
</div>
<hr>
<div class="refsect2">
218 219 220
<a name="webkit-context-menu-new-with-items"></a><h3>webkit_context_menu_new_with_items ()</h3>
<pre class="programlisting"><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="returnvalue">WebKitContextMenu</span></a> *
webkit_context_menu_new_with_items (<em class="parameter"><code><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *items</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
<p>Creates a new <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> object to be used as a submenu of an existing
<a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> with the given initial items.
See also <a class="link" href="WebKitContextMenu.html#webkit-context-menu-new" title="webkit_context_menu_new ()"><code class="function">webkit_context_menu_new()</code></a></p>
<div class="refsect3">
<a name="webkit-context-menu-new-with-items.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>items</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of <a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> WebKitContextMenuItem]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-context-menu-new-with-items.returns"></a><h4>Returns</h4>
<p> The newly created <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> object</p>
</div>
243 244 245
</div>
<hr>
<div class="refsect2">
246 247 248 249
<a name="webkit-context-menu-prepend"></a><h3>webkit_context_menu_prepend ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_context_menu_prepend (<em class="parameter"><code><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> *menu</code></em>,
                             <em class="parameter"><code><a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a> *item</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
<p>Adds <em class="parameter"><code>item</code></em>
 at the beginning of the <em class="parameter"><code>menu</code></em>
.</p>
<div class="refsect3">
<a name="webkit-context-menu-prepend.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>item</p></td>
<td class="parameter_description"><p>the <a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a> to add</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
275
</div>
276 277
<hr>
<div class="refsect2">
278 279 280 281
<a name="webkit-context-menu-append"></a><h3>webkit_context_menu_append ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_context_menu_append (<em class="parameter"><code><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> *menu</code></em>,
                            <em class="parameter"><code><a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a> *item</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
<p>Adds <em class="parameter"><code>item</code></em>
 at the end of the <em class="parameter"><code>menu</code></em>
.</p>
<div class="refsect3">
<a name="webkit-context-menu-append.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>item</p></td>
<td class="parameter_description"><p>the <a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a> to add</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
307
</div>
308 309
<hr>
<div class="refsect2">
310 311 312 313 314
<a name="webkit-context-menu-insert"></a><h3>webkit_context_menu_insert ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_context_menu_insert (<em class="parameter"><code><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> *menu</code></em>,
                            <em class="parameter"><code><a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a> *item</code></em>,
                            <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> position</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
<p>Inserts <em class="parameter"><code>item</code></em>
 into the <em class="parameter"><code>menu</code></em>
 at the given position.
If <em class="parameter"><code>position</code></em>
 is negative, or is larger than the number of items
in the <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a>, the item is added on to the end of
the <em class="parameter"><code>menu</code></em>
. The first position is 0.</p>
<div class="refsect3">
<a name="webkit-context-menu-insert.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>item</p></td>
<td class="parameter_description"><p>the <a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a> to add</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>the position to insert the item</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
350
</div>
351 352
<hr>
<div class="refsect2">
353 354 355 356 357
<a name="webkit-context-menu-move-item"></a><h3>webkit_context_menu_move_item ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_context_menu_move_item (<em class="parameter"><code><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> *menu</code></em>,
                               <em class="parameter"><code><a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a> *item</code></em>,
                               <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> position</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
<p>Moves <em class="parameter"><code>item</code></em>
 to the given position in the <em class="parameter"><code>menu</code></em>
.
If <em class="parameter"><code>position</code></em>
 is negative, or is larger than the number of items
in the <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a>, the item is added on to the end of
the <em class="parameter"><code>menu</code></em>
.
The first position is 0.</p>
<div class="refsect3">
<a name="webkit-context-menu-move-item.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>item</p></td>
<td class="parameter_description"><p>the <a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a> to add</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>the new position to move the item</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
394
</div>
395 396
<hr>
<div class="refsect2">
397 398 399
<a name="webkit-context-menu-get-items"></a><h3>webkit_context_menu_get_items ()</h3>
<pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
webkit_context_menu_get_items (<em class="parameter"><code><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> *menu</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
<p>Returns the item list of <em class="parameter"><code>menu</code></em>
.</p>
<div class="refsect3">
<a name="webkit-context-menu-get-items.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-context-menu-get-items.returns"></a><h4>Returns</h4>
<p>a <a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of
<a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a>s. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> WebKitContextMenuItem][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
423
</div>
424 425
<hr>
<div class="refsect2">
426 427 428
<a name="webkit-context-menu-get-n-items"></a><h3>webkit_context_menu_get_n_items ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
webkit_context_menu_get_n_items (<em class="parameter"><code><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> *menu</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
<p>Gets the length of the <em class="parameter"><code>menu</code></em>
.</p>
<div class="refsect3">
<a name="webkit-context-menu-get-n-items.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-context-menu-get-n-items.returns"></a><h4>Returns</h4>
<p> the number of <a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a>s in <em class="parameter"><code>menu</code></em>
</p>
</div>
451
</div>
452 453
<hr>
<div class="refsect2">
454 455 456
<a name="webkit-context-menu-first"></a><h3>webkit_context_menu_first ()</h3>
<pre class="programlisting"><a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="returnvalue">WebKitContextMenuItem</span></a> *
webkit_context_menu_first (<em class="parameter"><code><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> *menu</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
<p>Gets the first item in the <em class="parameter"><code>menu</code></em>
.</p>
<div class="refsect3">
<a name="webkit-context-menu-first.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-context-menu-first.returns"></a><h4>Returns</h4>
<p>the first <a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a> of <em class="parameter"><code>menu</code></em>
,
or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> is empty. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
481
</div>
482 483
<hr>
<div class="refsect2">
484 485 486
<a name="webkit-context-menu-last"></a><h3>webkit_context_menu_last ()</h3>
<pre class="programlisting"><a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="returnvalue">WebKitContextMenuItem</span></a> *
webkit_context_menu_last (<em class="parameter"><code><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> *menu</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
<p>Gets the last item in the <em class="parameter"><code>menu</code></em>
.</p>
<div class="refsect3">
<a name="webkit-context-menu-last.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-context-menu-last.returns"></a><h4>Returns</h4>
<p>the last <a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a> of <em class="parameter"><code>menu</code></em>
,
or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> is empty. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
511
</div>
512 513
<hr>
<div class="refsect2">
514 515 516 517 518
<a name="webkit-context-menu-get-item-at-position"></a><h3>webkit_context_menu_get_item_at_position ()</h3>
<pre class="programlisting"><a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="returnvalue">WebKitContextMenuItem</span></a> *
webkit_context_menu_get_item_at_position
                               (<em class="parameter"><code><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> *menu</code></em>,
                                <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> position</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
<p>Gets the item at the given position in the <em class="parameter"><code>menu</code></em>
.</p>
<div class="refsect3">
<a name="webkit-context-menu-get-item-at-position.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>the position of the item, counting from 0</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-context-menu-get-item-at-position.returns"></a><h4>Returns</h4>
<p>the <a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a> at position <em class="parameter"><code>position</code></em>
in <em class="parameter"><code>menu</code></em>
,
or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the position is off the end of the <em class="parameter"><code>menu</code></em>
. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
552
</div>
553 554
<hr>
<div class="refsect2">
555 556 557 558
<a name="webkit-context-menu-remove"></a><h3>webkit_context_menu_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_context_menu_remove (<em class="parameter"><code><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> *menu</code></em>,
                            <em class="parameter"><code><a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a> *item</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
<p>Removes <em class="parameter"><code>item</code></em>
 from the <em class="parameter"><code>menu</code></em>
.
See also <a class="link" href="WebKitContextMenu.html#webkit-context-menu-remove-all" title="webkit_context_menu_remove_all ()"><code class="function">webkit_context_menu_remove_all()</code></a> to remove all items.</p>
<div class="refsect3">
<a name="webkit-context-menu-remove.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>item</p></td>
<td class="parameter_description"><p>the <a class="link" href="WebKitContextMenuItem.html" title="WebKitContextMenuItem"><span class="type">WebKitContextMenuItem</span></a> to remove</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
585
</div>
586 587
<hr>
<div class="refsect2">
588 589 590
<a name="webkit-context-menu-remove-all"></a><h3>webkit_context_menu_remove_all ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_context_menu_remove_all (<em class="parameter"><code><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> *menu</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
<p>Removes all items of the <em class="parameter"><code>menu</code></em>
.</p>
<div class="refsect3">
<a name="webkit-context-menu-remove-all.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
608
</div>
609 610 611 612 613 614
<hr>
<div class="refsect2">
<a name="webkit-context-menu-set-user-data"></a><h3>webkit_context_menu_set_user_data ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_context_menu_set_user_data (<em class="parameter"><code><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> *menu</code></em>,
                                   <em class="parameter"><code><a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *user_data</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
<p>Sets user data to <em class="parameter"><code>menu</code></em>
.
This function can be used from a Web Process extension to set user data
that can be retrieved from the UI Process using <a class="link" href="WebKitContextMenu.html#webkit-context-menu-get-user-data" title="webkit_context_menu_get_user_data ()"><code class="function">webkit_context_menu_get_user_data()</code></a>.
If the <em class="parameter"><code>user_data</code></em>
 <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> is floating, it is consumed.</p>
<div class="refsect3">
<a name="webkit-context-menu-set-user-data.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
644 645 646 647 648 649
</div>
<hr>
<div class="refsect2">
<a name="webkit-context-menu-get-user-data"></a><h3>webkit_context_menu_get_user_data ()</h3>
<pre class="programlisting"><a href="../glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
webkit_context_menu_get_user_data (<em class="parameter"><code><a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> *menu</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
<p>Gets the user data of <em class="parameter"><code>menu</code></em>
.
This function can be used from the UI Process to get user data previously set
from the Web Process with <a class="link" href="WebKitContextMenu.html#webkit-context-menu-set-user-data" title="webkit_context_menu_set_user_data ()"><code class="function">webkit_context_menu_set_user_data()</code></a>.</p>
<div class="refsect3">
<a name="webkit-context-menu-get-user-data.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-context-menu-get-user-data.returns"></a><h4>Returns</h4>
<p>the user data of <em class="parameter"><code>menu</code></em>
, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>menu</code></em>
doesn't have user data. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
677
</div>
678
</div>
679 680 681 682 683 684 685 686
<div class="refsect1">
<a name="WebKitContextMenu.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="WebKitContextMenu-struct"></a><h3>WebKitContextMenu</h3>
<pre class="programlisting">typedef struct _WebKitContextMenu WebKitContextMenu;</pre>
</div>
</div>
</div>
687
<div class="footer">
Alberto Garcia's avatar
Alberto Garcia committed
688
<hr>Generated by GTK-Doc V1.33.0</div>
689 690
</body>
</html>