Struct gtk4::EditableLabel

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

A EditableLabel is a label that allows users to edit the text by switching to an “edit mode”.

EditableLabel does not have API of its own, but it implements the Editable interface.

The default bindings for activating the edit mode is to click or press the Enter key. The default bindings for leaving the edit mode are the Enter key (to save the results) or the Escape key (to cancel the editing).

CSS nodes

editablelabel[.editing]
╰── stack
    ├── label
    ╰── text

EditableLabel has a main node with the name editablelabel. When the entry is in editing mode, it gets the .editing style class.

For all the subnodes added to the text node in various situations, see Text.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, EditableExt, WidgetExtManual, AccessibleExtManual, EditableExtManual

Implementations

impl EditableLabel

pub fn new(str: &str) -> EditableLabel

Creates a new EditableLabel widget.

str

the text for the label

Returns

the new EditableLabel

pub fn builder() -> EditableLabelBuilder

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

This method returns an instance of EditableLabelBuilder which can be used to create EditableLabel objects.

pub fn is_editing(&self) -> bool

Returns whether the label is currently in “editing mode”.

Returns

true if @self is currently in editing mode

pub fn start_editing(&self)

Switches the label into “editing mode”.

pub fn stop_editing(&self, commit: bool)

Switches the label out of “editing mode”.

If @commit is true, the resulting text is kept as the property::Editable::text property value, otherwise the resulting text is discarded and the label will keep its previous property::Editable::text property value.

commit

whether to set the edited text on the label

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

Trait Implementations

impl Clone for EditableLabel

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 EditableLabel

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

Formats the value using the given formatter.

impl Default for EditableLabel

fn default() -> Self

Returns the “default value” for a type.

impl Display for EditableLabel

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

Formats the value using the given formatter.

impl Hash for EditableLabel

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 EditableLabel

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 EditableLabel

type Parent = Widget

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

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 EditableLabel

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 EditableLabel

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for EditableLabel

impl IsA<Accessible> for EditableLabel

impl IsA<Buildable> for EditableLabel

impl IsA<ConstraintTarget> for EditableLabel

impl IsA<Editable> for EditableLabel

impl IsA<Widget> for EditableLabel