Struct gtk4::EntryBuilder

pub struct EntryBuilder { /* fields omitted */ }

A builder-pattern type to construct Entry objects.

Implementations

impl EntryBuilder

pub fn new() -> Self

Create a new EntryBuilder.

pub fn build(self) -> Entry

Build the Entry.

pub fn activates_default(self, activates_default: bool) -> Self

Whether to activate the default widget when Enter is pressed.

pub fn attributes(self, attributes: &AttrList) -> Self

A list of Pango attributes to apply to the text of the entry.

This is mainly useful to change the size or weight of the text.

The PangoAttribute’s start_index and end_index must refer to the EntryBuffer text, i.e. without the preedit string.

pub fn buffer<P: IsA<EntryBuffer>>(self, buffer: &P) -> Self

The buffer object which actually stores the text.

pub fn completion(self, completion: &EntryCompletion) -> Self

The auxiliary completion object to use with the entry.

pub fn enable_emoji_completion(self, enable_emoji_completion: bool) -> Self

Whether to suggest Emoji replacements for :-delimited names like :heart:.

pub fn extra_menu<P: IsA<MenuModel>>(self, extra_menu: &P) -> Self

A menu model whose contents will be appended to the context menu.

pub fn has_frame(self, has_frame: bool) -> Self

Whehter the entry should draw a frame.

pub fn im_module(self, im_module: &str) -> Self

Which IM (input method) module should be used for this entry.

See IMContext.

Setting this to a non-None value overrides the system-wide IM module setting. See the GtkSettings property::Settings::gtk-im-module property.

pub fn input_hints(self, input_hints: InputHints) -> Self

Additional hints that allow input methods to fine-tune their behavior.

Also see property::Entry::input-purpose

pub fn input_purpose(self, input_purpose: InputPurpose) -> Self

The purpose of this text field.

This property can be used by on-screen keyboards and other input methods to adjust their behaviour.

Note that setting the purpose to InputPurpose::Password or InputPurpose::Pin is independent from setting property::Entry::visibility.

pub fn invisible_char(self, invisible_char: u32) -> Self

The character to use when masking entry contents (“password mode”).

pub fn invisible_char_set(self, invisible_char_set: bool) -> Self

Whether the invisible char has been set for the Entry.

pub fn max_length(self, max_length: i32) -> Self

Maximum number of characters for this entry.

pub fn overwrite_mode(self, overwrite_mode: bool) -> Self

If text is overwritten when typing in the Entry.

pub fn placeholder_text(self, placeholder_text: &str) -> Self

The text that will be displayed in the Entry when it is empty and unfocused.

pub fn primary_icon_activatable(self, primary_icon_activatable: bool) -> Self

Whether the primary icon is activatable.

GTK emits the signal::Entry::icon-press and signal::Entry::icon-release signals only on sensitive, activatable icons.

Sensitive, but non-activatable icons can be used for purely informational purposes.

pub fn primary_icon_gicon<P: IsA<Icon>>(self, primary_icon_gicon: &P) -> Self

The GIcon to use for the primary icon for the entry.

pub fn primary_icon_name(self, primary_icon_name: &str) -> Self

The icon name to use for the primary icon for the entry.

pub fn primary_icon_paintable<P: IsA<Paintable>>(
    self,
    primary_icon_paintable: &P
) -> Self

A gdk::Paintable to use as the primary icon for the entry.

pub fn primary_icon_sensitive(self, primary_icon_sensitive: bool) -> Self

Whether the primary icon is sensitive.

An insensitive icon appears grayed out. GTK does not emit the signal::Entry::icon-press and signal::Entry::icon-release signals and does not allow DND from insensitive icons.

An icon should be set insensitive if the action that would trigger when clicked is currently not available.

pub fn primary_icon_tooltip_markup(
    self,
    primary_icon_tooltip_markup: &str
) -> Self

The contents of the tooltip on the primary icon, with markup.

Also see EntryExt::set_icon_tooltip_markup().

pub fn primary_icon_tooltip_text(self, primary_icon_tooltip_text: &str) -> Self

The contents of the tooltip on the primary icon.

Also see EntryExt::set_icon_tooltip_text().

pub fn progress_fraction(self, progress_fraction: f64) -> Self

The current fraction of the task that’s been completed.

pub fn progress_pulse_step(self, progress_pulse_step: f64) -> Self

The fraction of total entry width to move the progress bouncing block for each pulse.

See EntryExt::progress_pulse().

pub fn secondary_icon_activatable(
    self,
    secondary_icon_activatable: bool
) -> Self

Whether the secondary icon is activatable.

GTK emits the signal::Entry::icon-press and signal::Entry::icon-release signals only on sensitive, activatable icons.

Sensitive, but non-activatable icons can be used for purely informational purposes.

pub fn secondary_icon_gicon<P: IsA<Icon>>(
    self,
    secondary_icon_gicon: &P
) -> Self

The GIcon to use for the secondary icon for the entry.

pub fn secondary_icon_name(self, secondary_icon_name: &str) -> Self

The icon name to use for the secondary icon for the entry.

