Struct webkit6::ContextMenu

pub struct ContextMenu { /* private fields */ }

Represents the context menu in a #WebKitWebView.

#WebKitContextMenu represents a context menu containing #WebKitContextMenuItems in a #WebKitWebView.

When a #WebKitWebView is about to display the context menu, it emits the #WebKitWebView::context-menu signal, which has the #WebKitContextMenu as an argument. You can modify it, adding new submenus that you can create with webkit_context_menu_new(), adding new #WebKitContextMenuItems with webkit_context_menu_prepend(), webkit_context_menu_append() or webkit_context_menu_insert(), maybe after having removed the existing ones with webkit_context_menu_remove_all().

GLib type: GObject with reference counted clone semantics.

Implementations

impl ContextMenu

pub fn new() -> ContextMenu

Creates a new #WebKitContextMenu object.

Creates a new #WebKitContextMenu object to be used as a submenu of an existing #WebKitContextMenu. The context menu of a #WebKitWebView is created by the view and passed as an argument of #WebKitWebView::context-menu signal. To add items to the menu use webkit_context_menu_prepend(), webkit_context_menu_append() or webkit_context_menu_insert(). See also webkit_context_menu_new_with_items() to create a #WebKitContextMenu with a list of initial items.

Returns

The newly created #WebKitContextMenu object

pub fn with_items(items: &[ContextMenuItem]) -> ContextMenu

Creates a new #WebKitContextMenu object with the given items.

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

items

a #GList of #WebKitContextMenuItem

Returns

The newly created #WebKitContextMenu object

pub fn append(&self, item: &ContextMenuItem)

Adds @item at the end of the @self.

item

the #WebKitContextMenuItem to add

pub fn first(&self) -> Option<ContextMenuItem>

Gets the first item in the @self.

Returns

the first #WebKitContextMenuItem of @self, or None if the #WebKitContextMenu is empty.

pub fn event(&self) -> Option<Event>

Gets the #GdkEvent that triggered the context menu. This function only returns a valid #GdkEvent when called for a #WebKitContextMenu passed to #WebKitWebView::context-menu signal; in all other cases, None is returned.

The returned #GdkEvent is expected to be one of the following types: a #GdkEventButton of type GDK_BUTTON_PRESS when the context menu was triggered with mouse. a #GdkEventKey of type GDK_KEY_PRESS if the keyboard was used to show the menu. a generic #GdkEvent of type GDK_NOTHING when the #GtkWidget::popup-menu signal was used to show the context menu.

Returns

the menu event or None.

pub fn item_at_position(&self, position: u32) -> Option<ContextMenuItem>

Gets the item at the given position in the @self.

position

the position of the item, counting from 0

Returns

the #WebKitContextMenuItem at position @position in @self, or None if the position is off the end of the @self.

pub fn items(&self) -> Vec<ContextMenuItem>

Returns the item list of @self.

Returns

a #GList of #WebKitContextMenuItems

pub fn n_items(&self) -> u32

Gets the length of the @self.

Returns

the number of #WebKitContextMenuItems in @self

pub fn user_data(&self) -> Option<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_context_menu_set_user_data().

Returns

the user data of @self, or None if @self doesn’t have user data

pub fn insert(&self, item: &ContextMenuItem, position: i32)

Inserts @item into the @self at the given position.

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

item

the #WebKitContextMenuItem to add

position

the position to insert the item

pub fn last(&self) -> Option<ContextMenuItem>

Gets the last item in the @self.

Returns

the last #WebKitContextMenuItem of @self, or None if the #WebKitContextMenu is empty.

pub fn move_item(&self, item: &ContextMenuItem, position: i32)

Moves @item to the given position in the @self.

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

item

the #WebKitContextMenuItem to add

position

the new position to move the item

pub fn prepend(&self, item: &ContextMenuItem)

Adds @item at the beginning of the @self.

item

the #WebKitContextMenuItem to add

pub fn remove(&self, item: &ContextMenuItem)

Removes @item from the @self.

See also webkit_context_menu_remove_all() to remove all items.

item

the #WebKitContextMenuItem to remove

pub fn remove_all(&self)

Removes all items of the @self.

pub fn set_user_data(&self, user_data: &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_context_menu_get_user_data(). If the @user_data #GVariant is floating, it is consumed.

Trait Implementations

impl Clone for ContextMenu

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ContextMenu

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ContextMenu

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for ContextMenu

type ParamSpec = ParamSpecObject

type SetValue = ContextMenu

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, ContextMenu>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ContextMenu

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ContextMenu

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for ContextMenu

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for ContextMenu

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for ContextMenu

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ContextMenu

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ContextMenu