Entry

---

Object Hierarchy:

Description:

Content:

Properties:

• public bool activates_default { set; get; }
• public EntryBuffer buffer { construct set; get; }
• public bool caps_lock_warning { set; get; }
  Whether password entries will show a warning when Caps Lock is on.
• public int cursor_position { get; }
• public bool editable { set; get; }
• public bool has_frame { set; get; }
• public string im_module { set; owned get; }
  Which IM (input method) module should be used for this entry. See IMContext.
• public Border inner_border { set; get; }
  Sets the text area's border between the text and the frame.
• public uint invisible_char { set; get; }
  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.
• public bool invisible_char_set { set; get; }
  Whether the invisible char has been set for the Entry.
• public int max_length { set; get; }
• public bool overwrite_mode { set; get; }
  If text is overwritten when typing in the Entry.
• public bool primary_icon_activatable { set; get; }
  Whether the primary icon is activatable.
• public Icon primary_icon_gicon { set; owned get; }
  The Icon to use for the primary icon for the entry.
• public string primary_icon_name { set; owned get; }
  The icon name to use for the primary icon for the entry.
• public Pixbuf primary_icon_pixbuf { set; owned get; }
  A pixbuf to use as the primary icon for the entry.
• public bool primary_icon_sensitive { set; get; }
  Whether the primary icon is sensitive.
• public string primary_icon_stock { set; owned get; }
  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 { set; owned get; }
  The contents of the tooltip on the primary icon, which is marked up with the Pango text markup
  language.
• public string primary_icon_tooltip_text { set; owned get; }
  The contents of the tooltip on the primary icon.
• public double progress_fraction { set; get; }
  The current fraction of the task that's been completed.
• public double progress_pulse_step { set; get; }
  The fraction of total entry width to move the progress bouncing block for each call to progress_pulse.
• public int scroll_offset { get; }
• public bool secondary_icon_activatable { set; get; }
  Whether the secondary icon is activatable.
• public Icon secondary_icon_gicon { set; owned get; }
  The Icon to use for the secondary icon for the entry.
• public string secondary_icon_name { set; owned get; }
  The icon name to use for the secondary icon for the entry.
• public Pixbuf secondary_icon_pixbuf { set; owned get; }
  An pixbuf to use as the secondary icon for the entry.
• public bool secondary_icon_sensitive { set; get; }
  Whether the secondary icon is sensitive.
• public string secondary_icon_stock { set; owned get; }
  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 { set; owned get; }
  The contents of the tooltip on the secondary icon, which is marked up with the Pango text markup
  language.
• public string secondary_icon_tooltip_text { set; owned get; }
  The contents of the tooltip on the secondary icon.
• public int selection_bound { get; }
• public ShadowType shadow_type { set; get; }
  Which kind of shadow to draw around the entry when has_frame is set to true.
• public string text { set; get; }
• public uint text_length { get; }
  The length of the text in the Entry.
• public bool truncate_multiline { set; get; }
  When true, pasted multi-line text is truncated to the first line.
• public bool visibility { set; get; }
• public int width_chars { set; get; }
• public float xalign { set; get; }
  The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.

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 weak EntryBuffer get_buffer ()
  Get the EntryBuffer object which holds the text for this widget.
• public weak EntryCompletion get_completion ()
  Returns the auxiliary completion object currently in use by entry.
• 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 weak Adjustment get_cursor_hadjustment ()
  Retrieves the horizontal cursor adjustment for the entry. See set_cursor_hadjustment.
• 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. If x, y doesn't lie inside an icon, -1 is returned. This function is intended for use in a query_tooltip signal handler.
• public weak Icon get_icon_gicon (EntryIconPosition icon_pos)
  Retrieves the Icon 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).
• public unowned string get_icon_name (EntryIconPosition icon_pos)
  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).
• public weak 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.g., by pixbuf, icon name or gicon).
• public ImageType get_icon_storage_type (EntryIconPosition icon_pos)
  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 EMPTY.
• public unowned string get_icon_tooltip_markup (EntryIconPosition icon_pos)
  Gets the contents of the tooltip on the icon at the specified position in entry.
• public unowned string get_icon_tooltip_text (EntryIconPosition icon_pos)
  Gets the contents of the tooltip on the icon at the specified position in entry.
• public weak Window get_icon_window (EntryIconPosition icon_pos)
  Returns the Window which contains the entry's icon at icon_pos. This function is useful when drawing something to the entry in an expose-event callback because it enables the callback to distinguish between the text window and entry's icon windows.
• public unowned Border get_inner_border ()
  This function returns the entry's inner_border property. See set_inner_border for more information.
