Entry

---

Object Hierarchy:

Description:

Content:

Properties:

• public bool activates_default { get; set; }
  Whether to activate the default widget when the spin button is activated.
• public EntryBuffer buffer { get; set construct; }
  The buffer object which actually stores the text.
• public bool caps_lock_warning { get; set; }
  Whether password entries will show a warning when Caps Lock is on.
• public int cursor_position { get; }
• public bool editable { get; set; }
• public bool has_frame { get; set; }
  Whether the entry should draw a frame.
• public string im_module { owned get; set; }
  Which IM (input method) module should be used for this entry.
• public Border inner_border { get; set; }
  Sets the text area's border between the text and the frame.
• public uint invisible_char { get; set; }
  The character to use when masking entry contents (“password mode”) .
• public bool invisible_char_set { get; set; }
  Whether the invisible char has been set for the `GtkEntry`.
• public int max_length { get; set; }
  Maximum number of characters for this entry.
• public bool overwrite_mode { get; set; }
  If text is overwritten when typing in the `GtkEntry`.
• public bool primary_icon_activatable { get; set; }
  Whether the primary icon is activatable.
• public Icon primary_icon_gicon { owned get; set; }
  The `GIcon` to use for the primary icon for the entry.
• public string primary_icon_name { owned get; set; }
  The icon name to use for the primary icon for the entry.
• public Pixbuf primary_icon_pixbuf { owned get; set; }
  A pixbuf to use as the primary icon for the entry.
• public bool primary_icon_sensitive { get; set; }
  Whether the primary icon is sensitive.
• public string primary_icon_stock { owned get; set; }
  The stock id to use for the primary icon for the entry.
• public ImageType primary_icon_storage_type { get; }
  The representation which is used for the primary icon of the entry.
• public string primary_icon_tooltip_markup { owned get; set; }
  The contents of the tooltip on the primary icon, with markup.
• public string primary_icon_tooltip_text { owned get; set; }
  The contents of the tooltip on the primary icon.
• public double progress_fraction { get; set; }
  The current fraction of the task that's been completed.
• public double progress_pulse_step { get; set; }
  The fraction of total entry width to move the progress bouncing block for each pulse.
• public int scroll_offset { get; }
  Number of pixels of the entry scrolled off the screen to the left.
• public bool secondary_icon_activatable { get; set; }
  Whether the secondary icon is activatable.
• public Icon secondary_icon_gicon { owned get; set; }
  The `GIcon` to use for the secondary icon for the entry.
• public string secondary_icon_name { owned get; set; }
  The icon name to use for the secondary icon for the entry.
• public Pixbuf secondary_icon_pixbuf { owned get; set; }
  An pixbuf to use as the secondary icon for the entry.
• public bool secondary_icon_sensitive { get; set; }
  Whether the secondary icon is sensitive.
• public string secondary_icon_stock { owned get; set; }
  The stock id to use for the secondary icon for the entry.
• public ImageType secondary_icon_storage_type { get; }
  The representation which is used for the secondary icon of the entry.
• public string secondary_icon_tooltip_markup { owned get; set; }
  The contents of the tooltip on the secondary icon, with markup.
• public string secondary_icon_tooltip_text { owned get; set; }
  The contents of the tooltip on the secondary icon.
• public int selection_bound { get; }
• public ShadowType shadow_type { get; set; }
  Which kind of shadow to draw around the entry when has_frame is set to true.
• public string text { get; set; }
• public uint text_length { get; }
  The length of the text in the `GtkEntry`.
• public bool truncate_multiline { get; set; }
  When true, pasted multi-line text is truncated to the first line.
• public bool visibility { get; set; }
  Whether the entry should show the “invisible char” instead of the actual text (“password mode”).
• public int width_chars { get; set; }
• public float xalign { get; set; }
  The horizontal alignment, from 0 (left) to 1 (right).

Creation methods:

• public Entry ()
  Creates a new entry.
• public Entry.with_buffer (EntryBuffer buffer)
  Creates a new entry with the specified text buffer.

Methods:

• public bool get_activates_default ()
  Retrieves the value set by set_activates_default.
• public float get_alignment ()
  Gets the value set by set_alignment.
• public unowned EntryBuffer get_buffer ()
  Get the `GtkEntryBuffer` object which holds the text for this widget.
• public unowned EntryCompletion get_completion ()
  Returns the auxiliary completion object currently in use by this.
• public int get_current_icon_drag_source ()
  Returns the index of the icon which is the source of the current DND operation, or -1.
