WebKit2.WebView::context-menu
connect('context-menu', function (webView, context_menu: WebKit2.ContextMenu, event: Gdk.Event, hit_test_result: WebKit2.HitTestResult, ): Boolean);
Emmited when a context menu is about to be displayed to give the application a chance to customize the proposed menu, prevent the menu from being displayed or build its own context menu. <itemizedlist> <listitem><para> To customize the proposed menu you can use WebKit2.ContextMenu.prototype.prepend, WebKit2.ContextMenu.prototype.append or WebKit2.ContextMenu.prototype.insert to add new WebKit2.ContextMenuItem<!-- -->s to context_menu, WebKit2.ContextMenu.prototype.move_item to reorder existing items, or WebKit2.ContextMenu.prototype.remove to remove an existing item. The signal handler should return false, and the menu represented by context_menu will be shown. </para></listitem> <listitem><para> To prevent the menu from being displayed you can just connect to this signal and return true so that the proposed menu will not be shown. </para></listitem> <listitem><para> To build your own menu, you can remove all items from the proposed menu with WebKit2.ContextMenu.prototype.remove_all, add your own items and return false so that the menu will be shown. You can also ignore the proposed WebKit2.ContextMenu, build your own Gtk.Menu and return true to prevent the proposed menu from being shown. </para></listitem> <listitem><para> If you just want the default menu to be shown always, simply don't connect to this signal because showing the proposed context menu is the default behaviour. </para></listitem> </itemizedlist>
If the signal handler returns false the context menu represented by context_menu will be shown, if it return true the context menu will not be shown.
The proposed WebKit2.ContextMenu passed in context_menu argument is only valid during the signal emission.
- webView
instance of WebKit2.WebView that is emitting the signal
- context_menu
the proposed WebKit2.ContextMenu
- event
the Gdk.Event that triggered the context menu
- hit_test_result
- Returns
true to stop other handlers from being invoked for the event. false to propagate the event further.