Implemented Interfaces

gtk.Entry implements gtk.Buildable atk.ImplementorIFace gtk.Editable gtk.CellEditable

gtk.Entry.set_visibility

    def set_visibility(visible)

The set_visibility() method sets the "visibility" property to the value of visible. If visible is True the contents of the entry are displayed as plain text. If visible is False, the contents are obscured by replacing the characters with the invisible character (specified by the "invisible-char" property). The characters will also be obscured when the text in the entry widget is copied elsewhere. The default invisible char is the asterisk '*', but it can be changed with set_invisible_char().

gtk.Entry.get_visibility

    def get_visibility()

The get_visibility() method retrieves the value of the "visibility" property that determines whether the text in entry is visible. See set_visibility().

gtk.Entry.set_invisible_char

    def set_invisible_char(ch)

The set_invisible_char() method sets the "invisible-char" property with the value of ch. The "invisible-char" is 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. The default invisible character is an asterisk ('*'). If you set the invisible character to 0, then the user will get no feedback at all; there will be no text on the screen as they type.

gtk.Entry.get_invisible_char

    def get_invisible_char()

The get_invisible_char() method retrieves the value of the "invisible-char" property. The "invisible-char" is the character displayed in place of the real characters for entries with visibility set to False. See set_invisible_char().

gtk.Entry.unset_invisible_char

    def unset_invisible_char()

The unset_invisible_char() method unsets the invisible char previously set with set_invisible_char() so that the default invisible char is used again.

gtk.Entry.set_has_frame

    def set_has_frame(setting)

The set_has_frame() method sets the "has-frame" property to the value of setting. If setting is True the entry is displayed with a beveled frame around it.

gtk.Entry.get_has_frame

    def get_has_frame()

The get_has_frame() method gets the value of the "has-frame" property. If "has-frame" is True the entry will be displayed with a beveled frame around it.

gtk.Entry.set_max_length

    def set_max_length(max)

The set_max_length() method sets the "max-length" property to the value of max. The "max-length" property 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. If max is 0 then there is no maximum length (other than 65536).

gtk.Entry.get_max_length

    def get_max_length()

The get_max_length() method retrieves the value of the "max-length" property that specifies the maximum allowed length of the text in the entry. See set_max_length().

gtk.Entry.set_activates_default

    def set_activates_default(setting)

The set_activates_default() method sets the "activates-default" property to the value of setting. If setting is True, pressing the Enter key 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.

(For experts: if setting is True, the entry calls gtk.Window.activate_default() on the window containing the entry, in the default handler for the "activate" signal.)

gtk.Entry.get_activates_default

    def get_activates_default()

The get_activates_default() method retrieves the value of the "activates-default" property which is set by set_activates_default(). If "activates-default" is True pressing the Enter key in the entry will activate the default widget for the window containing the entry.

gtk.Entry.set_width_chars

    def set_width_chars(n_chars)

The set_width_chars() method sets the "width-chars" property to the value of n_char. Setting the "width-chars" property changes the size request of the entry to be about the right size for n_chars characters. Note that it only 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.

gtk.Entry.get_width_chars

    def get_width_chars()

The get_width_chars() method gets the value of the "width-chars" property which is set by the set_width_chars() method.

gtk.Entry.set_text

    def set_text(text)

The set_text() method sets the "text" property to the value of text. The string in text replaces the current contents of the entry.

gtk.Entry.get_text

    def get_text()

The get_text() method returns the value of the "text" property which is a string containing the contents of the entry.

gtk.Entry.get_text_length

    def get_text_length()

The get_text_length() method retrieves the current length of the text in entry.

gtk.Entry.get_layout

    def get_layout()

The get_layout() method gets the pango.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().

gtk.Entry.get_layout_offsets

    def get_layout_offsets()

The get_layout_offsets() method obtains the position of the pango.Layout used to render text in the entry, in widget coordinates and returns it as a tuple. This method is used 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. It is also useful to convert mouse events into coordinates inside the pango.Layout, e.g. to take some action if some part of the entry text is clicked.

Note that as the user scrolls around in the entry the offsets will change; you'll need to connect to the "notify::scroll_offset" signal to track this.

