Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.WebKit2.Structs.OptionMenuItem

Contents

Exported types
Methods

Description

One item of a OptionMenu.

The OptionMenu is composed of WebKitOptionMenuItems. A WebKitOptionMenuItem always has a label and can contain a tooltip text. You can use the WebKitOptionMenuItem of a OptionMenu to build your own menus.

Since: 2.18

Synopsis

newtype OptionMenuItem = OptionMenuItem (ManagedPtr OptionMenuItem)
optionMenuItemCopy :: (HasCallStack, MonadIO m) => OptionMenuItem -> m OptionMenuItem
optionMenuItemFree :: (HasCallStack, MonadIO m) => OptionMenuItem -> m ()
optionMenuItemGetLabel :: (HasCallStack, MonadIO m) => OptionMenuItem -> m Text
optionMenuItemGetTooltip :: (HasCallStack, MonadIO m) => OptionMenuItem -> m (Maybe Text)
optionMenuItemIsEnabled :: (HasCallStack, MonadIO m) => OptionMenuItem -> m Bool
optionMenuItemIsGroupChild :: (HasCallStack, MonadIO m) => OptionMenuItem -> m Bool
optionMenuItemIsGroupLabel :: (HasCallStack, MonadIO m) => OptionMenuItem -> m Bool
optionMenuItemIsSelected :: (HasCallStack, MonadIO m) => OptionMenuItem -> m Bool

Exported types

newtype OptionMenuItem Source #

Memory-managed wrapper type.

Constructors

OptionMenuItem (ManagedPtr OptionMenuItem)

Instances

Instances details

Eq OptionMenuItem Source #
Instance details Defined in GI.WebKit2.Structs.OptionMenuItem Methods (==) :: OptionMenuItem -> OptionMenuItem -> Bool # (/=) :: OptionMenuItem -> OptionMenuItem -> Bool #
GBoxed OptionMenuItem Source #
Instance details Defined in GI.WebKit2.Structs.OptionMenuItem
ManagedPtrNewtype OptionMenuItem Source #
Instance details Defined in GI.WebKit2.Structs.OptionMenuItem Methods toManagedPtr :: OptionMenuItem -> ManagedPtr OptionMenuItem
TypedObject OptionMenuItem Source #
Instance details Defined in GI.WebKit2.Structs.OptionMenuItem Methods glibType :: IO GType
HasParentTypes OptionMenuItem Source #
Instance details Defined in GI.WebKit2.Structs.OptionMenuItem
IsGValue (Maybe OptionMenuItem) Source #	Convert `OptionMenuItem` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.WebKit2.Structs.OptionMenuItem Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe OptionMenuItem -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe OptionMenuItem)
type ParentTypes OptionMenuItem Source #
Instance details Defined in GI.WebKit2.Structs.OptionMenuItem type ParentTypes OptionMenuItem = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

copy, free, isEnabled, isGroupChild, isGroupLabel, isSelected.

Getters

getLabel, getTooltip.

Setters

None.

copy

optionMenuItemCopy Source #

Arguments

:: (HasCallStack, MonadIO m)
=> OptionMenuItem	`item`: a `OptionMenuItem`
-> m OptionMenuItem	Returns: A copy of passed in `OptionMenuItem`

Make a copy of the OptionMenuItem.

Since: 2.18

free

optionMenuItemFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> OptionMenuItem	`item`: A `OptionMenuItem`
-> m ()

Free the OptionMenuItem.

Since: 2.18

getLabel

optionMenuItemGetLabel Source #

Arguments

:: (HasCallStack, MonadIO m)
=> OptionMenuItem	`item`: a `OptionMenuItem`
-> m Text	Returns: The label of `item`.

Get the label of a OptionMenuItem.

Since: 2.18

getTooltip

optionMenuItemGetTooltip Source #

Arguments

:: (HasCallStack, MonadIO m)
=> OptionMenuItem	`item`: a `OptionMenuItem`
-> m (Maybe Text)	Returns: The tooltip of `item`, or `Nothing`.

Get the tooltip of a OptionMenuItem.

Since: 2.18

isEnabled

optionMenuItemIsEnabled Source #

Arguments

:: (HasCallStack, MonadIO m)
=> OptionMenuItem	`item`: a `OptionMenuItem`
-> m Bool	Returns: `True` if the `item` is enabled or `False` otherwise.

Whether a OptionMenuItem is enabled.

Since: 2.18

isGroupChild

optionMenuItemIsGroupChild Source #

Arguments

:: (HasCallStack, MonadIO m)
=> OptionMenuItem	`item`: a `OptionMenuItem`
-> m Bool	Returns: `True` if the `item` is a group child or `False` otherwise.

Whether a OptionMenuItem is a group child.

Since: 2.18

isGroupLabel

optionMenuItemIsGroupLabel Source #

Arguments

:: (HasCallStack, MonadIO m)
=> OptionMenuItem	`item`: a `OptionMenuItem`
-> m Bool	Returns: `True` if the `item` is a group label or `False` otherwise.

Whether a OptionMenuItem is a group label.

Since: 2.18

isSelected

optionMenuItemIsSelected Source #

Arguments

:: (HasCallStack, MonadIO m)
=> OptionMenuItem	`item`: a `OptionMenuItem`
-> m Bool	Returns: `True` if the `item` is selected or `False` otherwise.

Whether a OptionMenuItem is the currently selected one.

Since: 2.18