• public unichar get_invisible_char ()
  Retrieves the character displayed in place of the real characters for entries with visibility set to false. See set_invisible_char.
• public weak Layout get_layout ()
  Gets the Layout used to display the entry. The layout is useful to e.g. convert text positions to pixel positions, in combination with get_layout_offsets. The returned layout is owned by the entry and must not be modified or freed by the caller.
• 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. Useful if you want to line up the text in an entry with some other text, e.g. when using the entry to implement editable cells in a sheet widget.
• public int get_max_length ()
  Retrieves the maximum allowed length of the text in entry. See set_max_length.
• public bool get_overwrite_mode ()
  Gets the value set by set_overwrite_mode .
• public double get_progress_fraction ()
  Returns the current fraction of the task that's been completed. See set_progress_fraction.
• 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. See also get_chars.
• public virtual void get_text_area_size (int x, int y, int width, int height)
• public uint16 get_text_length ()
  Retrieves the current length of the text in entry.
• public weak Window get_text_window ()
  Returns the Window which contains the text. This function is useful when drawing something to the entry in an expose-event callback because it enables the callback to distinguish between the text window and entry's icon windows.
• public bool get_visibility ()
  Retrieves whether the text in entry is visible. See set_visibility.
• public int get_width_chars ()
  Gets the value set by set_width_chars.
• public int layout_index_to_text_index (int layout_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 progress_pulse ()
  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 progress_pulse causes the block to move by a little bit (the amount of movement per pulse is determined by set_progress_pulse_step).
• public void set_activates_default (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, since the default widget is usually one of the dialog buttons.
• public void set_alignment (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.
• public void set_buffer (EntryBuffer buffer)
  Set the EntryBuffer 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 entry. All further configuration of the completion mechanism is done on completion using the EntryCompletion API. Completion is disabled if completion is set to null.
• 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. See get_hadjustment for a typical way of obtaining the adjustment.
• 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 so that GTK+ will start a drag operation when the user clicks and drags the icon.
• 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. If the icon isn't known, a "broken image" icon will be displayed instead.
• 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. tooltip is assumed to be marked up with the Pango text markup language.
• 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. The inner-border is the area around the entry's text, but inside its frame.
• public void set_invisible_char (unichar ch)
  Sets the character to use in place of the actual text when set_visibility has been called to set text visibility to false . i.e. this is the character used in "password mode" to show the user how many characters have been typed. By default, GTK+ picks the best invisible char available in the current font. If you set the invisible char to 0, then the user will get no feedback at all; there will be no text on the screen as they type.
• public void set_max_length (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.
• public void set_overwrite_mode (bool overwrite)
  Sets whether the text is overwritten when typing in the Entry .
• public void set_progress_fraction (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.
• public void set_progress_pulse_step (double fraction)
  Sets the fraction of total entry width to move the progress bouncing block for each call to progress_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. 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 widget is copied elsewhere.
• 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. Note that it changes the size request, the size can still be affected by how you pack the widget into containers. If n_chars is -1, the size reverts to the default entry size.
• public int text_index_to_layout_index (int text_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 unset_invisible_char ()
  Unsets the invisible char previously set with set_invisible_char. So that the default invisible char is used again.

Signals:

• public virtual void activate ()
  A keybinding signal which gets emitted when the user activates the entry.
• public virtual void backspace ()
  The backspace signal is a keybinding signal which gets emitted when the user asks for it.
• public virtual void copy_clipboard ()
  The copy_clipboard signal is a keybinding signal which gets emitted to copy the selection to the clipboard.
• public virtual void cut_clipboard ()
  The cut_clipboard signal is a keybinding signal which gets emitted to cut the selection to the clipboard.
• public virtual 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 void icon_press (EntryIconPosition p0, Event p1)
  The icon_press signal is emitted when an activatable icon is clicked.
• public virtual void icon_release (EntryIconPosition p0, Event p1)
  The icon_release signal is emitted on the button release from a mouse click over an activatable icon.
• public virtual 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 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. If the cursor is not visible in entry, this signal causes the viewport to be moved instead.
• public virtual 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 void populate_popup (Menu menu)
  The populate_popup signal gets emitted before showing the context menu of the entry.
• public virtual void preedit_changed (string p0)
  If an input method is used, the typed text will not immediately be committed to the buffer. So if you are interested in the text, connect to this signal.
• public virtual 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 weak 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 weak 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 weak 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 weak Window text_area
• public uint16 text_max_length
• public uint visible
• public uint16 x_n_bytes
• public uint16 x_text_size