gtk.Entry.set_alignment

    def set_alignment(xalign)

The set_alignment() method sets the "xalign" property to the value of xalign. The alignment controls the horizontal positioning of the contents when the displayed text is shorter than the width of the entry. The value of xalign is the fraction of freespace to the left (right in RTL layouts) of the text.

gtk.Entry.get_alignment

    def get_alignment()

The get_alignment() method returns the value of the "xalign" property which is the fraction of freespace (if any) to the left (right in RTL layouts) of the text.

gtk.Entry.set_completion

    def set_completion(completion)

The set_completion() method sets the gtk.EntryCompletion specified by completion to be the auxiliary completion object to use with the entry. All further configuration of the completion mechanism is done using completion and the gtk.EntryCompletion methods.

gtk.Entry.get_completion

    def get_completion()

The get_completion() method returns the gtk.EntryCompletion object currently in use by the entry.

gtk.Entry.set_inner_border

    def set_inner_border(border)

The set_inner_border() method sets the entry's "inner-border" property to the value specified by border, or clears it if None is passed. The "inner-border" is the area around the entry's text, but inside its frame.

If set, this property overrides the inner-border style property. Overriding the style-provided border is useful when you want to do in-place editing of some text in a canvas or list widget, where pixel-exact positioning of the entry is important.

gtk.Entry.get_inner_border

    def get_inner_border()

The get_inner_border() method returns the value of the entry's "inner-border" property. See set_inner_border() for more information.

gtk.Entry.set_cursor_hadjustment

    def set_cursor_hadjustment(adjustment)

The set_cursor_hadjustment() method 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.ScrolledWindow.get_hadjustment for a typical way of obtaining the adjustment. The adjustment has to be in pixel units and in the same coordinate system as the entry.

gtk.Entry.get_cursor_hadjustment

    def get_cursor_hadjustment()

The get_cursor_hadjustment() method retrieves the horizontal cursor adjustment for the entry. See set_cursor_hadjustment.

gtk.Entry.set_overwrite_mode

    def set_overwrite_mode(overwrite)

The set_overwrite_mode() method sets whether the text is overwritten when typing in the Entry.

gtk.Entry.get_overwrite_mode

    def get_overwrite_mode()

The get_overwrite_mode() method gets the value set by gtk.Entry.set_overwrite_mode().

gtk.Entry.set_buffer

    def set_buffer(buffer)

The set_buffer() method sets the gtk.EntryBuffer object which holds the text for this widget.

gtk.Entry.get_buffer

    def get_buffer()

The get_buffer() method gets the gtk.EntryBuffer which holds the text for this widget.

gtk.Entry.set_progress_fraction

    def set_progress_fraction(fraction)

The set_progress_fraction() method 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.

gtk.Entry.get_progress_fraction

    def get_progress_fraction()

The get_progress_fraction() method returns the current fraction of the task that's been completed. See gtk.Entry.set_progress_fraction().

gtk.Entry.set_progress_pulse_step

    def set_progress_pulse_step(fraction)

The set_progress_pulse_step() method sets the fraction of total entry width to move the progress bouncing block for each call to gtk.Entry.progress_pulse().

gtk.Entry.get_progress_pulse_step

    def get_progress_pulse_step()

The get_progress_pulse_step() method retrieves the pulse step set with gtk.Entry.set_progress_pulse_step().

gtk.Entry.progress_pulse

    def progress_pulse()

The progress_pulse() method 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.Entry.progress_pulse() causes the block to move by a little bit (the amount of movement per pulse is determined by gtk.Entry.set_progress_pulse_step()).

gtk.Entry.set_icon_from_pixbuf

    def set_icon_from_pixbuf(icon_pos, pixbuf)

The set_icon_from_pixbuf() method sets the icon shown in the specified position using a pixbuf.

If pixbuf is None, no icon will be shown in the specified position.

gtk.Entry.set_icon_from_stock

    def set_icon_from_stock(icon_pos, stock_id)

The set_icon_from_stock() method sets the icon shown in the entry at the specified position from a stock image.

If stock_id is None, no icon will be shown in the specified position.

