Struct webkit6::ColorChooserRequest

pub struct ColorChooserRequest { /* private fields */ }

A request to open a color chooser.

Whenever the user interacts with an 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 #GtkColorChooser (which might be not desirable in some cases, which could prefer to use their own color chooser dialog), WebKit will fire the #WebKitWebView::run-color-chooser signal with a #WebKitColorChooserRequest 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 #GtkColorChooserDialog for the user to interact with.

Properties

rgba

The #GdkRGBA color of the request

Readable | Writeable | Construct

Signals

finished

Emitted when the @request finishes. This signal can be emitted because the user completed the @request calling webkit_color_chooser_request_finish(), or cancelled it with webkit_color_chooser_request_cancel() or because the color input element is removed from the DOM.

GLib type: GObject with reference counted clone semantics.

Implementations

impl ColorChooserRequest

pub fn cancel(&self)

Cancels @self and the input element changes to use the initial color.

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

pub fn finish(&self)

Finishes @self and the input element keeps the current value of #WebKitColorChooserRequest:rgba.

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

pub fn element_rectangle(&self) -> Rectangle

Gets the bounding box of the color input element.

Returns

rect

a #GdkRectangle to fill in with the element area

pub fn rgba(&self) -> RGBA

Gets the current #GdkRGBA color of @self

Returns

rgba

a #GdkRGBA to fill in with the current color.

pub fn set_rgba(&self, rgba: &RGBA)

Sets the current #GdkRGBA color of @self

rgba

a pointer #GdkRGBA

pub fn connect_finished<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted when the @request finishes. This signal can be emitted because the user completed the @request calling webkit_color_chooser_request_finish(), or cancelled it with webkit_color_chooser_request_cancel() or because the color input element is removed from the DOM.

pub fn connect_rgba_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for ColorChooserRequest

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ColorChooserRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for ColorChooserRequest

type ParamSpec = ParamSpecObject

type SetValue = ColorChooserRequest

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, ColorChooserRequest>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ColorChooserRequest

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ColorChooserRequest

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for ColorChooserRequest

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for ColorChooserRequest

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for ColorChooserRequest

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ColorChooserRequest

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ColorChooserRequest