Struct gtk4::Entry

source ·

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

Expand description

Entry is a single line text entry widget.

An example GtkEntry

A fairly large set of key bindings are supported by default. If the entered text is longer than the allocation of the widget, the widget will scroll so that the cursor position is visible.

When using an entry for passwords and other sensitive information, it can be put into “password mode” using EntryExt::set_visibility(). In this mode, entered text is displayed using a “invisible” character. By default, GTK picks the best invisible character that is available in the current font, but it can be changed with EntryExt::set_invisible_char().

Entry has the ability to display progress or activity information behind the text. To make an entry display such information, use EntryExt::set_progress_fraction() or EntryExt::set_progress_pulse_step().

Additionally, Entry can show icons at either side of the entry. These icons can be activatable by clicking, can be set up as drag source and can have tooltips. To add an icon, use EntryExt::set_icon_from_gicon() or one of the various other functions that set an icon from an icon name or a paintable. To trigger an action when the user clicks an icon, connect to the icon-press signal. To allow DND operations from an icon, use EntryExt::set_icon_drag_source(). To set a tooltip on an icon, use EntryExt::set_icon_tooltip_text() or the corresponding function for markup.

Note that functionality or information that is only available by clicking on an icon in an entry may not be accessible at all to users which are not able to use a mouse or other pointing device. It is therefore recommended that any such functionality should also be available by other means, e.g. via the context menu of the entry.

CSS nodes

entry[.flat][.warning][.error]
├── text[.readonly]
├── image.left
├── image.right
╰── [progress[.pulse]]

Entry has a main node with the name entry. Depending on the properties of the entry, the style classes .read-only and .flat may appear. The style classes .warning and .error may also be used with entries.

When the entry shows icons, it adds subnodes with the name image and the style class .left or .right, depending on where the icon appears.

When the entry shows progress, it adds a subnode with the name progress. The node has the style class .pulse when the shown progress is pulsing.

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

GtkEntry as GtkBuildable

The Entry implementation of the Buildable interface supports a custom <attributes> element, which supports any number of <attribute> elements. The <attribute> element has attributes named “name“, “value“, “start“ and “end“ and allows you to specify PangoAttribute values for this label.

An example of a UI definition fragment specifying Pango attributes:

<object class="GtkEntry">
  <attributes>
    <attribute name="weight" value="PANGO_WEIGHT_BOLD"/>
    <attribute name="background" value="red" start="5" end="10"/>
  </attributes>
</object>

The start and end attributes specify the range of characters to which the Pango attribute applies. If start and end are not specified, the attribute is applied to the whole text. Note that specifying ranges does not make much sense with translatable attributes. Use markup embedded in the translatable content instead.

Accessibility

Entry uses the AccessibleRole::TextBox role.

Properties

`activates-default`

Whether to activate the default widget when Enter is pressed.

Readable | Writeable

`attributes`

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.

Readable | Writeable

`buffer`

The buffer object which actually stores the text.

Readable | Writeable | Construct

`completion`

The auxiliary completion object to use with the entry.

Readable | Writeable

`enable-emoji-completion`

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

Readable | Writeable

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

Readable | Writeable

`has-frame`

Whether the entry should draw a frame.

Readable | Writeable

`im-module`

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 gtk-im-module property.

Readable | Writeable

`input-hints`

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

Also see input-purpose

Readable | Writeable

`input-purpose`

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 visibility.

Readable | Writeable

`invisible-char`

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

Readable | Writeable

`invisible-char-set`

Whether the invisible char has been set for the Entry.

Readable | Writeable

`max-length`

Maximum number of characters for this entry.

Readable | Writeable

`overwrite-mode`

If text is overwritten when typing in the Entry.

Readable | Writeable

`placeholder-text`

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

Readable | Writeable

`primary-icon-activatable`

Whether the primary icon is activatable.

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

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

Readable | Writeable

`primary-icon-gicon`

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

Readable | Writeable

`primary-icon-name`

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

Readable | Writeable

`primary-icon-paintable`

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

Readable | Writeable

`primary-icon-sensitive`

Whether the primary icon is sensitive.

An insensitive icon appears grayed out. GTK does not emit the icon-press and 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.

Readable | Writeable

`primary-icon-storage-type`

The representation which is used for the primary icon of the entry.

Readable

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

Also see EntryExt::set_icon_tooltip_markup().

Readable | Writeable

The contents of the tooltip on the primary icon.

Also see EntryExt::set_icon_tooltip_text().

Readable | Writeable

`progress-fraction`

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

Readable | Writeable

`progress-pulse-step`

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

See EntryExt::progress_pulse().

Readable | Writeable

`scroll-offset`

Number of pixels of the entry scrolled off the screen to the left.

Readable

`secondary-icon-activatable`

Whether the secondary icon is activatable.

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

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

Readable | Writeable

`secondary-icon-gicon`

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

Readable | Writeable

`secondary-icon-name`

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