gtk.Entry.set_icon_from_icon_name

    def set_icon_from_icon_name(icon_pos, icon_name)

The set_icon_from_icon_name() method sets the icon shown in the entry at the specified position from the current icon theme.

If icon_name is None, no icon will be shown in the specified position.

gtk.Entry.set_icon_from_gicon

    def set_icon_from_gicon(icon_pos, icon)

The set_icon_from_gicon() method 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.

If icon is None, no icon will be shown in the specified position.

gtk.Entry.get_icon_storage_type

    def get_icon_storage_type(icon_pos)

The get_icon_storage_type() method 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.IMAGE_EMPTY.

gtk.Entry.get_icon_pixbuf

    def get_icon_pixbuf(icon_pos)

The get_icon_pixbuf() method retrieves the image used for the icon.

Unlike the other methods of setting and getting icon data, this method will work regardless of whether the icon was set using a gtk.gdk.Pixbuf, a gio.Icon, a stock item, or an icon name.

gtk.Entry.get_icon_stock

    def get_icon_stock(icon_pos)

The get_icon_stock() method retrieves the stock id used for the icon, or None if there is no icon or if the icon was set by some other method (e.g. by pixbuf, icon name or gicon).

gtk.Entry.get_icon_name

    def get_icon_name(icon_pos)

The get_icon_name() method retrieves the icon name used for the icon, or None if there is no icon or if the icon was set by some other method (e.g. by pixbuf, stock or gicon).

gtk.Entry.get_icon_gicon

    def get_icon_gicon(icon_pos)

The get_icon_gicon() method retrieves the gio.Icon used for the icon, or None if there is no icon or if the icon was set by some other method (e.g. by stock, pixbuf, or icon name).

gtk.Entry.set_icon_activatable

    def set_icon_activatable(icon_pos, activatable)

The set_icon_activatable() method sets whether the icon is activatable.

gtk.Entry.get_icon_activatable

    def get_icon_activatable(icon_pos)

The get_icon_activatable() method returns whether the icon is activatable.

gtk.Entry.set_icon_sensitive

    def set_icon_sensitive(icon_pos, sensitive)

The set_icon_sensitive() method sets the sensitivity for the specified icon.

gtk.Entry.get_icon_sensitive

    def get_icon_sensitive(icon_pos)

The get_icon_sensitive() method returns whether the icon appears sensitive or insensitive. .

gtk.Entry.get_icon_at_pos

    def get_icon_at_pos(x, y)

The get_icon_at_pos() method 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.

gtk.Entry.set_icon_tooltip_text

    def set_icon_tooltip_text(icon_pos, tooltip)

The set_icon_tooltip_text() method sets tooltip as the contents of the tooltip for the icon at the specified position.

gtk.Entry.get_icon_tooltip_text

    def get_icon_tooltip_text(icon_pos)

The get_icon_tooltip_text() method gets the contents of the tooltip on the icon at the specified position in the entry.

gtk.Entry.set_icon_tooltip_markup

    def set_icon_tooltip_markup(icon_pos, tooltip)

The set_icon_tooltip_markup() method 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.

gtk.Entry.get_icon_tooltip_markup

    def get_icon_tooltip_markup(icon_pos)

The get_icon_tooltip_markup() method gets the contents of the tooltip on the icon at the specified position in the entry.

gtk.Entry.set_icon_drag_source

    def set_icon_drag_source(icon_pos, target_list, actions)

The set_icon_drag_source() method sets up the icon at the given position so that GTK+ will start a drag operation when the user clicks and drags the icon.

To handle the drag operation, you need to connect to the usual "drag-data-get" (or possibly "drag-data-delete") signal, and use gtk.Entry.get_current_icon_drag_source()) in your signal handler to find out if the drag was started from an icon.

By default, GTK+ uses the icon as the drag icon. You can use the "drag-begin" signal to set a different icon. Note that you have to use gobject.connect_after() to ensure that your signal handler gets executed after the default handler.

gtk.Entry.get_current_icon_drag_source

    def get_current_icon_drag_source()

The get_current_icon_drag_source() method returns the index of the icon which is the source of the current DND operation, or -1.

