Package org.gnome.webkit.wpe

Class ContextMenu

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.webkit.wpe.ContextMenu

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class ContextMenu
extends GObject

Represents the context menu in a WebKitWebView.

WebKitContextMenu represents a context menu containing WebKitContextMenuItem<!-- -->s 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 WebKitContextMenuItem<!-- -->s 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().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ContextMenu.Builder<B extends ContextMenu.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	ContextMenu.ContextMenuClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
ContextMenu()	Creates a new WebKitContextMenu object.
ContextMenu(MemorySegment address)	Create a ContextMenu proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	append(ContextMenuItem item)	Adds item at the end of the this ContextMenu.
protected ContextMenu	asParent()	Returns this instance as if it were its parent type.
static ContextMenu.Builder<? extends ContextMenu.Builder>	builder()	A ContextMenu.Builder object constructs a ContextMenu with the specified properties.
ContextMenuItem	first()	Gets the first item in the this ContextMenu.
Event	getEvent()	Gets the GdkEvent that triggered the context menu.
ContextMenuItem	getItemAtPosition(int position)	Gets the item at the given position in the this ContextMenu.
List<ContextMenuItem>	getItems()	Returns the item list of this ContextMenu.
int	getNItems()	Gets the length of the this ContextMenu.
static Type	getType()	Get the GType of the ContextMenu class
Variant	getUserData()	Gets the user data of this ContextMenu.
void	insert(ContextMenuItem item, int position)	Inserts item into the this ContextMenu at the given position.
ContextMenuItem	last()	Gets the last item in the this ContextMenu.
void	moveItem(ContextMenuItem item, int position)	Moves item to the given position in the this ContextMenu.
void	prepend(ContextMenuItem item)	Adds item at the beginning of the this ContextMenu.
void	remove(ContextMenuItem item)	Removes item from the this ContextMenu.
void	removeAll()	Removes all items of the this ContextMenu.
void	setUserData(Variant userData)	Sets user data to this ContextMenu.
static ContextMenu	withItems(List<ContextMenuItem> items)	Creates a new WebKitContextMenu object with the given items.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newInstance, newInstance, newv, notify_, notify_, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ContextMenu

public ContextMenu(MemorySegment address)

Create a ContextMenu proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ContextMenu

public ContextMenu()
            throws UnsupportedPlatformException

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.

Throws:

UnsupportedPlatformException - when run on a platform other than linux

Method Details

getType

public static Type getType()

Get the GType of the ContextMenu class

Returns:

the GType

asParent

protected ContextMenu asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

withItems

public static ContextMenu withItems(List<ContextMenuItem> items)

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()

Parameters:

items - a GList of WebKitContextMenuItem

Returns:

The newly created WebKitContextMenu object

Throws:

UnsupportedPlatformException - when run on a platform other than linux

append

public void append(ContextMenuItem item)

Adds item at the end of the this ContextMenu.

Parameters:

item - the WebKitContextMenuItem to add

first

public ContextMenuItem first()

Gets the first item in the this ContextMenu.

Returns:

the first WebKitContextMenuItem of this ContextMenu, or null if the WebKitContextMenu is empty.

getEvent

public Event getEvent()

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, null is returned.

The returned GdkEvent is expected to be one of the following types: <itemizedlist> <listitem><para> a GdkEventButton of type EventType.BUTTON_PRESS when the context menu was triggered with mouse. </para></listitem> <listitem><para> a GdkEventKey of type EventType.KEY_PRESS if the keyboard was used to show the menu. </para></listitem> <listitem><para> a generic GdkEvent of type GDK_NOTHING when the GtkWidget::popup-menu signal was used to show the context menu. </para></listitem> </itemizedlist>

Returns:

the menu event or null.

getItemAtPosition

public ContextMenuItem getItemAtPosition(int position)

Gets the item at the given position in the this ContextMenu.

Parameters:

position - the position of the item, counting from 0

Returns:

the WebKitContextMenuItem at position position in this ContextMenu, or null if the position is off the end of the this ContextMenu.

getItems

public List<ContextMenuItem> getItems()

Returns the item list of this ContextMenu.

Returns:

a GList of WebKitContextMenuItem<!-- -->s

getNItems

public int getNItems()

Gets the length of the this ContextMenu.

Returns:

the number of WebKitContextMenuItem<!-- -->s in this ContextMenu

getUserData

public Variant getUserData()

Gets the user data of this ContextMenu.

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 this ContextMenu, or null if this ContextMenu doesn't have user data

insert

public void insert(ContextMenuItem item,
 int position)

Inserts item into the this ContextMenu 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 this ContextMenu. The first position is 0.

Parameters:

item - the WebKitContextMenuItem to add

position - the position to insert the item

last

public ContextMenuItem last()

Gets the last item in the this ContextMenu.

Returns:

the last WebKitContextMenuItem of this ContextMenu, or null if the WebKitContextMenu is empty.

moveItem

public void moveItem(ContextMenuItem item,
 int position)

Moves item to the given position in the this ContextMenu.

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 this ContextMenu. The first position is 0.

Parameters:

item - the WebKitContextMenuItem to add

position - the new position to move the item

prepend

public void prepend(ContextMenuItem item)

Adds item at the beginning of the this ContextMenu.

Parameters:

item - the WebKitContextMenuItem to add

remove

public void remove(ContextMenuItem item)

Removes item from the this ContextMenu.

See also webkit_context_menu_remove_all() to remove all items.

Parameters:

item - the WebKitContextMenuItem to remove

removeAll

public void removeAll()

Removes all items of the this ContextMenu.

setUserData

public void setUserData(Variant userData)

Sets user data to this ContextMenu.

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 userData GVariant is floating, it is consumed.

Parameters:

userData - a GVariant

builder

public static ContextMenu.Builder<? extends ContextMenu.Builder> builder()

A ContextMenu.Builder object constructs a ContextMenu with the specified properties. Use the various set...() methods to set properties, and finish construction with ContextMenu.Builder.build().