gtk.entry

Module for [Entry] class

class Entry EntryGidBuilder EntryGidBuilderImpl

Types 3

classEntry : gtk.widget.Widget, gtk.cell_editable.CellEditable, gtk.editable.Editable

The #GtkEntry widget 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 [gtk.entry.Entry.setVisibility]. 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 [gtk.entry.Entry.setInvisibleChar]. Since 2.16, GTK+ displays a warning when Caps Lock or input methods might interfere with entering text in a password entry. The warning can be turned off with the #GtkEntry:caps-lock-warning property.

Since 2.16, GtkEntry has the ability to display progress or activity information behind the text. To make an entry display such information, use [gtk.entry.Entry.setProgressFraction] or [gtk.entry.Entry.setProgressPulseStep].

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 [gtk.entry.Entry.setIconFromGicon] or one of the various other functions that set an icon from a stock id, an icon name or a pixbuf. To trigger an action when the user clicks an icon, connect to the #GtkEntry::icon-press signal. To allow DND operations from an icon, use [gtk.entry.Entry.setIconDragSource]. To set a tooltip on an icon, use [gtk.entry.Entry.setIconTooltipText] 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[.read-only][.flat][.warning][.error]
├── image.left
├── image.right
├── undershoot.left
├── undershoot.right
├── [selection]
├── [progress[.pulse]]
╰── [window.popup]

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 has a selection, it adds a subnode with the name selection.

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.

The CSS node for a context menu is added as a subnode below entry as well.

The undershoot nodes are used to draw the underflow indication when content is scrolled out of view. These nodes get the .left and .right style classes added depending on where the indication is drawn.

When touch is used and touch selection handles are shown, they are using CSS nodes with name cursor-handle. They get the .top or .bottom style class depending on where they are shown in relation to the selection. If there is just a single handle for the text cursor, it gets the style class .insertion-cursor.

Methods

GType _getGType()

GType _gType() @property

Entry self()Returns `this`, for use in `with` statements.

EntryGidBuilder builder()Get builder for [gtk.entry.Entry] Returns: New builder object

bool activatesDefault() @property

void activatesDefault(bool propval) @property

pango.attr_list.AttrList attributes() @propertyGet `attributes` property. Returns: A list of Pango attributes to apply to the text of the entry.

void attributes(pango.attr_list.AttrList propval) @propertySet `attributes` property. Params: propval = A list of Pango attributes to apply to the text of the entry.

gtk.entry_buffer.EntryBuffer buffer() @property

void buffer(gtk.entry_buffer.EntryBuffer propval) @property

bool capsLockWarning() @propertyGet `capsLockWarning` property. Returns: Whether password entries will show a warning when Caps Lock is on.

void capsLockWarning(bool propval) @propertySet `capsLockWarning` property. Params: propval = Whether password entries will show a warning when Caps Lock is on.

gtk.entry_completion.EntryCompletion completion() @propertyGet `completion` property. Returns: The auxiliary completion object to use with the entry.

void completion(gtk.entry_completion.EntryCompletion propval) @propertySet `completion` property. Params: propval = The auxiliary completion object to use with the entry.

int cursorPosition() @property

bool editable() @property

void editable(bool propval) @property

bool enableEmojiCompletion() @property

void enableEmojiCompletion(bool propval) @property

bool hasFrame() @property

void hasFrame(bool propval) @property

string imModule() @propertyGet `imModule` property. Returns: Which IM (input method) module should be used for this entry. See #GtkIMContext.

void imModule(string propval) @propertySet `imModule` property. Params: propval = Which IM (input method) module should be used for this entry. See #GtkIMContext.

gtk.border.Border innerBorder() @propertyGet `innerBorder` property. Returns: Sets the text area's border between the text and the frame.

void innerBorder(gtk.border.Border propval) @propertySet `innerBorder` property. Params: propval = Sets the text area's border between the text and the frame.