• public unowned Adjustment get_cursor_hadjustment ()
  Retrieves the horizontal cursor adjustment for the entry.
• public bool get_has_frame ()
  Gets the value set by set_has_frame.
• public bool get_icon_activatable (EntryIconPosition icon_pos)
  Returns whether the icon is activatable.
• public int get_icon_at_pos (int x, int y)
  Finds the icon at the given position and return its index.
• public unowned Icon get_icon_gicon (EntryIconPosition icon_pos)
  Retrieves the `GIcon` used for the icon.
• public unowned string get_icon_name (EntryIconPosition icon_pos)
  Retrieves the icon name used for the icon.
• public unowned Pixbuf get_icon_pixbuf (EntryIconPosition icon_pos)
  Retrieves the image used for the icon.
• public bool get_icon_sensitive (EntryIconPosition icon_pos)
  Returns whether the icon appears sensitive or insensitive.
• public unowned string get_icon_stock (EntryIconPosition icon_pos)
  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.
• public ImageType get_icon_storage_type (EntryIconPosition icon_pos)
  Gets the type of representation being used by the icon to store image data.
• public string? get_icon_tooltip_markup (EntryIconPosition icon_pos)
  Gets the contents of the tooltip on the icon at the specified position in this.
• public string? get_icon_tooltip_text (EntryIconPosition icon_pos)
  Gets the contents of the tooltip on the icon at the specified position in this.
• public unowned Window get_icon_window (EntryIconPosition icon_pos)
• public unowned Border get_inner_border ()
  This function returns the entry’s inner_border property.
• public unichar get_invisible_char ()
  Retrieves the character displayed in place of the actual text in “password mode”.
• public unowned Layout get_layout ()
  Gets the Layout used to display the entry.
• public void get_layout_offsets (out int x, out int y)
  Obtains the position of the Layout used to render text in the entry, in widget coordinates.
• public int get_max_length ()
  Retrieves the maximum allowed length of the text in this.
• public bool get_overwrite_mode ()
  Gets whether the `GtkEntry` is in overwrite mode.
• public double get_progress_fraction ()
  Returns the current fraction of the task that’s been completed.
• public double get_progress_pulse_step ()
  Retrieves the pulse step set with set_progress_pulse_step.
• public unowned string get_text ()
  Retrieves the contents of the entry widget.
• public virtual void get_text_area_size (out int x, out int y, out int width, out int height)
  Calculate the size of the text area, which is its allocated width and requested height, minus space for margins and borders.
• public uint16 get_text_length ()
  Retrieves the current length of the text in this.
• public unowned Window get_text_window ()
• public bool get_visibility ()
  Retrieves whether the text in this is visible.
• public int get_width_chars ()
  Gets the value set by set_width_chars.
• public bool im_context_filter_keypress (EventKey event)
  Allow the Entry input method to internally handle key press and release events.
• public int layout_index_to_text_index (int layout_index)
  Converts from a position in the entry’s Layout (returned by get_layout) to a position in the entry contents (returned by get_text).
• public void progress_pulse ()
  Indicates that some progress is made, but you don’t know how much.
• public void reset_im_context ()
  Reset the input method context of the entry if needed.
• public void set_activates_default (bool setting)
  Sets whether pressing Enter in the this will activate the default widget for the window containing the entry.
• public void set_alignment (float xalign)
  Sets the alignment for the contents of the entry.
• public void set_buffer (EntryBuffer buffer)
  Set the `GtkEntryBuffer` object which holds the text for this widget.
• public void set_completion (EntryCompletion completion)
  Sets completion to be the auxiliary completion object to use with this.
• public void set_cursor_hadjustment (Adjustment adjustment)
  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.
• public void set_has_frame (bool setting)
  Sets whether the entry has a beveled frame around it.
• public void set_icon_activatable (EntryIconPosition icon_pos, bool activatable)
  Sets whether the icon is activatable.
• public void set_icon_drag_source (EntryIconPosition icon_pos, TargetList target_list, DragAction actions)
  Sets up the icon at the given position as drag source.
• public void set_icon_from_gicon (EntryIconPosition icon_pos, Icon? icon)
  Sets the icon shown in the entry at the specified position from the current icon theme.
• public void set_icon_from_icon_name (EntryIconPosition icon_pos, string? icon_name)
  Sets the icon shown in the entry at the specified position from the current icon theme.
• public void set_icon_from_pixbuf (EntryIconPosition icon_pos, Pixbuf? pixbuf)
  Sets the icon shown in the specified position using a pixbuf.
