Struct ColorChooserWidget

Source

pub struct ColorChooserWidget { /* private fields */ }

👎Deprecated: Since 4.10

Expand description

Direct use of ColorChooserWidget is deprecated. The ColorChooserWidget widget lets the user select a color.

By default, the chooser presents a predefined palette of colors, plus a small number of settable custom colors. It is also possible to select a different color with the single-color editor.

To enter the single-color editing mode, use the context menu of any color of the palette, or use the ‘+’ button to add a new custom color.

The chooser automatically remembers the last selection, as well as custom colors.

To create a ColorChooserWidget, use new().

To change the initially selected color, use ColorChooserExt::set_rgba(). To get the selected color use ColorChooserExt::rgba().

The ColorChooserWidget is used in the ColorChooserDialog to provide a dialog for selecting colors.

§Actions

ColorChooserWidget defines a set of built-in actions:

color.customize activates the color editor for the given color.
color.select emits the color-activated signal for the given color.

§CSS names

ColorChooserWidget has a single CSS node with name colorchooser.

§Properties

§`show-editor`

true when the color chooser is showing the single-color editor.

It can be set to switch the color chooser into single-color editing mode.

Readable | Writeable

Widget

§`can-focus`

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

§`can-target`

Whether the widget can receive pointer events.

Readable | Writeable

§`css-classes`

A list of css classes applied to this widget.

Readable | Writeable

§`css-name`

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

§`cursor`

The cursor used by @widget.

Readable | Writeable

§`focus-on-click`

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

§`focusable`

Whether this widget itself will accept the input focus.

Readable | Writeable

§`halign`

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

§`has-default`

Whether the widget is the default widget.

Readable

§`has-focus`

Whether the widget has the input focus.

Readable

§`has-tooltip`

Enables or disables the emission of the query-tooltip signal on @widget.

A true value indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

§`height-request`

Overrides for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

§`hexpand`

Whether to expand horizontally.

Readable | Writeable

§`hexpand-set`

Whether to use the hexpand property.

Readable | Writeable

§`layout-manager`

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

§`margin-bottom`

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

§`margin-end`

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

§`margin-start`

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

§`margin-top`

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

§`name`

The name of the widget.

Readable | Writeable

§`opacity`

The requested opacity of the widget.

Readable | Writeable

§`overflow`

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

§`parent`

The parent widget of this widget.

Readable

§`receives-default`

Whether the widget will receive the default action when it is focused.

Readable | Writeable

§`root`

The Root widget of the widget tree containing this widget.

This will be NULL if the widget is not contained in a root widget.

Readable

§`scale-factor`

The scale factor of the widget.

Readable

§`sensitive`

Whether the widget responds to input.

Readable | Writeable

§`tooltip-markup`

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

§`tooltip-text`

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

§`valign`

How to distribute vertical space if widget gets extra space.

Readable | Writeable

§`vexpand`

Whether to expand vertically.

Readable | Writeable

§`vexpand-set`

Whether to use the vexpand property.

Readable | Writeable

§`visible`

Whether the widget is visible.

Readable | Writeable

§`width-request`

Overrides for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

§`accessible-role`

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

ColorChooser

§`rgba`

The currently selected color, as a gdk::RGBA struct.

The property can be set to change the current selection programmatically.

Readable | Writeable

§`use-alpha`

Whether colors may have alpha (translucency).

When ::use-alpha is false, the gdk::RGBA struct obtained via the rgba property will be forced to have alpha == 1.

Implementations are expected to show alpha by rendering the color over a non-uniform background (like a checkerboard pattern).

Readable | Writeable

§Implements

WidgetExt, [trait@glib::ObjectExt], AccessibleExt, BuildableExt, ConstraintTargetExt, ColorChooserExt, WidgetExtManual, AccessibleExtManual, ColorChooserExtManual

GLib type: GObject with reference counted clone semantics.

Struct ColorChooserWidgetCopy item path

§Actions

§CSS names

§Properties

§show-editor

Widget

§can-focus

§can-target

§css-classes

§css-name

§cursor

§focus-on-click

§focusable

§halign

§has-default

§has-focus

§has-tooltip

§height-request

§hexpand

§hexpand-set

§layout-manager

§margin-bottom

§margin-end

§margin-start

§margin-top

§name

§opacity

§overflow

§parent

§receives-default

§root

§scale-factor

§sensitive

§tooltip-markup

§tooltip-text

§valign

§vexpand

§vexpand-set

§visible

§width-request

Accessible

§accessible-role

ColorChooser

§rgba

§use-alpha

§Implements

Implementations§

impl ColorChooserWidget

pub fn new() -> ColorChooserWidget

§Returns

pub fn builder() -> ColorChooserWidgetBuilder

pub fn shows_editor(&self) -> bool

pub fn set_show_editor(&self, show_editor: bool)

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

Trait Implementations§

impl Clone for ColorChooserWidget

fn clone(&self) -> Self

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

impl Debug for ColorChooserWidget

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

impl Default for ColorChooserWidget

fn default() -> Self

impl HasParamSpec for ColorChooserWidget

type ParamSpec = ParamSpecObject

type SetValue = ColorChooserWidget

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ColorChooserWidget

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

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

impl Ord for ColorChooserWidget

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

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

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

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

impl ParentClassIs for ColorChooserWidget

type Parent = Widget

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

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

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

Struct ColorChooserWidget

§`show-editor`

§`can-focus`

§`can-target`

§`css-classes`

§`css-name`

§`cursor`

§`focus-on-click`

§`focusable`

§`halign`

§`has-default`

§`has-focus`

§`has-tooltip`

§`height-request`

§`hexpand`

§`hexpand-set`

§`layout-manager`

§`margin-bottom`

§`margin-end`

§`margin-start`

§`margin-top`

§`name`

§`opacity`

§`overflow`

§`parent`

§`receives-default`

§`root`

§`scale-factor`

§`sensitive`

§`tooltip-markup`

§`tooltip-text`

§`valign`

§`vexpand`

§`vexpand-set`

§`visible`

§`width-request`

§`accessible-role`

§`rgba`

§`use-alpha`

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

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

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

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

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

impl<O> AccessibleExt for O
where O: IsA<Accessible>,

impl<O> AccessibleExtManual for O
where O: IsA<Accessible>,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<O> BuildableExt for O
where O: IsA<Buildable>,

impl<T> Cast for T
where T: ObjectType,

fn upcast<T>(self) -> T
where T: ObjectType, Self: IsA<T>,

fn upcast_ref<T>(&self) -> &T
where T: ObjectType, Self: IsA<T>,

fn downcast<T>(self) -> Result<T, Self>
where T: ObjectType, Self: MayDowncastTo<T>,

fn downcast_ref<T>(&self) -> Option<&T>
where T: ObjectType, Self: MayDowncastTo<T>,

fn dynamic_cast<T>(self) -> Result<T, Self>
where T: ObjectType,

fn dynamic_cast_ref<T>(&self) -> Option<&T>
where T: ObjectType,

unsafe fn unsafe_cast<T>(self) -> T
where T: ObjectType,

unsafe fn unsafe_cast_ref<T>(&self) -> &T
where T: ObjectType,

impl<T> CloneToUninit for T
where T: Clone,

impl<O> ColorChooserExt for O
where O: IsA<ColorChooser>,