gtk.types.InputHints inputHints() @propertyGet `inputHints` property. Returns: Additional hints (beyond #GtkEntry:input-purpose) that allow input methods to fine-tune their behaviour.

void inputHints(gtk.types.InputHints propval) @propertySet `inputHints` property. Params: propval = Additional hints (beyond #GtkEntry:input-purpose) that allow input methods to fine-tune their behaviour.

gtk.types.InputPurpose inputPurpose() @propertyGet `inputPurpose` property. Returns: The purpose of this text field.

void inputPurpose(gtk.types.InputPurpose propval) @propertySet `inputPurpose` property. Params: propval = The purpose of this text field.

uint invisibleChar() @propertyGet `invisibleChar` property. Returns: The invisible character is used when masking entry contents (in \"password mode\")"). When it is not explicitly set with the #GtkEntry:invisible-char property...

void invisibleChar(uint propval) @propertySet `invisibleChar` property. Params: propval = The invisible character is used when masking entry contents (in \"password mode\")"). When it is not explicitly set with the #GtkEntry:invisible-char...

bool invisibleCharSet() @propertyGet `invisibleCharSet` property. Returns: Whether the invisible char has been set for the #GtkEntry.

void invisibleCharSet(bool propval) @propertySet `invisibleCharSet` property. Params: propval = Whether the invisible char has been set for the #GtkEntry.

int maxLength() @property

void maxLength(int propval) @property

int maxWidthChars() @propertyGet `maxWidthChars` property. Returns: The desired maximum width of the entry, in characters. If this property is set to -1, the width will be calculated automatically.

void maxWidthChars(int propval) @propertySet `maxWidthChars` property. Params: propval = The desired maximum width of the entry, in characters. If this property is set to -1, the width will be calculated automatically.

bool overwriteMode() @propertyGet `overwriteMode` property. Returns: If text is overwritten when typing in the #GtkEntry.

void overwriteMode(bool propval) @propertySet `overwriteMode` property. Params: propval = If text is overwritten when typing in the #GtkEntry.

string placeholderText() @propertyGet `placeholderText` property. Returns: The text that will be displayed in the #GtkEntry when it is empty and unfocused.

void placeholderText(string propval) @propertySet `placeholderText` property. Params: propval = The text that will be displayed in the #GtkEntry when it is empty and unfocused.

bool populateAll() @propertyGet `populateAll` property. Returns: If :populate-all is true, the #GtkEntry::populate-popup signal is also emitted for touch popups.

void populateAll(bool propval) @propertySet `populateAll` property. Params: propval = If :populate-all is true, the #GtkEntry::populate-popup signal is also emitted for touch popups.

bool primaryIconActivatable() @propertyGet `primaryIconActivatable` property. Returns: Whether the primary icon is activatable.

void primaryIconActivatable(bool propval) @propertySet `primaryIconActivatable` property. Params: propval = Whether the primary icon is activatable.

gio.icon.Icon primaryIconGicon() @propertyGet `primaryIconGicon` property. Returns: The #GIcon to use for the primary icon for the entry.

void primaryIconGicon(gio.icon.Icon propval) @propertySet `primaryIconGicon` property. Params: propval = The #GIcon to use for the primary icon for the entry.

string primaryIconName() @propertyGet `primaryIconName` property. Returns: The icon name to use for the primary icon for the entry.

void primaryIconName(string propval) @propertySet `primaryIconName` property. Params: propval = The icon name to use for the primary icon for the entry.

gdkpixbuf.pixbuf.Pixbuf primaryIconPixbuf() @propertyGet `primaryIconPixbuf` property. Returns: A pixbuf to use as the primary icon for the entry.

void primaryIconPixbuf(gdkpixbuf.pixbuf.Pixbuf propval) @propertySet `primaryIconPixbuf` property. Params: propval = A pixbuf to use as the primary icon for the entry.

bool primaryIconSensitive() @propertyGet `primaryIconSensitive` property. Returns: Whether the primary icon is sensitive.

void primaryIconSensitive(bool propval) @propertySet `primaryIconSensitive` property. Params: propval = Whether the primary icon is sensitive.

string primaryIconStock() @propertyGet `primaryIconStock` property. Returns: The stock id to use for the primary icon for the entry.

void primaryIconStock(string propval) @propertySet `primaryIconStock` property. Params: propval = The stock id to use for the primary icon for the entry.

gtk.types.ImageType primaryIconStorageType() @propertyGet `primaryIconStorageType` property. Returns: The representation which is used for the primary icon of the entry.

string primaryIconTooltipMarkup() @propertyGet `primaryIconTooltipMarkup` property. Returns: The contents of the tooltip on the primary icon, which is marked up with the [Pango text markup language][PangoMarkupFormat].

void primaryIconTooltipMarkup(string propval) @propertySet `primaryIconTooltipMarkup` property. Params: propval = The contents of the tooltip on the primary icon, which is marked up with the [Pango text markup language][PangoMarkupFormat].

string primaryIconTooltipText() @propertyGet `primaryIconTooltipText` property. Returns: The contents of the tooltip on the primary icon.

void primaryIconTooltipText(string propval) @propertySet `primaryIconTooltipText` property. Params: propval = The contents of the tooltip on the primary icon.

double progressFraction() @propertyGet `progressFraction` property. Returns: The current fraction of the task that's been completed.

void progressFraction(double propval) @propertySet `progressFraction` property. Params: propval = The current fraction of the task that's been completed.

double progressPulseStep() @propertyGet `progressPulseStep` property. Returns: The fraction of total entry width to move the progress bouncing block for each call to [gtk.entry.Entry.progressPulse].

void progressPulseStep(double propval) @propertySet `progressPulseStep` property. Params: propval = The fraction of total entry width to move the progress bouncing block for each call to [gtk.entry.Entry.progressPulse].

int scrollOffset() @property

bool secondaryIconActivatable() @propertyGet `secondaryIconActivatable` property. Returns: Whether the secondary icon is activatable.

void secondaryIconActivatable(bool propval) @propertySet `secondaryIconActivatable` property. Params: propval = Whether the secondary icon is activatable.

gio.icon.Icon secondaryIconGicon() @propertyGet `secondaryIconGicon` property. Returns: The #GIcon to use for the secondary icon for the entry.

void secondaryIconGicon(gio.icon.Icon propval) @propertySet `secondaryIconGicon` property. Params: propval = The #GIcon to use for the secondary icon for the entry.

string secondaryIconName() @propertyGet `secondaryIconName` property. Returns: The icon name to use for the secondary icon for the entry.

void secondaryIconName(string propval) @propertySet `secondaryIconName` property. Params: propval = The icon name to use for the secondary icon for the entry.

gdkpixbuf.pixbuf.Pixbuf secondaryIconPixbuf() @propertyGet `secondaryIconPixbuf` property. Returns: An pixbuf to use as the secondary icon for the entry.

void secondaryIconPixbuf(gdkpixbuf.pixbuf.Pixbuf propval) @propertySet `secondaryIconPixbuf` property. Params: propval = An pixbuf to use as the secondary icon for the entry.

bool secondaryIconSensitive() @propertyGet `secondaryIconSensitive` property. Returns: Whether the secondary icon is sensitive.

void secondaryIconSensitive(bool propval) @propertySet `secondaryIconSensitive` property. Params: propval = Whether the secondary icon is sensitive.

string secondaryIconStock() @propertyGet `secondaryIconStock` property. Returns: The stock id to use for the secondary icon for the entry.

void secondaryIconStock(string propval) @propertySet `secondaryIconStock` property. Params: propval = The stock id to use for the secondary icon for the entry.

gtk.types.ImageType secondaryIconStorageType() @propertyGet `secondaryIconStorageType` property. Returns: The representation which is used for the secondary icon of the entry.

string secondaryIconTooltipMarkup() @propertyGet `secondaryIconTooltipMarkup` property. Returns: The contents of the tooltip on the secondary icon, which is marked up with the [Pango text markup language][PangoMarkupFormat].

void secondaryIconTooltipMarkup(string propval) @propertySet `secondaryIconTooltipMarkup` property. Params: propval = The contents of the tooltip on the secondary icon, which is marked up with the [Pango text markup language][PangoMarkupFormat].

string secondaryIconTooltipText() @propertyGet `secondaryIconTooltipText` property. Returns: The contents of the tooltip on the secondary icon.

void secondaryIconTooltipText(string propval) @propertySet `secondaryIconTooltipText` property. Params: propval = The contents of the tooltip on the secondary icon.

int selectionBound() @property

gtk.types.ShadowType shadowType() @propertyGet `shadowType` property. Returns: Which kind of shadow to draw around the entry when #GtkEntry:has-frame is set to true.

void shadowType(gtk.types.ShadowType propval) @propertySet `shadowType` property. Params: propval = Which kind of shadow to draw around the entry when #GtkEntry:has-frame is set to true.

bool showEmojiIcon() @property

void showEmojiIcon(bool propval) @property

pango.tab_array.TabArray tabs() @property

void tabs(pango.tab_array.TabArray propval) @property

string text() @property

void text(string propval) @property

uint textLength() @propertyGet `textLength` property. Returns: The length of the text in the #GtkEntry.

bool truncateMultiline() @propertyGet `truncateMultiline` property. Returns: When true, pasted multi-line text is truncated to the first line.

void truncateMultiline(bool propval) @propertySet `truncateMultiline` property. Params: propval = When true, pasted multi-line text is truncated to the first line.

bool visibility() @property

void visibility(bool propval) @property

int widthChars() @property

void widthChars(int propval) @property

float xalign() @propertyGet `xalign` property. Returns: The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.

void xalign(float propval) @propertySet `xalign` property. Params: propval = The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.

gtk.entry.Entry newWithBuffer(gtk.entry_buffer.EntryBuffer buffer)Creates a new entry with the specified text buffer.

bool getActivatesDefault()Retrieves the value set by [gtk.entry.Entry.setActivatesDefault]. Returns: true if the entry will activate the default widget

float getAlignment()Gets the value set by [gtk.entry.Entry.setAlignment]. Returns: the alignment

pango.attr_list.AttrList getAttributes()Gets the attribute list that was set on the entry using [gtk.entry.Entry.setAttributes], if any. Returns: the attribute list, or null if none was set.

gtk.entry_buffer.EntryBuffer getBuffer()Get the #GtkEntryBuffer object which holds the text for this widget. Returns: A #GtkEntryBuffer object.

gtk.entry_completion.EntryCompletion getCompletion()Returns the auxiliary completion object currently in use by entry. Returns: The auxiliary completion object currently in use by entry.

int getCurrentIconDragSource()Returns the index of the icon which is the source of the current DND operation, or -1.

gtk.adjustment.Adjustment getCursorHadjustment()Retrieves the horizontal cursor adjustment for the entry. See [gtk.entry.Entry.setCursorHadjustment]. Returns: the horizontal cursor adjustment, or null if none has been set.

bool getHasFrame()Gets the value set by [gtk.entry.Entry.setHasFrame]. Returns: whether the entry has a beveled frame

bool getIconActivatable(gtk.types.EntryIconPosition iconPos)Returns whether the icon is activatable.

void getIconArea(gtk.types.EntryIconPosition iconPos, out gdk.rectangle.Rectangle iconArea)Gets the area where entry’s icon at icon_pos is drawn. This function is useful when drawing something to the entry in a draw callback.

int getIconAtPos(int x, int y)Finds the icon at the given position and return its index. The position’s coordinates are relative to the entry’s top left corner. If `x`, `y` doesn’t lie inside an icon, -1 is returned. This...

gio.icon.Icon getIconGicon(gtk.types.EntryIconPosition iconPos)Retrieves the #GIcon used for the icon, or null if there is no icon or if the icon was set by some other method (e.g., by stock, pixbuf, or icon name).

string getIconName(gtk.types.EntryIconPosition iconPos)Retrieves the icon name used for the icon, or null if there is no icon or if the icon was set by some other method (e.g., by pixbuf, stock or gicon).

gdkpixbuf.pixbuf.Pixbuf getIconPixbuf(gtk.types.EntryIconPosition iconPos)Retrieves the image used for the icon.

bool getIconSensitive(gtk.types.EntryIconPosition iconPos)Returns whether the icon appears sensitive or insensitive.

string getIconStock(gtk.types.EntryIconPosition iconPos)Retrieves the stock id used for the icon, or null if there is no icon or if the icon was set by some other method (e.g., by pixbuf, icon name or gicon).

gtk.types.ImageType getIconStorageType(gtk.types.EntryIconPosition iconPos)Gets the type of representation being used by the icon to store image data. If the icon has no image data, the return value will be [gtk.types.ImageType.Empty].

string getIconTooltipMarkup(gtk.types.EntryIconPosition iconPos)Gets the contents of the tooltip on the icon at the specified position in entry.

string getIconTooltipText(gtk.types.EntryIconPosition iconPos)Gets the contents of the tooltip on the icon at the specified position in entry.

gtk.border.Border getInnerBorder()This function returns the entry’s #GtkEntry:inner-border property. See [gtk.entry.Entry.setInnerBorder] for more information. Returns: the entry’s #GtkBorder, or null if none was set.

gtk.types.InputHints getInputHints()Gets the value of the #GtkEntry:input-hints property. Returns:

gtk.types.InputPurpose getInputPurpose()Gets the value of the #GtkEntry:input-purpose property. Returns:

dchar getInvisibleChar()Retrieves the character displayed in place of the real characters for entries with visibility set to false. See [gtk.entry.Entry.setInvisibleChar]. Returns: the current invisible char, or 0, if the...

pango.layout.Layout getLayout()Gets the #PangoLayout used to display the entry. The layout is useful to e.g. convert text positions to pixel positions, in combination with [gtk.entry.Entry.getLayoutOffsets]. The returned layout ...

void getLayoutOffsets(out int x, out int y)Obtains the position of the #PangoLayout used to render text in the entry, in widget coordinates. Useful if you want to line up the text in an entry with some other text, e.g. when using the entry ...

int getMaxLength()Retrieves the maximum allowed length of the text in entry. See [gtk.entry.Entry.setMaxLength].

int getMaxWidthChars()Retrieves the desired maximum width of entry, in characters. See [gtk.entry.Entry.setMaxWidthChars]. Returns: the maximum width of the entry, in characters

bool getOverwriteMode()Gets the value set by [gtk.entry.Entry.setOverwriteMode]. Returns: whether the text is overwritten when typing.

string getPlaceholderText()Retrieves the text that will be displayed when entry is empty and unfocused Returns: a pointer to the placeholder text as a string. This string points to internally allocated storage in the widget ...

double getProgressFraction()Returns the current fraction of the task that’s been completed. See [gtk.entry.Entry.setProgressFraction]. Returns: a fraction from 0.0 to 1.0

double getProgressPulseStep()Retrieves the pulse step set with [gtk.entry.Entry.setProgressPulseStep]. Returns: a fraction from 0.0 to 1.0

pango.tab_array.TabArray getTabs()Gets the tabstops that were set on the entry using [gtk.entry.Entry.setTabs], if any. Returns: the tabstops, or null if none was set.

string getText()Retrieves the contents of the entry widget. See also [gtk.editable.Editable.getChars].

void getTextArea(out gdk.rectangle.Rectangle textArea)Gets the area where the entry’s text is drawn. This function is useful when drawing something to the entry in a draw callback.

ushort getTextLength()Retrieves the current length of the text in entry.

bool getVisibility()Retrieves whether the text in entry is visible. See [gtk.entry.Entry.setVisibility]. Returns: true if the text is currently visible

int getWidthChars()Gets the value set by [gtk.entry.Entry.setWidthChars]. Returns: number of chars to request space for, or negative if unset

void grabFocusWithoutSelecting()Causes entry to have keyboard focus.

bool imContextFilterKeypress(gdk.event_key.EventKey event)Allow the #GtkEntry input method to internally handle key press and release events. If this function returns true, then no further processing should be done for this key event. See [gtk.imcontext.I...

int layoutIndexToTextIndex(int layoutIndex)Converts from a position in the entry’s #PangoLayout (returned by [gtk.entry.Entry.getLayout]) to a position in the entry contents (returned by [gtk.entry.Entry.getText]).

void progressPulse()Indicates that some progress is made, but you don’t know how much. Causes the entry’s progress indicator to enter “activity mode,” where a block bounces back and forth. Each call to [gtk.en...

void resetImContext()Reset the input method context of the entry if needed.

void setActivatesDefault(bool setting)If setting is true, pressing Enter in the entry will activate the default widget for the window containing the entry. This usually means that the dialog box containing the entry will be closed, sin...

void setAlignment(float xalign)Sets the alignment for the contents of the entry. This controls the horizontal positioning of the contents when the displayed text is shorter than the width of the entry.

void setAttributes(pango.attr_list.AttrList attrs)Sets a #PangoAttrList; the attributes in the list are applied to the entry text.

void setBuffer(gtk.entry_buffer.EntryBuffer buffer)Set the #GtkEntryBuffer object which holds the text for this widget.

void setCompletion(gtk.entry_completion.EntryCompletion completion = null)Sets completion to be the auxiliary completion object to use with entry. All further configuration of the completion mechanism is done on completion using the #GtkEntryCompletion API. Completion is...

void setCursorHadjustment(gtk.adjustment.Adjustment adjustment = null)Hooks up an adjustment to the cursor position in an entry, so that when the cursor is moved, the adjustment is scrolled to show that position. See [gtk.scrolled_window.ScrolledWindow.getHadjustment...

void setHasFrame(bool setting)Sets whether the entry has a beveled frame around it.

void setIconActivatable(gtk.types.EntryIconPosition iconPos, bool activatable)Sets whether the icon is activatable.

void setIconDragSource(gtk.types.EntryIconPosition iconPos,  gtk.target_list.TargetList targetList,  gdk.types.DragAction actions)

Sets up the icon at the given position so that GTK+ will start a drag operation when the user clicks and drags the icon.

void setIconFromGicon(gtk.types.EntryIconPosition iconPos, gio.icon.Icon icon = null)Sets the icon shown in the entry at the specified position from the current icon theme. If the icon isn’t known, a “broken image” icon will be displayed instead.

void setIconFromIconName(gtk.types.EntryIconPosition iconPos, string iconName = null)Sets the icon shown in the entry at the specified position from the current icon theme.

void setIconFromPixbuf(gtk.types.EntryIconPosition iconPos, gdkpixbuf.pixbuf.Pixbuf pixbuf = null)Sets the icon shown in the specified position using a pixbuf.

void setIconFromStock(gtk.types.EntryIconPosition iconPos, string stockId = null)Sets the icon shown in the entry at the specified position from a stock image.

void setIconSensitive(gtk.types.EntryIconPosition iconPos, bool sensitive)Sets the sensitivity for the specified icon.

void setIconTooltipMarkup(gtk.types.EntryIconPosition iconPos, string tooltip = null)Sets tooltip as the contents of the tooltip for the icon at the specified position. tooltip is assumed to be marked up with the [Pango text markup language][PangoMarkupFormat].

void setIconTooltipText(gtk.types.EntryIconPosition iconPos, string tooltip = null)Sets tooltip as the contents of the tooltip for the icon at the specified position.

void setInnerBorder(gtk.border.Border border)Sets `entry`’s inner-border property to border, or clears it if null is passed. The inner-border is the area around the entry’s text, but inside its frame.

void setInputHints(gtk.types.InputHints hints)Sets the #GtkEntry:input-hints property, which allows input methods to fine-tune their behaviour.

void setInputPurpose(gtk.types.InputPurpose purpose)Sets the #GtkEntry:input-purpose property which can be used by on-screen keyboards and other input methods to adjust their behaviour.

void setInvisibleChar(dchar ch)Sets the character to use in place of the actual text when [gtk.entry.Entry.setVisibility] has been called to set text visibility to false. i.e. this is the character used in “password mode” to...

void setMaxLength(int max)Sets the maximum allowed length of the contents of the widget. If the current contents are longer than the given length, then they will be truncated to fit.

void setMaxWidthChars(int nChars)Sets the desired maximum width in characters of entry.

void setOverwriteMode(bool overwrite)Sets whether the text is overwritten when typing in the #GtkEntry.

void setPlaceholderText(string text = null)Sets text to be displayed in entry when it is empty and unfocused. This can be used to give a visual hint of the expected contents of the #GtkEntry.

void setProgressFraction(double fraction)Causes the entry’s progress indicator to “fill in” the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive.

void setProgressPulseStep(double fraction)Sets the fraction of total entry width to move the progress bouncing block for each call to [gtk.entry.Entry.progressPulse].

void setTabs(pango.tab_array.TabArray tabs)Sets a #PangoTabArray; the tabstops in the array are applied to the entry text.

void setText(string text)Sets the text in the widget to the given value, replacing the current contents.

void setVisibility(bool visible)Sets whether the contents of the entry are visible or not. When visibility is set to false, characters are displayed as the invisible char, and will also appear that way when the text in the entry ...

void setWidthChars(int nChars)Changes the size request of the entry to be about the right size for nchars characters. Note that it changes the size request, the size can still be affected by how you pack the widget into contain...

int textIndexToLayoutIndex(int textIndex)Converts from a position in the entry contents (returned by [gtk.entry.Entry.getText]) to a position in the entry’s #PangoLayout (returned by [gtk.entry.Entry.getLayout], with text retrieved via ...

void unsetInvisibleChar()Unsets the invisible char previously set with [gtk.entry.Entry.setInvisibleChar]. So that the default invisible char is used again.

gulong connectActivate(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.entry.Entry)))
   &&  Parameters!T.length <  2)

Connect to `Activate` signal.

gulong connectBackspace(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.entry.Entry)))
   &&  Parameters!T.length <  2)

Connect to `Backspace` signal.

gulong connectCopyClipboard(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.entry.Entry)))
   &&  Parameters!T.length <  2)

Connect to `CopyClipboard` signal.

gulong connectCutClipboard(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.entry.Entry)))
   &&  Parameters!T.length <  2)

Connect to `CutClipboard` signal.

gulong connectDeleteFromCursor(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  gtk.types.DeleteType)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  int)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  gtk.entry.Entry)))
   &&  Parameters!T.length <  4)

Connect to `DeleteFromCursor` signal.

gulong connectIconPress(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  gtk.types.EntryIconPosition)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  gdk.event.Event)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  gtk.entry.Entry)))
   &&  Parameters!T.length <  4)

Connect to `IconPress` signal.

gulong connectIconRelease(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  gtk.types.EntryIconPosition)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  gdk.event.Event)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  gtk.entry.Entry)))
   &&  Parameters!T.length <  4)

Connect to `IconRelease` signal.

gulong connectInsertAtCursor(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  string)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  gtk.entry.Entry)))
   &&  Parameters!T.length <  3)

Connect to `InsertAtCursor` signal.

gulong connectInsertEmoji(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.entry.Entry)))
   &&  Parameters!T.length <  2)

Connect to `InsertEmoji` signal.

gulong connectMoveCursor(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  gtk.types.MovementStep)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  int)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2]  ==  bool)))
   && (Parameters!T.length <  4 || (ParameterStorageClassTuple!T[3]  ==  ParameterStorageClass.none &&  is(Parameters!T[3] :  gtk.entry.Entry)))
   &&  Parameters!T.length <  5)

