GI.WebKit2WebExtension.Objects.ContextMenu

No description available in the introspection data.

Exported types

newtype ContextMenu

Memory-managed wrapper type.

Constructors

ContextMenu (ManagedPtr ContextMenu)

Instances

Eq ContextMenu

Defined in GI.WebKit2WebExtension.Objects.ContextMenu

Methods

(==) :: ContextMenu -> ContextMenu -> Bool

(/=) :: ContextMenu -> ContextMenu -> Bool

IsGValue ContextMenu

Convert ContextMenu to and from GValue with toGValue and fromGValue.

Defined in GI.WebKit2WebExtension.Objects.ContextMenu

Methods

toGValue :: ContextMenu -> IO GValue

fromGValue :: GValue -> IO ContextMenu

GObject ContextMenu

Defined in GI.WebKit2WebExtension.Objects.ContextMenu

Methods

gobjectType :: IO GType

HasParentTypes ContextMenu

Defined in GI.WebKit2WebExtension.Objects.ContextMenu

type ParentTypes ContextMenu

Defined in GI.WebKit2WebExtension.Objects.ContextMenu

type ParentTypes ContextMenu = '[Object]

class (GObject o, IsDescendantOf ContextMenu o) => IsContextMenu o

Type class for types which can be safely cast to ContextMenu, for instance with toContextMenu.

Instances

(GObject o, IsDescendantOf ContextMenu o) => IsContextMenu o

Defined in GI.WebKit2WebExtension.Objects.ContextMenu

toContextMenu :: (MonadIO m, IsContextMenu o) => o -> m ContextMenu

Cast to ContextMenu, for types for which this is known to be safe. For general casts, use castTo.

noContextMenu :: Maybe ContextMenu

A convenience alias for Nothing :: Maybe ContextMenu.

Methods

Overloaded methods

append

contextMenuAppend

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a, IsContextMenuItem b)

=> a

menu: a WebKitContextMenu

-> b

item: the WebKitContextMenuItem to add

-> m ()

Adds item at the end of the menu.

first

contextMenuFirst

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a)

=> a

menu: a WebKitContextMenu

-> m ContextMenuItem

Returns: the first WebKitContextMenuItem of menu, or Nothing if the WebKitContextMenu is empty.

Gets the first item in the menu.

getItemAtPosition

contextMenuGetItemAtPosition

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a)

=> a

menu: a WebKitContextMenu

-> Word32

position: the position of the item, counting from 0

-> m ContextMenuItem

Returns: the WebKitContextMenuItem at position position in menu, or Nothing if the position is off the end of the menu.

Gets the item at the given position in the menu.

getItems

contextMenuGetItems

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a)

=> a

menu: a WebKitContextMenu

-> m [ContextMenuItem]

Returns: a List of WebKitContextMenuItems

Returns the item list of menu.

getNItems

contextMenuGetNItems

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a)

=> a

menu: a WebKitContextMenu

-> m Word32

Returns: the number of WebKitContextMenuItems in menu

Gets the length of the menu.

getUserData

contextMenuGetUserData

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a)

=> a

menu: a WebKitContextMenu

-> m GVariant

Returns: the user data of menu, or Nothing if menu doesn't have user data

Gets the user data of menu. This function can be used from the UI Process to get user data previously set from the Web Process with contextMenuSetUserData.

Since: 2.8

insert

contextMenuInsert

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a, IsContextMenuItem b)

=> a

menu: a WebKitContextMenu

-> b

item: the WebKitContextMenuItem to add

-> Int32

position: the position to insert the item

-> m ()

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

last

contextMenuLast

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a)

=> a

menu: a WebKitContextMenu

-> m ContextMenuItem

Returns: the last WebKitContextMenuItem of menu, or Nothing if the WebKitContextMenu is empty.

Gets the last item in the menu.

moveItem

contextMenuMoveItem

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a, IsContextMenuItem b)

=> a

menu: a WebKitContextMenu

-> b

item: the WebKitContextMenuItem to add

-> Int32

position: the new position to move the item

-> m ()

Moves item to the given position in the menu. 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 menu. The first position is 0.

new

contextMenuNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ContextMenu

Returns: The newly created 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 contextMenuPrepend, contextMenuAppend or contextMenuInsert. See also contextMenuNewWithItems to create a WebKitContextMenu with a list of initial items.

newWithItems

contextMenuNewWithItems

Arguments

:: (HasCallStack, MonadIO m, IsContextMenuItem a)

=> [a]

items: a List of WebKitContextMenuItem

-> m ContextMenu

Returns: The newly created WebKitContextMenu object

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

prepend

contextMenuPrepend

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a, IsContextMenuItem b)

=> a

menu: a WebKitContextMenu

-> b

item: the WebKitContextMenuItem to add

-> m ()

Adds item at the beginning of the menu.

remove

contextMenuRemove

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a, IsContextMenuItem b)

=> a

menu: a WebKitContextMenu

-> b

item: the WebKitContextMenuItem to remove

-> m ()

Removes item from the menu. See also contextMenuRemoveAll to remove all items.

removeAll

contextMenuRemoveAll

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a)

=> a

menu: a WebKitContextMenu

-> m ()

Removes all items of the menu.

setUserData

contextMenuSetUserData

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a)

=> a

menu: a WebKitContextMenu

-> GVariant

userData: a GVariant

-> m ()

Sets user data to menu. This function can be used from a Web Process extension to set user data that can be retrieved from the UI Process using contextMenuGetUserData. If the userData GVariant is floating, it is consumed.

Since: 2.8