Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.WebKit2WebExtension.Objects.ContextMenu

Contents

Exported types
Methods

Description

Synopsis

Exported types

newtype ContextMenu Source #

Constructors

ContextMenu (ManagedPtr ContextMenu)

Instances

GObject ContextMenu Source #
Methods gobjectType :: ContextMenu -> IO GType #
IsObject ContextMenu Source #

IsContextMenu ContextMenu Source #

((~) * info (ResolveContextMenuMethod t ContextMenu), MethodInfo * info ContextMenu p) => IsLabel t (ContextMenu -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> ContextMenu -> p #
((~) * info (ResolveContextMenuMethod t ContextMenu), MethodInfo * info ContextMenu p) => IsLabelProxy t (ContextMenu -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> ContextMenu -> p #
HasAttributeList * ContextMenu Source #

type AttributeList ContextMenu Source #
type AttributeList ContextMenu
type SignalList ContextMenu Source #
type SignalList ContextMenu

class GObject o => IsContextMenu o Source #

Instances

(GObject a, UnknownAncestorError Constraint ContextMenu a) => IsContextMenu a Source #

IsContextMenu ContextMenu Source #

toContextMenu :: IsContextMenu o => o -> IO ContextMenu Source #

noContextMenu :: Maybe ContextMenu Source #

Methods

append

data ContextMenuAppendMethodInfo Source #

Instances

((~) * signature (b -> m ()), MonadIO m, IsContextMenu a, IsContextMenuItem b) => MethodInfo * ContextMenuAppendMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ContextMenuAppendMethodInfo a -> signature -> s #

contextMenuAppend Source #

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

data ContextMenuFirstMethodInfo Source #

Instances

((~) * signature (m ContextMenuItem), MonadIO m, IsContextMenu a) => MethodInfo * ContextMenuFirstMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ContextMenuFirstMethodInfo a -> signature -> s #

contextMenuFirst Source #

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

data ContextMenuGetItemAtPositionMethodInfo Source #

Instances

((~) * signature (Word32 -> m ContextMenuItem), MonadIO m, IsContextMenu a) => MethodInfo * ContextMenuGetItemAtPositionMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ContextMenuGetItemAtPositionMethodInfo a -> signature -> s #

contextMenuGetItemAtPosition Source #

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

data ContextMenuGetItemsMethodInfo Source #

Instances

((~) * signature (m [ContextMenuItem]), MonadIO m, IsContextMenu a) => MethodInfo * ContextMenuGetItemsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ContextMenuGetItemsMethodInfo a -> signature -> s #

contextMenuGetItems Source #

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a)
=> a	`menu`: a `WebKitContextMenu`
-> m [ContextMenuItem]	Returns: a `List` of `WebKitContextMenuItem`<!-- -->s

Returns the item list of menu.

getNItems

data ContextMenuGetNItemsMethodInfo Source #

Instances

((~) * signature (m Word32), MonadIO m, IsContextMenu a) => MethodInfo * ContextMenuGetNItemsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ContextMenuGetNItemsMethodInfo a -> signature -> s #

contextMenuGetNItems Source #

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a)
=> a	`menu`: a `WebKitContextMenu`
-> m Word32	Returns: the number of `WebKitContextMenuItem`<!-- -->s in `menu`

Gets the length of the menu.

getUserData

data ContextMenuGetUserDataMethodInfo Source #

Instances

((~) * signature (m GVariant), MonadIO m, IsContextMenu a) => MethodInfo * ContextMenuGetUserDataMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ContextMenuGetUserDataMethodInfo a -> signature -> s #

contextMenuGetUserData Source #

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

data ContextMenuInsertMethodInfo Source #

Instances

((~) * signature (b -> Int32 -> m ()), MonadIO m, IsContextMenu a, IsContextMenuItem b) => MethodInfo * ContextMenuInsertMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ContextMenuInsertMethodInfo a -> signature -> s #

contextMenuInsert Source #

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

data ContextMenuLastMethodInfo Source #

Instances

((~) * signature (m ContextMenuItem), MonadIO m, IsContextMenu a) => MethodInfo * ContextMenuLastMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ContextMenuLastMethodInfo a -> signature -> s #

contextMenuLast Source #

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

data ContextMenuMoveItemMethodInfo Source #

Instances

((~) * signature (b -> Int32 -> m ()), MonadIO m, IsContextMenu a, IsContextMenuItem b) => MethodInfo * ContextMenuMoveItemMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ContextMenuMoveItemMethodInfo a -> signature -> s #

contextMenuMoveItem Source #

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 Source #

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 Source #

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

data ContextMenuPrependMethodInfo Source #

Instances

((~) * signature (b -> m ()), MonadIO m, IsContextMenu a, IsContextMenuItem b) => MethodInfo * ContextMenuPrependMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ContextMenuPrependMethodInfo a -> signature -> s #

contextMenuPrepend Source #

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

data ContextMenuRemoveMethodInfo Source #

Instances

((~) * signature (b -> m ()), MonadIO m, IsContextMenu a, IsContextMenuItem b) => MethodInfo * ContextMenuRemoveMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ContextMenuRemoveMethodInfo a -> signature -> s #

contextMenuRemove Source #

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

data ContextMenuRemoveAllMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsContextMenu a) => MethodInfo * ContextMenuRemoveAllMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ContextMenuRemoveAllMethodInfo a -> signature -> s #

contextMenuRemoveAll Source #

Arguments

:: (HasCallStack, MonadIO m, IsContextMenu a)
=> a	`menu`: a `WebKitContextMenu`
-> m ()

Removes all items of the menu.

setUserData

data ContextMenuSetUserDataMethodInfo Source #

Instances

((~) * signature (GVariant -> m ()), MonadIO m, IsContextMenu a) => MethodInfo * ContextMenuSetUserDataMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ContextMenuSetUserDataMethodInfo a -> signature -> s #

contextMenuSetUserData Source #

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.

Since: 2.8