context_menu

Emitted 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.

• To customize the proposed menu you can use prepend, append or insert to add new ContextMenuItem objects to context_menu, move_item to reorder existing items, or remove to remove an existing item. The signal handler should return false, and the menu represented by context_menu will be shown.
• 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.
• To build your own menu, you can remove all items from the proposed menu with remove_all, add your own items and return false so that the menu will be shown. You can also ignore the proposed ContextMenu, build your own Menu and return true to prevent the proposed menu from being shown.
• 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 behavior.

The event parameter is now deprecated. Use get_event to get the Event that triggered the context menu.

If the signal handler returns false the context menu represented by context_menu will be shown, if it returns true the context menu will not be shown.

The proposed ContextMenu passed in context_menu argument is only valid during the signal emission.

Parameters:

context_menu	the proposed ContextMenu
event	the Event that triggered the context menu. Deprecated 2.40.
hit_test_result	a HitTestResult

Returns:

true to stop other handlers from being invoked for the event. false to propagate the event further.