This function is meant to be used in a "drag-data-get" callback.

gtk.Entry.get_icon_window

    def get_icon_window(icon_pos)

The get_icon_window() method returns the gtk.gdk.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.

gtk.Entry.get_text_window

    def get_text_window()

The get_text_window() method returns the gtk.gdk.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.

gtk.Entry.layout_index_to_text_index

    def layout_index_to_text_index(layout_index)

The layout_index_to_text_index() method converts from a position in the entry contents (returned by gtk.Entry.get_text()) to a position in the entry's pango.Layout (returned by gtk.Entry.get_layout(), with text retrieved via pango.Layout.get_text()).

gtk.Entry.text_index_to_layout_index

    def text_index_to_layout_index(text_index)

The text_index_to_layout_index() method converts from a position in the entry contents (returned by gtk.Entry.get_text()) to a position in the entry's pango.Layout (returned by gtk.Entry.get_layout(), with text retrieved via pango.Layout.get_text()).

gtk.Entry.im_context_filter_keypress

    def im_context_filter_keypress(event)

The im_context_filter_keypress() method allows the gtk.Entry 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.filter_keypress().

Note that you are expected to call this function from your handler when overriding key event handling. This is needed in the case when you need to insert your own key handling between the input method and the default key event handling of the gtk.Entry.

gtk.Entry.reset_im_context

    def reset_im_context()

The reset_im_context() method resets the input method context of the entry if needed.

This can be necessary in the case where modifying the buffer would confuse on-going input method behavior.

The "activate" gtk.Entry Signal

    def callback(entry, user_param1, ...)

The "activate" signal is emitted when the entry is activated either by user action (pressing the Enter key) or programmatically with the gtk.Widget.activate() method

The "backspace" gtk.Entry Signal

    def callback(entry, user_param1, ...)

The "backspace" signal is emitted when the Backspace key is entered from the keyboard.

The "copy-clipboard" gtk.Entry Signal

    def callback(entry, user_param1, ...)

The "copy-clipboard" signal is emitted when the selection text in the entry is copied to the clipboard.

The "cut-clipboard" gtk.Entry Signal

    def callback(entry, user_param1, ...)

The "cut-clipboard" signal is emitted when the selection in the entry is cut (removed from the entry) and placed in the clipboard.

The "delete-from-cursor" gtk.Entry Signal

    def callback(entry, delete_type, count, user_param1, ...)

The "delete-from-cursor" signal is emitted when the a deletion from the cursor i.e. removal o text at the cursor position, either before it (negative count) or after it (positive count). The value of delete_type can be one of:

The "icon-press" gtk.Entry Signal

    def callback(entry, icon_pos, event, user_param1, ...)

The "icon-press" signal is emitted when an activatable icon is clicked.

The "icon-release" gtk.Entry Signal

    def callback(entry, icon_pos, event, user_param1, ...)

The "icon-press" signal is emitted when the button release from a mouse click over an activatable icon.

The "insert-at-cursor" gtk.Entry Signal

    def callback(entry, string, user_param1, ...)

The "insert-at-cursor" signal is emitted when text is being inserted in the entry.

The "move-cursor" gtk.Entry Signal

    def callback(entry, step, count, extend_selection, user_param1, ...)

The "move-cursor" signal is emitted when the cursor is being moved by count steps of size step. If extend_selection is True the selection is extended as the cursor is being moved. The value of step can be one of:

The "paste-clipboard" gtk.Entry Signal

    def callback(entry, user_param1, ...)

The "paste-clipboard" signal is emitted when the contents of the clipboard are pasted into the entry.

The "populate-popup" gtk.Entry Signal

    def callback(entry, menu, user_param1, ...)

The "populate-popup" signal is emitted when the menu needs populating.

The "preedit-changed" gtk.Entry Signal

    def callback(entry, preedit, user_param1, ...)

The "preedit-changed" signal is emitted when 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.

The "toggle-overwrite" gtk.Entry Signal

    def callback(entry, user_param1, ...)

The "toggle-overwrite" signal is emitted when the internal entry attribute "overwrite_mode" is toggled by pressing the Insert key.