Connect to `MoveCursor` signal.

gulong connectPasteClipboard(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.entry.Entry)))
   &&  Parameters!T.length <  2)

Connect to `PasteClipboard` signal.

gulong connectPopulatePopup(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.widget.Widget)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  gtk.entry.Entry)))
   &&  Parameters!T.length <  3)

Connect to `PopulatePopup` signal.

gulong connectPreeditChanged(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  string)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  gtk.entry.Entry)))
   &&  Parameters!T.length <  3)

Connect to `PreeditChanged` signal.

gulong connectToggleOverwrite(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.entry.Entry)))
   &&  Parameters!T.length <  2)

Connect to `ToggleOverwrite` signal.

Constructors

this(void * ptr, Flag!"Take" take)

this()Creates a new entry. Returns: a new #GtkEntry.

classEntryGidBuilderImpl(T) : gtk.widget.WidgetGidBuilderImpl!T, gtk.cell_editable.CellEditableGidBuilderImpl!T, gtk.editable.EditableGidBuilderImpl!T

Methods

T activatesDefault(bool propval)

T attributes(pango.attr_list.AttrList propval)Set `attributes` property. Params: propval = A list of Pango attributes to apply to the text of the entry.

T buffer(gtk.entry_buffer.EntryBuffer propval)

T capsLockWarning(bool propval)Set `capsLockWarning` property. Params: propval = Whether password entries will show a warning when Caps Lock is on.