pub fn secondary_icon_paintable<P: IsA<Paintable>>(
    self,
    secondary_icon_paintable: &P
) -> Self

A gdk::Paintable to use as the secondary icon for the entry.

pub fn secondary_icon_sensitive(self, secondary_icon_sensitive: bool) -> Self

Whether the secondary icon is sensitive.

An insensitive icon appears grayed out. GTK does not emit the signal::Entry::icon-press[ and signal::Entry::icon-release signals and does not allow DND from insensitive icons.

An icon should be set insensitive if the action that would trigger when clicked is currently not available.

pub fn secondary_icon_tooltip_markup(
    self,
    secondary_icon_tooltip_markup: &str
) -> Self

The contents of the tooltip on the secondary icon, with markup.

Also see EntryExt::set_icon_tooltip_markup().

pub fn secondary_icon_tooltip_text(
    self,
    secondary_icon_tooltip_text: &str
) -> Self

The contents of the tooltip on the secondary icon.

Also see EntryExt::set_icon_tooltip_text().

pub fn show_emoji_icon(self, show_emoji_icon: bool) -> Self

pub fn tabs(self, tabs: &TabArray) -> Self

pub fn truncate_multiline(self, truncate_multiline: bool) -> Self

When true, pasted multi-line text is truncated to the first line.

pub fn visibility(self, visibility: bool) -> Self

Whether the entry should show the “invisible char” instead of the actual text (“password mode”).

pub fn can_focus(self, can_focus: bool) -> Self

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.

pub fn can_target(self, can_target: bool) -> Self

Whether the widget can receive pointer events.

pub fn css_classes(self, css_classes: Vec<String>) -> Self

A list of css classes applied to this widget.

pub fn css_name(self, css_name: &str) -> Self

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.

pub fn cursor(self, cursor: &Cursor) -> Self

The cursor used by widget.

pub fn focus_on_click(self, focus_on_click: bool) -> Self

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

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

pub fn focusable(self, focusable: bool) -> Self

Whether this widget itself will accept the input focus.

pub fn halign(self, halign: Align) -> Self

How to distribute horizontal space if widget gets extra space.

pub fn has_tooltip(self, has_tooltip: bool) -> Self

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

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

pub fn height_request(self, height_request: i32) -> Self

Override for height request of the widget.

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

pub fn hexpand(self, hexpand: bool) -> Self

Whether to expand horizontally.

pub fn hexpand_set(self, hexpand_set: bool) -> Self

Whether to use the hexpand property.

pub fn layout_manager<P: IsA<LayoutManager>>(self, layout_manager: &P) -> Self

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.

pub fn margin_bottom(self, margin_bottom: i32) -> Self

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.

pub fn margin_end(self, margin_end: i32) -> Self

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.

pub fn margin_start(self, margin_start: i32) -> Self

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.

pub fn margin_top(self, margin_top: i32) -> Self

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.

pub fn name(self, name: &str) -> Self

The name of the widget.

pub fn opacity(self, opacity: f64) -> Self

The requested opacity of the widget.

pub fn overflow(self, overflow: Overflow) -> Self

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.

pub fn receives_default(self, receives_default: bool) -> Self

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

pub fn sensitive(self, sensitive: bool) -> Self

Whether the widget responds to input.

pub fn tooltip_markup(self, tooltip_markup: &str) -> Self

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 None: property::Widget::has-tooltip will automatically be set to true and there will be taken care of signal::Widget::query-tooltip in the default signal handler.

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

pub fn tooltip_text(self, tooltip_text: &str) -> Self

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 None: property::Widget::has-tooltip will automatically be set to true and there will be taken care of signal::Widget::query-tooltip in the default signal handler.

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

pub fn valign(self, valign: Align) -> Self

How to distribute vertical space if widget gets extra space.

pub fn vexpand(self, vexpand: bool) -> Self

Whether to expand vertically.

pub fn vexpand_set(self, vexpand_set: bool) -> Self

Whether to use the vexpand property.

pub fn visible(self, visible: bool) -> Self

Whether the widget is visible.

pub fn width_request(self, width_request: i32) -> Self

Override for width request of the widget.

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

pub fn accessible_role(self, accessible_role: AccessibleRole) -> Self

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

pub fn editing_canceled(self, editing_canceled: bool) -> Self

Indicates whether editing on the cell has been canceled.

pub fn editable(self, editable: bool) -> Self

Whether the entry contents can be edited.

pub fn enable_undo(self, enable_undo: bool) -> Self

If undo/redo should be enabled for the editable.

pub fn max_width_chars(self, max_width_chars: i32) -> Self

The desired maximum width of the entry, in characters.

pub fn text(self, text: &str) -> Self

The contents of the entry.

pub fn width_chars(self, width_chars: i32) -> Self

Number of characters to leave space for in the entry.

pub fn xalign(self, xalign: f32) -> Self

The horizontal alignment, from 0 (left) to 1 (right).

Reversed for RTL layouts.

Trait Implementations

impl Clone for EntryBuilder

fn clone(&self) -> EntryBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for EntryBuilder

fn default() -> EntryBuilder

Returns the “default value” for a type.