Struct gtk4::ColorDialog

#[repr(transparent)]
pub struct ColorDialog { /* private fields */ }

Available on crate feature v4_10 only.

A ColorDialog object collects the arguments that are needed to present a color chooser dialog to the user, such as a title for the dialog and whether it should be modal.

The dialog is shown with the choose_rgba() function. This API follows the GIO async pattern, and the result can be obtained by calling Gtk::ColorDialog::choose_rgba_finish().

See ColorDialogButton for a convenient control that uses ColorDialog and presents the results.

Properties

modal

Whether the color chooser dialog is modal.

Readable | Writeable

title

A title that may be shown on the color chooser dialog that is presented by ColorDialog::choose_rgba().

Readable | Writeable

with-alpha

Whether colors may have alpha (translucency).

When with-alpha is false, the color that is selected will be forced to have alpha == 1.

Readable | Writeable

Implements

glib::ObjectExt

Implementations

impl ColorDialog

pub fn new() -> ColorDialog

Creates a new ColorDialog object.

Returns

the new ColorDialog

pub fn builder() -> ColorDialogBuilder

Creates a new builder-pattern struct instance to construct ColorDialog objects.

This method returns an instance of ColorDialogBuilder which can be used to create ColorDialog objects.

pub fn choose_rgba<P: FnOnce(Result<RGBA, Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, initial_color: Option<&RGBA>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

This function initiates a color choice operation by presenting a color chooser dialog to the user.

The @callback will be called when the dialog is dismissed. It should call Gtk::ColorDialog::choose_rgba_finish() to obtain the result.

parent

the parent Window

initial_color

the color to select initially

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn choose_rgba_future( &self, parent: Option<&(impl IsA<Window> + Clone + 'static)>, initial_color: Option<&RGBA> ) -> Pin<Box_<dyn Future<Output = Result<RGBA, Error>> + 'static>>

pub fn is_modal(&self) -> bool

Returns whether the color chooser dialog blocks interaction with the parent window while it is presented.

Returns

TRUE if the color chooser dialog is modal

pub fn title(&self) -> GString

Returns the title that will be shown on the color chooser dialog.

Returns

the title

pub fn is_with_alpha(&self) -> bool

Returns whether colors may have alpha.

Returns

TRUE if colors may have alpha

pub fn set_modal(&self, modal: bool)

Sets whether the color chooser dialog blocks interaction with the parent window while it is presented.

modal

the new value

pub fn set_title(&self, title: &str)

Sets the title that will be shown on the color chooser dialog.

title

the new title

pub fn set_with_alpha(&self, with_alpha: bool)

Sets whether colors may have alpha.

with_alpha

the new value

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

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

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

Trait Implementations

impl Clone for ColorDialog

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColorDialog

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

Formats the value using the given formatter.

impl Default for ColorDialog

fn default() -> Self

Returns the “default value” for a type.

impl Display for ColorDialog

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

Formats the value using the given formatter.

impl HasParamSpec for ColorDialog

type ParamSpec = ParamSpecObject

type SetValue = ColorDialog

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ColorDialog

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

Feeds this value into the given Hasher.

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 ColorDialog

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for ColorDialog

type Parent = Object

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

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

This method tests for self and other values to be equal, and is used by ==.

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 ColorDialog

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

This method returns an ordering between self and other values if one exists.

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 ColorDialog

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ColorDialog