T completion(gtk.entry_completion.EntryCompletion propval)Set `completion` property. Params: propval = The auxiliary completion object to use with the entry. Returns: Builder instance for fluent chaining

T editable(bool propval)

T enableEmojiCompletion(bool propval)

T hasFrame(bool propval)

T imModule(string propval)Set `imModule` property. Params: propval = Which IM (input method) module should be used for this entry. See #GtkIMContext.

T innerBorder(gtk.border.Border propval)Set `innerBorder` property. Params: propval = Sets the text area's border between the text and the frame. Returns: Builder instance for fluent chaining

T inputHints(gtk.types.InputHints propval)Set `inputHints` property. Params: propval = Additional hints (beyond #GtkEntry:input-purpose) that allow input methods to fine-tune their behaviour. Returns: Builder instance for fluent chaining

T inputPurpose(gtk.types.InputPurpose propval)Set `inputPurpose` property. Params: propval = The purpose of this text field.

T invisibleChar(uint propval)Set `invisibleChar` property. Params: propval = The invisible character is used when masking entry contents (in \"password mode\")"). When it is not explicitly set with the #GtkEntry:invisible-char...

T invisibleCharSet(bool propval)Set `invisibleCharSet` property. Params: propval = Whether the invisible char has been set for the #GtkEntry. Returns: Builder instance for fluent chaining

T maxLength(int propval)

T maxWidthChars(int propval)Set `maxWidthChars` property. Params: propval = The desired maximum width of the entry, in characters. If this property is set to -1, the width will be calculated automatically. Returns: Builder in...

T overwriteMode(bool propval)Set `overwriteMode` property. Params: propval = If text is overwritten when typing in the #GtkEntry. Returns: Builder instance for fluent chaining

T placeholderText(string propval)Set `placeholderText` property. Params: propval = The text that will be displayed in the #GtkEntry when it is empty and unfocused. Returns: Builder instance for fluent chaining

T populateAll(bool propval)Set `populateAll` property. Params: propval = If :populate-all is true, the #GtkEntry::populate-popup signal is also emitted for touch popups. Returns: Builder instance for fluent chaining

T primaryIconActivatable(bool propval)Set `primaryIconActivatable` property. Params: propval = Whether the primary icon is activatable.

T primaryIconGicon(gio.icon.Icon propval)Set `primaryIconGicon` property. Params: propval = The #GIcon to use for the primary icon for the entry. Returns: Builder instance for fluent chaining

T primaryIconName(string propval)Set `primaryIconName` property. Params: propval = The icon name to use for the primary icon for the entry. Returns: Builder instance for fluent chaining

T primaryIconPixbuf(gdkpixbuf.pixbuf.Pixbuf propval)Set `primaryIconPixbuf` property. Params: propval = A pixbuf to use as the primary icon for the entry. Returns: Builder instance for fluent chaining

T primaryIconSensitive(bool propval)Set `primaryIconSensitive` property. Params: propval = Whether the primary icon is sensitive.

T primaryIconStock(string propval)Set `primaryIconStock` property. Params: propval = The stock id to use for the primary icon for the entry. Returns: Builder instance for fluent chaining

T primaryIconTooltipMarkup(string propval)Set `primaryIconTooltipMarkup` property. Params: propval = The contents of the tooltip on the primary icon, which is marked up with the [Pango text markup language][PangoMarkupFormat].

T primaryIconTooltipText(string propval)Set `primaryIconTooltipText` property. Params: propval = The contents of the tooltip on the primary icon.

T progressFraction(double propval)Set `progressFraction` property. Params: propval = The current fraction of the task that's been completed. Returns: Builder instance for fluent chaining

T progressPulseStep(double propval)Set `progressPulseStep` property. Params: propval = The fraction of total entry width to move the progress bouncing block for each call to [gtk.entry.Entry.progressPulse]. Returns: Builder instance...

T secondaryIconActivatable(bool propval)Set `secondaryIconActivatable` property. Params: propval = Whether the secondary icon is activatable.

T secondaryIconGicon(gio.icon.Icon propval)Set `secondaryIconGicon` property. Params: propval = The #GIcon to use for the secondary icon for the entry. Returns: Builder instance for fluent chaining

T secondaryIconName(string propval)Set `secondaryIconName` property. Params: propval = The icon name to use for the secondary icon for the entry. Returns: Builder instance for fluent chaining

T secondaryIconPixbuf(gdkpixbuf.pixbuf.Pixbuf propval)Set `secondaryIconPixbuf` property. Params: propval = An pixbuf to use as the secondary icon for the entry. Returns: Builder instance for fluent chaining

T secondaryIconSensitive(bool propval)Set `secondaryIconSensitive` property. Params: propval = Whether the secondary icon is sensitive.

T secondaryIconStock(string propval)Set `secondaryIconStock` property. Params: propval = The stock id to use for the secondary icon for the entry. Returns: Builder instance for fluent chaining

T secondaryIconTooltipMarkup(string propval)Set `secondaryIconTooltipMarkup` property. Params: propval = The contents of the tooltip on the secondary icon, which is marked up with the [Pango text markup language][PangoMarkupFormat].

T secondaryIconTooltipText(string propval)Set `secondaryIconTooltipText` property. Params: propval = The contents of the tooltip on the secondary icon.

T shadowType(gtk.types.ShadowType propval)Set `shadowType` property. Params: propval = Which kind of shadow to draw around the entry when #GtkEntry:has-frame is set to true. Returns: Builder instance for fluent chaining

T showEmojiIcon(bool propval)

T tabs(pango.tab_array.TabArray propval)

T text(string propval)

T truncateMultiline(bool propval)Set `truncateMultiline` property. Params: propval = When true, pasted multi-line text is truncated to the first line. Returns: Builder instance for fluent chaining

T visibility(bool propval)

T widthChars(int propval)

T xalign(float propval)Set `xalign` property. Params: propval = The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts. Returns: Builder instance for fluent chaining

classEntryGidBuilder : EntryGidBuilderImpl!EntryGidBuilder

Fluent builder for [gtk.entry.Entry]

Methods

Entry build()