Struct gtk4::ColorButton

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

The ColorButton allows to open a color chooser dialog to change the color.

It is suitable widget for selecting a color in a preference dialog.

CSS nodes

colorbutton
╰── button.color
    ╰── [content]

ColorButton has a single CSS node with name colorbutton which contains a button node. To differentiate it from a plain Button, it gets the .color style class.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, ColorChooserExt, WidgetExtManual, AccessibleExtManual, ColorChooserExtManual

Implementations

impl ColorButton

pub fn new() -> ColorButton

Creates a new color button.

This returns a widget in the form of a small button containing a swatch representing the current selected color. When the button is clicked, a color chooser dialog will open, allowing the user to select a color. The swatch will be updated to reflect the new color when the user finishes.

Returns

a new color button

pub fn with_rgba(rgba: &RGBA) -> ColorButton

Creates a new color button showing the given color.

rgba

A gdk::RGBA to set the current color with

Returns

a new color button

pub fn builder() -> ColorButtonBuilder

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

This method returns an instance of ColorButtonBuilder which can be used to create ColorButton objects.

pub fn is_modal(&self) -> bool

Gets whether the dialog is modal.

Returns

true if the dialog is modal

pub fn title(&self) -> GString

Gets the title of the color chooser dialog.

Returns

An internal string, do not free the return value

pub fn set_modal(&self, modal: bool)

Sets whether the dialog should be modal.

modal

true to make the dialog modal

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

Sets the title for the color chooser dialog.

title

String containing new window title

pub fn shows_editor(&self) -> bool

Whether the color chooser should open in editor mode.

This property should be used in cases where the palette in the editor would be redundant, such as when the color button is already part of a palette.

pub fn set_show_editor(&self, show_editor: bool)

Whether the color chooser should open in editor mode.

This property should be used in cases where the palette in the editor would be redundant, such as when the color button is already part of a palette.

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

Available on crate feature v4_4 only.

Emitted to when the color button is activated.

The ::activate signal on MenuButton is an action signal and emitting it causes the button to pop up its dialog.

pub fn emit_activate(&self)

Available on crate feature v4_4 only.

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

Emitted when the user selects a color.

When handling this signal, use ColorChooserExt::rgba() to find out which color was just selected.

Note that this signal is only emitted when the user changes the color. If you need to react to programmatic color changes as well, use the notify::rgba signal.

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

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

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

Trait Implementations

impl Clone for ColorButton

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 ColorButton

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

Formats the value using the given formatter.

impl Default for ColorButton

fn default() -> Self

Returns the “default value” for a type.

impl Display for ColorButton

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

Formats the value using the given formatter.

impl Hash for ColorButton

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 ColorButton

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 ColorButton

type Parent = Widget

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

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 ColorButton

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 ColorButton

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ColorButton

impl IsA<Accessible> for ColorButton

impl IsA<Buildable> for ColorButton

impl IsA<ColorChooser> for ColorButton

impl IsA<ConstraintTarget> for ColorButton

impl IsA<Widget> for ColorButton