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 |
Represents the dropdown menu of a select
element in a WebView
.
When a select element in a WebView
needs to display a dropdown menu, the signal
WebView::showOptionMenu is emitted, providing a WebKitOptionMenu with the
OptionMenuItem
s that should be displayed.
Since: 2.18
Synopsis
- newtype OptionMenu = OptionMenu (ManagedPtr OptionMenu)
- class (GObject o, IsDescendantOf OptionMenu o) => IsOptionMenu o
- toOptionMenu :: (MonadIO m, IsOptionMenu o) => o -> m OptionMenu
- optionMenuActivateItem :: (HasCallStack, MonadIO m, IsOptionMenu a) => a -> Word32 -> m ()
- optionMenuClose :: (HasCallStack, MonadIO m, IsOptionMenu a) => a -> m ()
- optionMenuGetEvent :: (HasCallStack, MonadIO m, IsOptionMenu a) => a -> m Event
- optionMenuGetItem :: (HasCallStack, MonadIO m, IsOptionMenu a) => a -> Word32 -> m OptionMenuItem
- optionMenuGetNItems :: (HasCallStack, MonadIO m, IsOptionMenu a) => a -> m Word32
- optionMenuSelectItem :: (HasCallStack, MonadIO m, IsOptionMenu a) => a -> Word32 -> m ()
- type OptionMenuCloseCallback = IO ()
- afterOptionMenuClose :: (IsOptionMenu a, MonadIO m) => a -> ((?self :: a) => OptionMenuCloseCallback) -> m SignalHandlerId
- onOptionMenuClose :: (IsOptionMenu a, MonadIO m) => a -> ((?self :: a) => OptionMenuCloseCallback) -> m SignalHandlerId
Exported types
newtype OptionMenu Source #
Memory-managed wrapper type.
OptionMenu (ManagedPtr OptionMenu) |
Instances
Eq OptionMenu Source # | |
Defined in GI.WebKit.Objects.OptionMenu (==) :: OptionMenu -> OptionMenu -> Bool # (/=) :: OptionMenu -> OptionMenu -> Bool # | |
GObject OptionMenu Source # | |
Defined in GI.WebKit.Objects.OptionMenu | |
ManagedPtrNewtype OptionMenu Source # | |
Defined in GI.WebKit.Objects.OptionMenu toManagedPtr :: OptionMenu -> ManagedPtr OptionMenu | |
TypedObject OptionMenu Source # | |
Defined in GI.WebKit.Objects.OptionMenu | |
HasParentTypes OptionMenu Source # | |
Defined in GI.WebKit.Objects.OptionMenu | |
IsGValue (Maybe OptionMenu) Source # | Convert |
Defined in GI.WebKit.Objects.OptionMenu gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe OptionMenu -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe OptionMenu) | |
type ParentTypes OptionMenu Source # | |
Defined in GI.WebKit.Objects.OptionMenu type ParentTypes OptionMenu = '[Object] |
class (GObject o, IsDescendantOf OptionMenu o) => IsOptionMenu o Source #
Type class for types which can be safely cast to OptionMenu
, for instance with toOptionMenu
.
Instances
(GObject o, IsDescendantOf OptionMenu o) => IsOptionMenu o Source # | |
Defined in GI.WebKit.Objects.OptionMenu |
toOptionMenu :: (MonadIO m, IsOptionMenu o) => o -> m OptionMenu Source #
Cast to OptionMenu
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Click to display all available methods, including inherited ones
Methods
activateItem, bindProperty, bindPropertyFull, close, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, selectItem, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getEvent, getItem, getNItems, getProperty, getQdata.
Setters
activateItem
optionMenuActivateItem Source #
:: (HasCallStack, MonadIO m, IsOptionMenu a) | |
=> a |
|
-> Word32 |
|
-> m () |
Activates the OptionMenuItem
at index
in menu
.
Activating an item changes the value
of the element making the item the active one. You are expected to close the menu with
optionMenuClose
after activating an item, calling this function again will have no
effect.
Since: 2.18
close
:: (HasCallStack, MonadIO m, IsOptionMenu a) | |
=> a |
|
-> m () |
Request to close a OptionMenu
.
This emits WebKitOptionMenuclose signal.
This function should always be called to notify WebKit that the associated
menu has been closed. If the menu is closed and neither optionMenuSelectItem
nor optionMenuActivateItem
have been called, the element value remains
unchanged.
Since: 2.18
getEvent
:: (HasCallStack, MonadIO m, IsOptionMenu a) | |
=> a |
|
-> m Event | Returns: the menu event or |
getItem
:: (HasCallStack, MonadIO m, IsOptionMenu a) | |
=> a |
|
-> Word32 |
|
-> m OptionMenuItem | Returns: a |
Returns the OptionMenuItem
at index
in menu
.
Since: 2.18
getNItems
:: (HasCallStack, MonadIO m, IsOptionMenu a) | |
=> a |
|
-> m Word32 | Returns: the number of |
Gets the length of the menu
.
Since: 2.18
selectItem
:: (HasCallStack, MonadIO m, IsOptionMenu a) | |
=> a |
|
-> Word32 |
|
-> m () |
Selects the OptionMenuItem
at index
in menu
.
Selecting an item changes the
text shown by the combo button, but it doesn't change the value of the element. You need to
explicitly activate the item with optionMenuSelectItem
or close the menu with
optionMenuClose
in which case the currently selected item will be activated.
Since: 2.18
Signals
close
type OptionMenuCloseCallback = IO () Source #
Emitted when closing a OptionMenu
is requested. This can happen
when the user explicitly calls optionMenuClose
or when the
element is detached from the current page.
Since: 2.18
afterOptionMenuClose :: (IsOptionMenu a, MonadIO m) => a -> ((?self :: a) => OptionMenuCloseCallback) -> m SignalHandlerId Source #
Connect a signal handler for the close signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
optionMenu #close callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onOptionMenuClose :: (IsOptionMenu a, MonadIO m) => a -> ((?self :: a) => OptionMenuCloseCallback) -> m SignalHandlerId Source #
Connect a signal handler for the close signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
optionMenu #close callback