Entry
GtkEntry is a single line text entry widget.
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 method@Gtk.Entry.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 method@Gtk.Entry.set_invisible_char.
GtkEntry has the ability to display progress or activity information behind the text. To make an entry display such information, use method@Gtk.Entry.set_progress_fraction or method@Gtk.Entry.set_progress_pulse_step.
Additionally, GtkEntry 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 method@Gtk.Entry.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 signal@Gtk.Entry::icon-press signal. To allow DND operations from an icon, use method@Gtk.Entry.set_icon_drag_source. To set a tooltip on an icon, use method@Gtk.Entry.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]]GtkEntry 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 class@Gtk.Text.
GtkEntry as GtkBuildable
The GtkEntry implementation of the GtkBuildable interface supports a custom 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
GtkEntry uses the %GTK_ACCESSIBLE_ROLE_TEXT_BOX role.
Skipped during bindings generation
method
attributes: Property TypeInfo of getter and setter do not matchmethod
enable-emoji-completion: Property has no getter nor settermethod
im-module: Property has no getter nor settermethod
invisible-char-set: Property has no getter nor settermethod
primary-icon-activatable: Property has no getter nor settermethod
primary-icon-gicon: Property has no getter nor settermethod
primary-icon-name: Property has no getter nor settermethod
primary-icon-paintable: Property has no getter nor settermethod
primary-icon-sensitive: Property has no getter nor settermethod
primary-icon-storage-type: Property has no getter nor settermethod
primary-icon-tooltip-markup: Property has no getter nor settermethod
primary-icon-tooltip-text: Property has no getter nor settermethod
scroll-offset: Property has no getter nor settermethod
secondary-icon-activatable: Property has no getter nor settermethod
secondary-icon-gicon: Property has no getter nor settermethod
secondary-icon-name: Property has no getter nor settermethod
secondary-icon-paintable: Property has no getter nor settermethod
secondary-icon-sensitive: Property has no getter nor settermethod
secondary-icon-storage-type: Property has no getter nor settermethod
secondary-icon-tooltip-markup: Property has no getter nor settermethod
secondary-icon-tooltip-text: Property has no getter nor settermethod
show-emoji-icon: Property has no getter nor settermethod
truncate-multiline: Property has no getter nor setter
Constructors
Properties
The accessible role of the given GtkAccessible implementation.
Whether to activate the default widget when Enter is pressed.
The buffer object which actually stores the text.
The auxiliary completion object to use with the entry.
A list of css classes applied to this widget.
If undo/redo should be enabled for the editable.
Whether the widget should grab focus when it is clicked with the mouse.
Enables or disables the emission of the ::query-tooltip signal on @widget.
Whether to use the hexpand property.
Additional hints that allow input methods to fine-tune their behavior.
The purpose of this text field.
The character to use when masking entry contents (“password mode”).
The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.
Margin on bottom side of widget.
Margin on start of widget, horizontally.
The desired maximum width of the entry, in characters.
If text is overwritten when typing in the GtkEntry.
The text that will be displayed in the GtkEntry when it is empty and unfocused.
The current fraction of the task that's been completed.
The fraction of total entry width to move the progress bouncing block for each pulse.
Whether the widget will receive the default action when it is focused.
The scale factor of the widget.
The length of the text in the GtkEntry.
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Sets the text of tooltip to be the given string.
Whether to use the vexpand property.
Whether the entry should show the “invisible char” instead of the actual text (“password mode”).
Number of characters to leave space for in the entry.
Functions
Enable or disable an action installed with gtk_widget_class_install_action().
Looks up the action in the action groups associated with
Activates the default.activate action from @widget.
Adds @controller to @widget so that it will receive events.
Adds a style class to @widget.
Adds a widget to the list of mnemonic labels for this widget.
Queues an animation frame update and adds a callback to be called before each frame.
Called by widgets as the user moves around the window using keyboard shortcuts.
Computes the bounds for @widget in the coordinate space of @target.
Computes whether a container should give this widget extra space when possible.
Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system.
Computes a matrix suitable to describe a transformation from
Emitted when the entry is activated.
Emitted at the end of a single user-visible operation on the contents.
Emitted when text is deleted from the widget by the user.
Signals that all holders of a reference to the widget should release the reference that they hold.
Emitted when the text direction of a widget changes.
This signal is a sign for the cell renderer to update its value from the @cell_editable.
Emitted when @widget is hidden.
Emitted when an activatable icon is clicked.
Emitted on the button release from a mouse click over an activatable icon.
Emitted if keyboard navigation fails.
Emitted when @widget is going to be mapped.
Emitted when a widget is activated via a mnemonic.
Emitted when the focus is moved.
Emitted when @widget is associated with a GdkSurface.
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.
Emitted when @widget is shown.
Emitted when the widget state changes.
Emitted when @widget is going to be unmapped.
Emitted when the GdkSurface associated with @widget is destroyed.
Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.
Deletes the currently selected text of the editable.
Deletes a sequence of characters.
Emits the GtkCellEditable::editing-done signal.
Undoes the setup done by method@Gtk.Editable.init_delegate.
Retrieves the GtkAccessibleRole for the given GtkAccessible.
Retrieves the value set by gtk_entry_set_activates_default().
Gets the value set by gtk_entry_set_alignment().
Returns the baseline that has currently been allocated to @widget.
Returns the height that has currently been allocated to @widget.
Returns the width that has currently been allocated to @widget.
Gets the first ancestor of @widget with type @widget_type.
Gets the attribute list of the GtkEntry.
Get the GtkEntryBuffer object which holds the text for this widget.
Gets the ID of the @buildable object.
Determines whether the input focus can enter @widget or any of its children.
Queries whether @widget can be the target of pointer events.
Gets the value set with gtk_widget_set_child_visible().
Gets the clipboard object for @widget.
Returns the auxiliary completion object currently in use by @entry.
Returns the list of style classes applied to @widget.
Returns the CSS name that is used for @self.
Returns the index of the icon which is the source of the current DND operation, or -1.
Gets the GtkEditable that @editable is delegating its implementation to.
Gets the reading direction for a particular widget.
Get the GdkDisplay for the toplevel window associated with this widget.
Retrieves whether @editable is editable.
Gets if undo/redo actions are enabled for @editable
Gets the menu model set with gtk_entry_set_extra_menu().
Returns the widgets first child.
Determines whether @widget can own the input focus.
Returns the current focus child of @widget.
Returns whether the widget should grab focus when it is clicked with the mouse.
Gets the font map of @widget.
Obtains the frame clock for a widget.
Gets the value set by gtk_entry_set_has_frame().
Returns the current value of the has-tooltip property.
Gets whether the widget would like any available extra horizontal space.
Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget.
Returns whether the icon is activatable.
Gets the area where entry’s icon at @icon_pos is drawn.
Finds the icon at the given position and return its index.
Retrieves the GIcon used for the icon.
Retrieves the icon name used for the icon.
Retrieves the GdkPaintable used for the icon.
Returns whether the icon appears sensitive or insensitive.
Gets the type of representation being used by the icon to store image data.
Gets the contents of the tooltip on the icon at the specified position in @entry.
Gets the contents of the tooltip on the icon at the specified position in @entry.
Gets the input hints of this GtkEntry.
Gets the input purpose of the GtkEntry.
Retrieves the character displayed in place of the actual text in “password mode”.
Returns the widgets last child.
Retrieves the layout manager used by @widget.
Gets the bottom margin of @widget.
Gets the end margin of @widget.
Gets the start margin of @widget.
Gets the top margin of @widget.
Retrieves the maximum allowed length of the text in @entry.
Retrieves the desired maximum width of @editable, in characters.
Returns the widgets next sibling.
#Fetches the requested opacity for this widget.
Returns the widgets overflow value.
Gets whether the GtkEntry is in overwrite mode.
Retrieves the text that will be displayed when @entry is empty and unfocused
Retrieves the current position of the cursor relative to the start of the content of the editable.
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
Returns the widgets previous sibling.
Gets the primary clipboard of @widget.
Returns the current fraction of the task that’s been completed.
Retrieves the pulse step set with gtk_entry_set_progress_pulse_step().
Determines whether @widget is realized.
Determines whether @widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.
Returns the widget’s sensitivity.
Gets the settings object holding the settings used for this widget.
Returns the content width or height of the widget.
Returns the widget state as a flag set.
Returns the style context associated to @widget.
Fetch an object build from the template XML for @widget_type in this @widget instance.
Retrieves the current length of the text in @entry.
Gets the contents of the tooltip for @widget.
Gets the contents of the tooltip for @widget.
Gets whether the widget would like any available extra vertical space.
Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget.
Retrieves whether the text in @entry is visible.
Determines whether the widget is visible.
Gets the number of characters of space reserved for the contents of the editable.
Causes @entry to have keyboard focus.
Returns whether @css_class is currently applied to @widget.
Determines whether @widget is the current default widget within its toplevel.
Determines if the widget should show a visible indication that it has the global input focus.
Returns whether the widget is currently being destroyed.
Sets up a delegate for GtkEditable.
Creates and initializes child widgets defined in templates.
Inserts @group into @widget.
Inserts @widget into the child widget list of @parent.
Inserts @widget into the child widget list of @parent.
Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.
Determines whether @widget can be drawn to.
Returns the widget’s effective sensitivity.
Emits the ::keynav-failed signal on the widget.
Returns the widgets for which this widget is the target of a mnemonic.
Emits the ::mnemonic-activate signal.
Returns a GListModel to track the children of @widget.
Returns a GListModel to track the class@Gtk.EventControllers of @widget.
Indicates that some progress is made, but you don’t know how much.
Flags the widget for a rerun of the vfunc@Gtk.Widget.size_allocate function.
Flags a widget to have its size renegotiated.
Removes @controller from @widget, so that it doesn't process events anymore.
Removes a style from @widget.
Removes a widget from the list of mnemonic labels for this widget.
Removes a tick callback previously registered with gtk_widget_add_tick_callback().
Emits the GtkCellEditable::remove-widget signal.
Reset the input method context of the entry if needed.
Resets the accessible @property to its default value.
Resets the accessible @relation to its default value.
Resets the accessible @state to its default value.
Selects a region of text.
Sets whether pressing Enter in the @entry will activate the default widget for the window containing the entry.
Sets the alignment for the contents of the entry.
Sets a PangoAttrList.
Set the GtkEntryBuffer object which holds the text for this widget.
Specifies whether the input focus can enter the widget or any of its children.
Sets whether @widget can be the target of pointer events.
Sets whether @widget should be mapped along with its parent.
Sets @completion to be the auxiliary completion object to use with @entry.
Clear all style classes applied to @widget and replace them with @classes.
Sets a named cursor to be shown when pointer devices point towards @widget.
Sets the reading direction on a particular widget.
Determines if the user can edit the text in the editable widget.
If enabled, changes to @editable will be saved for undo/redo actions.
Sets a menu model to add when constructing the context menu for @entry.
Specifies whether @widget can own the input focus.
Set @child as the current focus child of @widget.
Sets whether the widget should grab focus when it is clicked with the mouse.
Sets the font map to use for Pango rendering.
Sets whether the entry has a beveled frame around it.
Sets the has-tooltip property on @widget to @has_tooltip.
Sets whether the widget would like any available extra horizontal space.
Sets whether the hexpand flag will be used.
Sets whether the icon is activatable.
Sets up the icon at the given position as drag source.
Sets the icon shown in the entry at the specified position from the current icon theme.
Sets the icon shown in the entry at the specified position from the current icon theme.
Sets the icon shown in the specified position using a GdkPaintable.
Sets the sensitivity for the specified icon.
Sets @tooltip as the contents of the tooltip for the icon at the specified position.
Sets @tooltip as the contents of the tooltip for the icon at the specified position.
Set additional hints which allow input methods to fine-tune their behavior.
Sets the input purpose which can be used by input methods to adjust their behavior.
Sets the character to use in place of the actual text in “password mode”.
Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of @widget.
Sets the bottom margin of @widget.
Sets the end margin of @widget.
Set all margins to the same value.
Set start and end margin to horizontal and top and bottom margin to vertical
Set margins.
Sets the start margin of @widget.
Sets the top margin of @widget.
Sets the maximum allowed length of the contents of the widget.
Sets the desired maximum width in characters of @editable.
Request the @widget to be rendered partially transparent.
Sets how @widget treats content that is drawn outside the widget's content area.
Sets whether the text is overwritten when typing in the GtkEntry.
Sets text to be displayed in @entry when it is empty.
Sets the cursor position in the editable to the given value.
Causes the entry’s progress indicator to “fill in” the given fraction of the bar.
Sets the fraction of total entry width to move the progress bouncing block for each pulse.
Specifies whether @widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
Sets the sensitivity of a widget.
Sets the minimum size of a widget.
Turns on flag values in the current widget state.
Sets @markup as the contents of the tooltip, which is marked up with Pango markup.
Sets @text as the contents of the tooltip.
Sets whether the widget would like any available extra vertical space.
Sets whether the vexpand flag will be used.
Sets whether the contents of the entry are visible or not.
Sets the visibility state of @widget.
Changes the size request of the editable to be about the right size for @n_chars characters.
Returns whether @widget should contribute to the measuring and allocation of its parent.
Begins editing on a @cell_editable.
Triggers a tooltip query on the display where the toplevel of @widget is located.
Unsets the invisible char, so that the default invisible char is used again. See method@Gtk.Entry.set_invisible_char.
Turns off flag values for the current widget state.