WebKit.ContextMenu¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
class	`new_with_items` (items)
	`append` (item)
	`first` ()
	`get_event` ()
	`get_item_at_position` (position)
	`get_items` ()
	`get_n_items` ()
	`get_user_data` ()
	`insert` (item, position)
	`last` ()
	`move_item` (item, position)
	`prepend` (item)
	`remove` (item)
	`remove_all` ()
	`set_user_data` (user_data)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class WebKit.ContextMenu(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: WebKit.ContextMenuClass

Represents the context menu in a WebKit.WebView.

WebKit.ContextMenu represents a context menu containing WebKit.ContextMenuItem s in a WebKit.WebView.

When a WebKit.WebView is about to display the context menu, it emits the WebKit.WebView ::context-menu signal, which has the WebKit.ContextMenu as an argument. You can modify it, adding new submenus that you can create with WebKit.ContextMenu.new(), adding new WebKit.ContextMenuItem s with WebKit.ContextMenu.prepend(), WebKit.ContextMenu.append() or WebKit.ContextMenu.insert(), maybe after having removed the existing ones with WebKit.ContextMenu.remove_all().

classmethod new()¶

Returns:: The newly created WebKit.ContextMenu object
Return type:: WebKit.ContextMenu

Creates a new WebKit.ContextMenu object.

Creates a new WebKit.ContextMenu object to be used as a submenu of an existing WebKit.ContextMenu. The context menu of a WebKit.WebView is created by the view and passed as an argument of WebKit.WebView ::context-menu signal. To add items to the menu use WebKit.ContextMenu.prepend(), WebKit.ContextMenu.append() or WebKit.ContextMenu.insert(). See also WebKit.ContextMenu.new_with_items() to create a WebKit.ContextMenu with a list of initial items.

classmethod new_with_items(items)¶

Parameters:: items ([WebKit.ContextMenuItem]) – a GLib.List of WebKit.ContextMenuItem
Returns:: The newly created WebKit.ContextMenu object
Return type:: WebKit.ContextMenu

Creates a new WebKit.ContextMenu object with the given items.

Creates a new WebKit.ContextMenu object to be used as a submenu of an existing WebKit.ContextMenu with the given initial items. See also WebKit.ContextMenu.new()

append(item)¶

Parameters:: item (WebKit.ContextMenuItem) – the WebKit.ContextMenuItem to add

Adds item at the end of the self.

first()¶

Returns:: the first WebKit.ContextMenuItem of self, or None if the WebKit.ContextMenu is empty.
Return type:: WebKit.ContextMenuItem

Gets the first item in the self.

get_event()¶

Returns:: the menu event or None.
Return type:: Gdk.Event

Gets the Gdk.Event that triggered the context menu. This function only returns a valid Gdk.Event when called for a WebKit.ContextMenu passed to WebKit.WebView ::context-menu signal; in all other cases, None is returned.

The returned Gdk.Event is expected to be one of the following types:

a #GdkEventButton of type Gdk.EventType.BUTTON_PRESS when the context menu was triggered with mouse.
a #GdkEventKey of type Gdk.EventType.KEY_PRESS if the keyboard was used to show the menu.
a generic Gdk.Event of type %GDK_NOTHING when the Gtk.Widget ::popup-menu signal was used to show the context menu.

New in version 2.40.

get_item_at_position(position)¶

Parameters:: position (int) – the position of the item, counting from 0
Returns:: the WebKit.ContextMenuItem at position position in self, or None if the position is off the end of the self.
Return type:: WebKit.ContextMenuItem

Gets the item at the given position in the self.

get_items()¶

Returns:: a GLib.List of WebKit.ContextMenuItem s
Return type:: [WebKit.ContextMenuItem]

Returns the item list of self.

get_n_items()¶

Returns:: the number of WebKit.ContextMenuItem s in self
Return type:: int

Gets the length of the self.

get_user_data()¶

Returns:: the user data of self, or None if self doesn’t have user data
Return type:: GLib.Variant

Gets the user data of self.

This function can be used from the UI Process to get user data previously set from the Web Process with WebKit.ContextMenu.set_user_data().

New in version 2.8.

insert(item, position)¶

Parameters:

item (WebKit.ContextMenuItem) – the WebKit.ContextMenuItem to add
position (int) – the position to insert the item

Inserts item into the self at the given position.

If position is negative, or is larger than the number of items in the WebKit.ContextMenu, the item is added on to the end of the self. The first position is 0.

last()¶

Returns:: the last WebKit.ContextMenuItem of self, or None if the WebKit.ContextMenu is empty.
Return type:: WebKit.ContextMenuItem

Gets the last item in the self.

move_item(item, position)¶

Parameters:

item (WebKit.ContextMenuItem) – the WebKit.ContextMenuItem to add
position (int) – the new position to move the item

Moves item to the given position in the self.

If position is negative, or is larger than the number of items in the WebKit.ContextMenu, the item is added on to the end of the self. The first position is 0.

prepend(item)¶

Parameters:: item (WebKit.ContextMenuItem) – the WebKit.ContextMenuItem to add

Adds item at the beginning of the self.

remove(item)¶

Parameters:: item (WebKit.ContextMenuItem) – the WebKit.ContextMenuItem to remove

Removes item from the self.

See also WebKit.ContextMenu.remove_all() to remove all items.

remove_all()¶: Removes all items of the self.

set_user_data(user_data)¶

Parameters:: user_data (GLib.Variant) – a GLib.Variant

Sets user data to self.

This function can be used from a Web Process extension to set user data that can be retrieved from the UI Process using WebKit.ContextMenu.get_user_data(). If the user_data GLib.Variant is floating, it is consumed.

New in version 2.8.