• public void set_icon_from_stock (EntryIconPosition icon_pos, string? stock_id)
  Sets the icon shown in the entry at the specified position from a stock image.
• public void set_icon_sensitive (EntryIconPosition icon_pos, bool sensitive)
  Sets the sensitivity for the specified icon.
• public void set_icon_tooltip_markup (EntryIconPosition icon_pos, string? tooltip)
  Sets tooltip as the contents of the tooltip for the icon at the specified position.
• public void set_icon_tooltip_text (EntryIconPosition icon_pos, string? tooltip)
  Sets tooltip as the contents of the tooltip for the icon at the specified position.
• public void set_inner_border (Border border)
  Sets entry’s inner-border property to border, or clears it if null is passed.
• public void set_invisible_char (unichar ch)
  Sets the character to use in place of the actual text in “password mode”.
• public void set_max_length (int max)
  Sets the maximum allowed length of the contents of the widget.
• public void set_overwrite_mode (bool overwrite)
  Sets whether the text is overwritten when typing in the `GtkEntry`.
• public void set_progress_fraction (double fraction)
  Causes the entry’s progress indicator to “fill in” the given fraction of the bar.
• public void set_progress_pulse_step (double fraction)
  Sets the fraction of total entry width to move the progress bouncing block for each pulse.
• public void set_text (string text)
  Sets the text in the widget to the given value, replacing the current contents.
• public void set_visibility (bool visible)
  Sets whether the contents of the entry are visible or not.
• public void set_width_chars (int n_chars)
  Changes the size request of the entry to be about the right size for n_chars characters.
• public int text_index_to_layout_index (int text_index)
  Converts from a position in the entry contents (returned by get_text) to a position in the entry’s Layout (returned by get_layout, with text retrieved via get_text).
• public void unset_invisible_char ()
  Unsets the invisible char, so that the default invisible char is used again.

Signals:

• public virtual signal void activate ()
  Emitted when the spin button is activated.
• public virtual signal void backspace ()
  The backspace signal is a keybinding signal which gets emitted when the user asks for it.
• public virtual signal void copy_clipboard ()
  The copy_clipboard signal is a keybinding signal which gets emitted to copy the selection to the clipboard.
• public virtual signal void cut_clipboard ()
  The cut_clipboard signal is a keybinding signal which gets emitted to cut the selection to the clipboard.
• public virtual signal void delete_from_cursor (DeleteType type, int count)
  The delete_from_cursor signal is a keybinding signal which gets emitted when the user initiates a text deletion.
• public virtual signal void icon_press (EntryIconPosition p0, Event p1)
  Emitted when an activatable icon is clicked.
• public virtual signal void icon_release (EntryIconPosition p0, Event p1)
  Emitted on the button release from a mouse click over an activatable icon.
• public virtual signal void insert_at_cursor (string str)
  The insert_at_cursor signal is a keybinding signal which gets emitted when the user initiates the insertion of a fixed string at the cursor.
• public virtual signal void move_cursor (MovementStep step, int count, bool extend_selection)
  The move_cursor signal is a keybinding signal which gets emitted when the user initiates a cursor movement.
• public virtual signal void paste_clipboard ()
  The paste_clipboard signal is a keybinding signal which gets emitted to paste the contents of the clipboard into the text view.
• public virtual signal void populate_popup (Menu menu)
  The populate_popup signal gets emitted before showing the context menu of the entry.
• public virtual signal void preedit_changed (string p0)
  If an input method is used, the typed text will not immediately be committed to the buffer.
• public virtual signal void toggle_overwrite ()
  The toggle_overwrite signal is a keybinding signal which gets emitted to toggle the overwrite mode of the entry.

Fields:

• public int ascent
• public uint blink_timeout
• public uint button
• public uint cache_includes_preedit
• public unowned Layout cached_layout
• public int current_pos
• public uint cursor_visible
• public int descent
• public int dnd_position
• public int drag_start_x
• public int drag_start_y
• public uint editing_canceled
• public unowned IMContext im_context
• public uint in_click
• public uint in_drag
• public uint is_cell_renderer
• public uint mouse_cursor_obscured
• public uint need_im_reset
• public unowned Widget popup_menu
• public uint16 preedit_cursor
• public uint16 preedit_length
• public uint recompute_idle
• public uint resolved_dir
• public uint select_lines
• public uint select_words
• public unowned Window text_area
• public uint16 text_max_length
• public uint visible
• public uint16 x_n_bytes
• public uint16 x_text_size

Inherited Members: