GI.WebKit2.Objects.ColorChooserRequest

A request to open a color chooser.

Whenever the user interacts with an <input type='color' /> HTML element, WebKit will need to show a dialog to choose a color. For that to happen in a general way, instead of just opening a ColorChooser (which might be not desirable in some cases, which could prefer to use their own color chooser dialog), WebKit will fire the WebView::runColorChooser signal with a ColorChooserRequest object, which will allow the client application to specify the color to be selected, to inspect the details of the request (e.g. to get initial color) and to cancel the request, in case nothing was selected.

In case the client application does not wish to handle this signal, WebKit will provide a default handler which will asynchronously run a regular ColorChooserDialog for the user to interact with.

Exported types

newtype ColorChooserRequest

Memory-managed wrapper type.

Constructors

ColorChooserRequest (ManagedPtr ColorChooserRequest)

Instances

Eq ColorChooserRequest

Defined in GI.WebKit2.Objects.ColorChooserRequest

Methods

(==) :: ColorChooserRequest -> ColorChooserRequest -> Bool

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

GObject ColorChooserRequest

Defined in GI.WebKit2.Objects.ColorChooserRequest

ManagedPtrNewtype ColorChooserRequest

Defined in GI.WebKit2.Objects.ColorChooserRequest

Methods

toManagedPtr :: ColorChooserRequest -> ManagedPtr ColorChooserRequest

TypedObject ColorChooserRequest

Defined in GI.WebKit2.Objects.ColorChooserRequest

Methods

glibType :: IO GType

HasParentTypes ColorChooserRequest

Defined in GI.WebKit2.Objects.ColorChooserRequest

IsGValue (Maybe ColorChooserRequest)

Convert ColorChooserRequest to and from GValue. See toGValue and fromGValue.

Defined in GI.WebKit2.Objects.ColorChooserRequest

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ColorChooserRequest -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ColorChooserRequest)

type ParentTypes ColorChooserRequest

Defined in GI.WebKit2.Objects.ColorChooserRequest

type ParentTypes ColorChooserRequest = '[Object]

class (GObject o, IsDescendantOf ColorChooserRequest o) => IsColorChooserRequest o

Type class for types which can be safely cast to ColorChooserRequest, for instance with toColorChooserRequest.

Instances

(GObject o, IsDescendantOf ColorChooserRequest o) => IsColorChooserRequest o

Defined in GI.WebKit2.Objects.ColorChooserRequest

toColorChooserRequest :: (MonadIO m, IsColorChooserRequest o) => o -> m ColorChooserRequest

Cast to ColorChooserRequest, 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

bindProperty, bindPropertyFull, cancel, finish, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getElementRectangle, getProperty, getQdata, getRgba.

Setters

setData, setDataFull, setProperty, setRgba.

cancel

colorChooserRequestCancel

Arguments

:: (HasCallStack, MonadIO m, IsColorChooserRequest a)

=> a

request: a ColorChooserRequest

-> m ()

Cancels request and the input element changes to use the initial color.

Cancels request and the input element changes to use the initial color it has before the request started. The signal ColorChooserRequest::finished is emitted to notify that the request has finished.

Since: 2.8

finish

colorChooserRequestFinish

Arguments

:: (HasCallStack, MonadIO m, IsColorChooserRequest a)

=> a

request: a ColorChooserRequest

-> m ()

Finishes request and the input element keeps the current value of ColorChooserRequest:rgba.

Finishes request and the input element keeps the current value of ColorChooserRequest:rgba. The signal ColorChooserRequest::finished is emitted to notify that the request has finished.

Since: 2.8

getElementRectangle

colorChooserRequestGetElementRectangle

Arguments

:: (HasCallStack, MonadIO m, IsColorChooserRequest a)

=> a

request: a ColorChooserRequest

-> m Rectangle

Gets the bounding box of the color input element.

Since: 2.8

getRgba

colorChooserRequestGetRgba

Arguments

:: (HasCallStack, MonadIO m, IsColorChooserRequest a)

=> a

request: a ColorChooserRequest

-> m RGBA

Gets the current RGBA color of request

Since: 2.8

setRgba

colorChooserRequestSetRgba

Arguments

:: (HasCallStack, MonadIO m, IsColorChooserRequest a)

=> a

request: a FileChooserRequest

-> RGBA

rgba: a pointer RGBA

-> m ()

Sets the current RGBA color of request

Since: 2.8

Properties

rgba

The RGBA color of the request

Since: 2.8

constructColorChooserRequestRgba :: (IsColorChooserRequest o, MonadIO m) => RGBA -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “rgba” property. This is rarely needed directly, but it is used by new.

getColorChooserRequestRgba :: (MonadIO m, IsColorChooserRequest o) => o -> m (Maybe RGBA)

Get the value of the “rgba” property. When overloading is enabled, this is equivalent to

get colorChooserRequest #rgba

setColorChooserRequestRgba :: (MonadIO m, IsColorChooserRequest o) => o -> RGBA -> m ()

Set the value of the “rgba” property. When overloading is enabled, this is equivalent to

set colorChooserRequest [ #rgba := value ]

Signals

finished

type ColorChooserRequestFinishedCallback = IO ()

Emitted when the request finishes. This signal can be emitted because the user completed the request calling colorChooserRequestFinish, or cancelled it with colorChooserRequestCancel or because the color input element is removed from the DOM.

Since: 2.8

afterColorChooserRequestFinished :: (IsColorChooserRequest a, MonadIO m) => a -> ((?self :: a) => ColorChooserRequestFinishedCallback) -> m SignalHandlerId

Connect a signal handler for the finished signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after colorChooserRequest #finished 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.

onColorChooserRequestFinished :: (IsColorChooserRequest a, MonadIO m) => a -> ((?self :: a) => ColorChooserRequestFinishedCallback) -> m SignalHandlerId

Connect a signal handler for the finished signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on colorChooserRequest #finished callback