Gjsify LogoGjsify Logo

Hierarchy

Index

Properties

activatesDefault?: boolean
appPaintable?: boolean
attributes?: Pango.AttrList

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 #GtkEntryBuffer text, i.e. without the preedit string.

buffer?: Gtk.EntryBuffer
canDefault?: boolean
canFocus?: boolean
capsLockWarning?: boolean

Whether password entries will show a warning when Caps Lock is on.

Note that the warning is shown using a secondary icon, and thus does not work if you are using the secondary icon position for some other purpose.

completion?: Gtk.EntryCompletion

The auxiliary completion object to use with the entry.

decimalSep?: number
doubleBuffered?: boolean

Whether the widget is double buffered.

editable?: boolean
editingCanceled?: boolean

Indicates whether editing on the cell has been canceled.

enableEmojiCompletion?: boolean
events?: Gdk.EventMask
expand?: boolean

Whether to expand in both directions. Setting this sets both #GtkWidget:hexpand and #GtkWidget:vexpand

focusOnClick?: boolean

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

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

Before 3.20, several widgets (GtkButton, GtkFileChooserButton, GtkComboBox) implemented this property individually.

halign?: Gtk.Align

How to distribute horizontal space if widget gets extra space, see #GtkAlign

hasDefault?: boolean
hasFocus?: boolean
hasFrame?: boolean
hasTooltip?: boolean

Enables or disables the emission of #GtkWidget::query-tooltip on widget. A value of %TRUE indicates that widget can have a tooltip, in this case the widget will be queried using #GtkWidget::query-tooltip to determine whether it will provide a tooltip or not.

Note that setting this property to %TRUE for the first time will change the event masks of the GdkWindows of this widget to include leave-notify and motion-notify events. This cannot and will not be undone when the property is set to %FALSE again.

heightRequest?: number
hexpand?: boolean

Whether to expand horizontally. See gtk_widget_set_hexpand().

hexpandSet?: boolean

Whether to use the #GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().

imModule?: string

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

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

innerBorder?: Gtk.Border

Sets the text area's border between the text and the frame.

inputHints?: Gtk.InputHints

Additional hints (beyond #GtkEntry:input-purpose) that allow input methods to fine-tune their behaviour.

inputPurpose?: Gtk.InputPurpose

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 %GTK_INPUT_PURPOSE_PASSWORD or %GTK_INPUT_PURPOSE_PIN is independent from setting #GtkEntry:visibility.

invisibleChar?: number

The invisible character is used when masking entry contents (in "password mode")"). When it is not explicitly set with the #GtkEntry:invisible-char property, GTK+ determines the character to use from a list of possible candidates, depending on availability in the current font.

This style property allows the theme to prepend a character to the list of candidates.

invisibleCharSet?: boolean

Whether the invisible char has been set for the #GtkEntry.

isFocus?: boolean
margin?: number

Sets all four sides' margin at once. If read, returns max margin on any side.

marginBottom?: number

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 gtk_widget_set_size_request() for example.

marginEnd?: number

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 gtk_widget_set_size_request() for example.

marginLeft?: number

Margin on left 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 gtk_widget_set_size_request() for example.

marginRight?: number

Margin on right 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 gtk_widget_set_size_request() for example.

marginStart?: number

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 gtk_widget_set_size_request() for example.

marginTop?: number

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 gtk_widget_set_size_request() for example.

maxLength?: number
maxWidthChars?: number

The desired maximum width of the entry, in characters. If this property is set to -1, the width will be calculated automatically.

nDecimals?: number
name?: string
noShowAll?: boolean
opacity?: number

The requested opacity of the widget. See gtk_widget_set_opacity() for more details about window opacity.

Before 3.8 this was only available in GtkWindow

overwriteMode?: boolean

If text is overwritten when typing in the #GtkEntry.

parent?: Gtk.Container
placeholderText?: string

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

populateAll?: boolean

If :populate-all is %TRUE, the #GtkEntry::populate-popup signal is also emitted for touch popups.

prefix?: string
primaryIconActivatable?: boolean

Whether the primary icon is activatable.

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

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

primaryIconGicon?: Gio.Icon

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

primaryIconName?: string

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

primaryIconPixbuf?: Pixbuf

A pixbuf to use as the primary icon for the entry.

primaryIconSensitive?: boolean

Whether the primary icon is sensitive.

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

primaryIconStock?: string

The stock id to use for the primary icon for the entry.

primaryIconTooltipMarkup?: string

The contents of the tooltip on the primary icon, which is marked up with the [Pango text markup language][PangoMarkupFormat].

Also see gtk_entry_set_icon_tooltip_markup().

primaryIconTooltipText?: string

The contents of the tooltip on the primary icon.

Also see gtk_entry_set_icon_tooltip_text().

progressFraction?: number

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

progressPulseStep?: number

The fraction of total entry width to move the progress bouncing block for each call to gtk_entry_progress_pulse().

receivesDefault?: boolean
secondaryIconActivatable?: boolean

Whether the secondary icon is activatable.

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

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

secondaryIconGicon?: Gio.Icon

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

secondaryIconName?: string

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

secondaryIconPixbuf?: Pixbuf

An pixbuf to use as the secondary icon for the entry.

secondaryIconSensitive?: boolean

Whether the secondary icon is sensitive.

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

secondaryIconStock?: string

The stock id to use for the secondary icon for the entry.

secondaryIconTooltipMarkup?: string

The contents of the tooltip on the secondary icon, which is marked up with the [Pango text markup language][PangoMarkupFormat].

Also see gtk_entry_set_icon_tooltip_markup().

secondaryIconTooltipText?: string

The contents of the tooltip on the secondary icon.

Also see gtk_entry_set_icon_tooltip_text().

sensitive?: boolean
shadowType?: Gtk.ShadowType

Which kind of shadow to draw around the entry when #GtkEntry:has-frame is set to %TRUE.

showEmojiIcon?: boolean
style?: Gtk.Style

The style of the widget, which contains information about how it will look (colors, etc).

suffix?: string
tabs?: TabArray
text?: string
thousandsSep?: number
tooltipMarkup?: string

Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. Also see gtk_tooltip_set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip will automatically be set to %TRUE and there will be taken care of #GtkWidget::query-tooltip in the default signal handler.

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

tooltipText?: string

Sets the text of tooltip to be the given string.

Also see gtk_tooltip_set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip will automatically be set to %TRUE and there will be taken care of #GtkWidget::query-tooltip in the default signal handler.

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

truncateMultiline?: boolean

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

type?: GType<unknown>
valign?: Gtk.Align

How to distribute vertical space if widget gets extra space, see #GtkAlign

vexpand?: boolean

Whether to expand vertically. See gtk_widget_set_vexpand().

vexpandSet?: boolean

Whether to use the #GtkWidget:vexpand property. See gtk_widget_get_vexpand_set().

visibility?: boolean
visible?: boolean
widthChars?: number
widthRequest?: number
xalign?: number

The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method