Readable | Writeable

`secondary-icon-paintable`

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

Readable | Writeable

`secondary-icon-sensitive`

Whether the secondary icon is sensitive.

An insensitive icon appears grayed out. GTK does not emit the icon-press[ and 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.

Readable | Writeable

`secondary-icon-storage-type`

The representation which is used for the secondary icon of the entry.

Readable

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

Also see EntryExt::set_icon_tooltip_markup().

Readable | Writeable

The contents of the tooltip on the secondary icon.

Also see EntryExt::set_icon_tooltip_text().

Readable | Writeable

`show-emoji-icon`

Readable | Writeable

`tabs`

Readable | Writeable

`text-length`

The length of the text in the Entry.

Readable

`truncate-multiline`

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

Readable | Writeable

`visibility`

Whether the entry should show the “invisible char” instead of the actual text (“password 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

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 query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

`height-request`

Override 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 None 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

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: 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

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: 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`

Override 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

CellEditable

`editing-canceled`

Indicates whether editing on the cell has been canceled.

Readable | Writeable

Editable

`cursor-position`

The current position of the insertion cursor in chars.

Readable

`editable`

Whether the entry contents can be edited.

Readable | Writeable

`enable-undo`

If undo/redo should be enabled for the editable.

Readable | Writeable

`max-width-chars`

The desired maximum width of the entry, in characters.

Readable | Writeable

`selection-bound`

The position of the opposite end of the selection from the cursor in chars.

Readable

`text`

The contents of the entry.

Readable | Writeable

`width-chars`

Number of characters to leave space for in the entry.

Readable | Writeable

`xalign`

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

Reversed for RTL layouts.

Readable | Writeable

Signals

`activate`

Emitted when the entry is activated.

The keybindings for this signal are all forms of the Enter key.

Action

`icon-press`

Emitted when an activatable icon is clicked.

`icon-release`

Emitted on the button release from a mouse click over an activatable icon.

Widget

`destroy`

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

`direction-changed`

Emitted when the text direction of a widget changes.

`hide`

Emitted when @widget is hidden.

`keynav-failed`

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

`map`

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

`mnemonic-activate`

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

`move-focus`

Emitted when the focus is moved.

Action

Emitted when the widgets tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

`realize`

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

`show`

Emitted when @widget is shown.

`state-flags-changed`

Emitted when the widget state changes.

See WidgetExt::state_flags().

`unmap`

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

`unrealize`

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

CellEditable

`editing-done`

This signal is a sign for the cell renderer to update its value from the @cell_editable.

Implementations of CellEditable are responsible for emitting this signal when they are done editing, e.g. Entry emits this signal when the user presses Enter. Typical things to do in a handler for ::editing-done are to capture the edited value, disconnect the @cell_editable from signals on the CellRenderer, etc.

gtk_cell_editable_editing_done() is a convenience method for emitting GtkCellEditable::editing-done.

This signal is meant to indicate that the cell is finished editing, and the @cell_editable widget is being removed and may subsequently be destroyed.

Implementations of CellEditable are responsible for emitting this signal when they are done editing. It must be emitted after the GtkCellEditable::editing-done signal, to give the cell renderer a chance to update the cell’s value before the widget is removed.

gtk_cell_editable_remove_widget() is a convenience method for emitting GtkCellEditable::remove-widget.

Editable

`changed`

Emitted at the end of a single user-visible operation on the contents.

E.g., a paste operation that replaces the contents of the selection will cause only one signal emission (even though it is implemented by first deleting the selection, then inserting the new content, and may cause multiple ::notify::text signals to be emitted).

`delete-text`

Emitted when text is deleted from the widget by the user.

The default handler for this signal will normally be responsible for deleting the text, so by connecting to this signal and then stopping the signal with g_signal_stop_emission(), it is possible to modify the range of deleted text, or prevent it from being deleted entirely.

The @start_pos and @end_pos parameters are interpreted as for EditableExt::delete_text().

`insert-text`

Emitted when text is inserted into the widget by the user.

The default handler for this signal will normally be responsible for inserting the text, so by connecting to this signal and then stopping the signal with g_signal_stop_emission(), it is possible to modify the inserted text, or prevent it from being inserted entirely.

Implements

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

Struct gtk4::Entry

Widget

Accessible

CellEditable

Editable

Widget

CellEditable

Editable

Implementations§

impl Entry

pub const NONE: Option<&'static Entry> = None

pub fn new() -> Entry

pub fn with_buffer(buffer: &impl IsA<EntryBuffer>) -> Entry

pub fn builder() -> EntryBuilder

Trait Implementations§

impl Clone for Entry

fn clone(&self) -> Self

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

impl Debug for Entry

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

impl Default for Entry

fn default() -> Self

impl Display for Entry

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

impl HasParamSpec for Entry

type ParamSpec = ParamSpecObject

type SetValue = Entry

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

fn param_spec_builder() -> Self::BuilderFn