gtk.Entry — a single line text entry field.
+--gobject.GObject +-- gtk.Object +-- gtk.Widget +-- gtk.Entry
gtk.Entry
implements
gtk.Buildable
atk.ImplementorIFace
gtk.Editable
gtk.CellEditable
|
|
gtk.Editable Signal Prototypes
gtk.CellEditable Signal Prototypes
"activate" | def callback( |
def callback( | |
def callback( | |
def callback( | |
def callback( | |
def callback( | |
def callback( | |
def callback( | |
def callback( | |
def callback( | |
def callback( | |
def callback( | |
def callback( |
The gtk.Entry 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.set_visibility(). 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.set_invisible_char().
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 "caps-lock-warning" property.
Since 2.16, gtk.Entry has the ability to display
progress or activity information behind the text. To make an entry display such information, use
gtk.Entry.set_progress_fraction() or
gtk.Entry.set_progress_pulse_step().
Additionally, gtk.Entry 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.set_icon_from_gicon() 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 "icon-press" signal. To allow DND operations from an icon, use
gtk.Entry.set_icon_drag_source().
To set a tooltip on an icon, use
gtk.Entry.set_icon_tooltip_text()
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.
gtk.Entry(max=0)
| the maximum length of the entry, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be limited to the range 0-65536. |
Returns : | a new gtk.Entry. |
Creates a new gtk.Entry widget
with the maximum length specified by max.
def set_visibility(visible)
| If False the contents are obscured using the "invisible-char" |
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().
def get_visibility()Returns : | True if the text is
currently visible |
The get_visibility() method retrieves
the value of the "visibility" property that determines whether the
text in entry is visible. See set_visibility().
def set_invisible_char(ch)
| a Unicode character |
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.
def get_invisible_char()Returns : | the current invisible char, or 0, if the entry does not show invisible text at all. |
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().
def unset_invisible_char()This method is available in PyGTK 2.16 and above.
The unset_invisible_char() method unsets the invisible char previously set with
set_invisible_char()
so that the default invisible char is used again.
def set_has_frame(setting)
| If True the entry is displayed with a beveled frame around it. |
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.
def get_has_frame()Returns : | whether the entry has a beveled 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.
def set_max_length(max)
| the maximum length of the entry, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536. |
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).
def get_max_length()Returns : | the maximum allowed number of characters in
gtk.Entry, or 0
if there is no maximum. |
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().
def set_activates_default(setting)
| If True activate the
window's default widget on an Enter
key press |
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.)
def get_activates_default()Returns : | True if the entry will
activate the default widget |
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.
def set_width_chars(n_chars)
| width in 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.
def get_width_chars()Returns : | number of chars to request space for, or negative if unset |
The get_width_chars() method gets the
value of the "width-chars" property which is set by the set_width_chars()
method.
def set_text(text)
| a string to use as the new contents of the entry |
The set_text() method sets the "text"
property to the value of text. The string in
text replaces the current contents of the
entry.
def get_text()Returns : | the contents of the entry as a string |
The get_text() method returns the value
of the "text" property which is a string containing the contents of
the entry.
def get_text_length()Returns : | the current number of characters in GtkEntry, or 0 if there are none. |
This method is available in PyGTK 2.14 and above.
The get_text_length() method retrieves the current length of the text in entry.
def get_layout()Returns : | the pango.Layout for
this entry |
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().
def get_layout_offsets()Returns : | a tuple containing the X and Y offsets of the pango layout |
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.
def set_alignment(xalign)
| The horizontal alignment ranging from 0.0 to 1.0 representing the freespace to the left (right for RTL layouts) of the text. |
This method is available in PyGTK 2.4 and above.
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.
def get_alignment()Returns : | The horizontal alignment ranging from 0.0 to 1.0 representing the freespace to the left (right for RTL layouts) of the text. |
This method is available in PyGTK 2.4 and above.
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.
def set_completion(completion)
| a gtk.EntryCompletion |
This method is available in PyGTK 2.4 and above.
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.
def get_completion()Returns : | the auxiliary completion object |
This method is available in PyGTK 2.4 and above.
The get_completion() method returns the
gtk.EntryCompletion
object currently in use by the entry.
def set_inner_border(border)
| a gtk.Border,
or None |
This method is available in PyGTK 2.10 and above.
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.
def get_inner_border()Returns : | the entry's gtk.Border,
or None if none was set. |
This method is available in PyGTK 2.10 and above.
The get_inner_border() method returns
the value of the entry's "inner-border" property. See set_inner_border()
for more information.
def set_cursor_hadjustment(adjustment)
| An adjustment which should be adjusted when
the cursor is moved, or None. |
This method is available in PyGTK 2.12 and above.
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.
def get_cursor_hadjustment()Returns : | The horizontal cursor adjustment, or
None if none has been set. |
This method is available in PyGTK 2.12 and above.
The get_cursor_hadjustment() method retrieves the horizontal
cursor adjustment for the entry. See
set_cursor_hadjustment.
def set_overwrite_mode(overwrite)
| new value. |
This method is available in PyGTK 2.14 and above.
The set_overwrite_mode() method sets whether the text
is overwritten when typing in the Entry.
def get_overwrite_mode()Returns : | whether text is overwritten when typing in the Entry. |
This method is available in PyGTK 2.14 and above.
The get_overwrite_mode() method gets the value set by
gtk.Entry.set_overwrite_mode().
def set_buffer(buffer)
| a gtk.EntryBuffer. |
This method is available in PyGTK 2.22 and above.
The set_buffer() method sets the
gtk.EntryBuffer
object which holds the text for this widget.
def get_buffer()Returns : | a gtk.EntryBuffer object. |
This method is available in PyGTK 2.22 and above.
The get_buffer() method gets the
gtk.EntryBuffer
which holds the text for this widget.
def set_progress_fraction(fraction)
| fraction of the task that's been completed. |
This method is available in PyGTK 2.16 and above.
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.
def get_progress_fraction()Returns : | a fraction from 0.0 to 1.0. |
This method is available in PyGTK 2.16 and above.
The get_progress_fraction() method returns the current fraction of the task that's been
completed. See gtk.Entry.set_progress_fraction().
def set_progress_pulse_step(fraction)
| fraction between 0.0 and 1.0. |
This method is available in PyGTK 2.16 and above.
The set_progress_pulse_step() method sets the fraction of
total entry width to move the progress bouncing block for each call to
def get_progress_pulse_step()Returns : | a fraction from 0.0 to 1.0. |
This method is available in PyGTK 2.16 and above.
The get_progress_pulse_step() method retrieves the pulse step set with
gtk.Entry.set_progress_pulse_step().
def progress_pulse()This method is available in PyGTK 2.16 and above.
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()).
def set_icon_from_pixbuf(icon_pos, pixbuf)
| The position at which to set the icon. |
| A gtk.gdk.Pixbuf, or None. |
This method is available in PyGTK 2.16 and above.
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.
def set_icon_from_stock(icon_pos, stock_id)
| The position at which to set the icon. |
| The name of the stock item, or None. |
This method is available in PyGTK 2.16 and above.
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.
def set_icon_from_icon_name(icon_pos, icon_name)
| The position at which to set the icon. |
| An icon name, or None. |
This method is available in PyGTK 2.16 and above.
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.
def set_icon_from_gicon(icon_pos, icon)
| The position at which to set the icon. |
| The icon to set, or None. |
This method is available in PyGTK 2.16 and above.
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.
def get_icon_storage_type(icon_pos)
| Icon position. |
Returns : | the image representation being used. |
This method is available in PyGTK 2.16 and above.
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.
def get_icon_pixbuf(icon_pos)
| Icon position. |
Returns : | A gtk.gdk.Pixbuf, or None if no icon is set for this position. |
This method is available in PyGTK 2.16 and above.
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
def get_icon_stock(icon_pos)
| Icon position. |
Returns : | A stock id, or None if no icon is set or if the icon wasn't set from a stock id. |
This method is available in PyGTK 2.16 and above.
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).
def get_icon_name(icon_pos)
| Icon position. |
Returns : | An icon name, or None if no icon is set or if the icon wasn't set from an icon name. |
This method is available in PyGTK 2.16 and above.
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).
def get_icon_gicon(icon_pos)
| Icon position. |
Returns : | A gio.IconNone if no icon is set or if the icon is not a
gio.Icon |
This method is available in PyGTK 2.16 and above.
The get_icon_gicon() method retrieves the
gio.IconNone if there is no icon or if the icon was set by some other
method (e.g. by stock, pixbuf, or icon name).
def set_icon_activatable(icon_pos, activatable)
| Icon position. |
| True if the icon should be activatable. |
This method is available in PyGTK 2.16 and above.
The set_icon_activatable() method sets whether the icon is activatable.
def get_icon_activatable(icon_pos)
| Icon position. |
Returns : | True if the icon is activatable, False otherwise. |
This method is available in PyGTK 2.16 and above.
The get_icon_activatable() method returns whether the icon is activatable.
def set_icon_sensitive(icon_pos, sensitive)
| Icon position. |
| True if the icon should appear sensitive, False if the icon should appear insensitive. |
This method is available in PyGTK 2.16 and above.
The set_icon_sensitive() method sets the sensitivity for the specified icon.
def get_icon_sensitive(icon_pos)
| Icon position. |
Returns : | True if the icon appears sensitive, False if the icon appears insensitive. |
This method is available in PyGTK 2.16 and above.
The get_icon_sensitive() method returns whether the icon appears sensitive or insensitive. .
def get_icon_at_pos(x, y)
| the x coordinate of the position to find. |
| the y coordinate of the position to find. |
Returns : | the index of the icon at the given position, or -1. |
This method is available in PyGTK 2.16 and above.
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.
def set_icon_tooltip_text(icon_pos, tooltip)
| the icon position. |
| the contents of the tooltip for the icon, or None. |
This method is available in PyGTK 2.16 and above.
The set_icon_tooltip_text() method sets
tooltip as the contents of the tooltip for the
icon at the specified position.
def get_icon_tooltip_text(icon_pos)
| the icon position. |
Returns : | the tooltip text, or None. |
This method is available in PyGTK 2.16 and above.
The get_icon_tooltip_text() method gets the contents of the tooltip on the icon at the specified position in the entry.
def set_icon_tooltip_markup(icon_pos, tooltip)
| the icon position. |
| the contents of the tooltip for the icon, or None. |
This method is available in PyGTK 2.16 and above.
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.
def get_icon_tooltip_markup(icon_pos)
| the icon position. |
Returns : | the tooltip text, or None. |
This method is available in PyGTK 2.16 and above.
The get_icon_tooltip_markup() method gets the contents of the tooltip on the icon at the specified position in the entry.
def set_icon_drag_source(icon_pos, target_list, actions)
| icon position. |
| the targets (data formats) in which the data can be provided. |
| a bitmask of the allowed drag actions. |
This method is available in PyGTK 2.16 and above.
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()
def get_current_icon_drag_source()Returns : | the index of the icon which is the source of the current DND operation, or -1. |
This method is available in PyGTK 2.16 and above.
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.
def get_icon_window(icon_pos)
| Icon position. |
Returns : | the entry's icon window at icon_pos. |
This method is available in PyGTK 2.22 and above.
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.
def get_text_window()Returns : | the entry's text window. |
This method is available in PyGTK 2.22 and above.
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.
def layout_index_to_text_index(layout_index)
| index of the entry layout text. |
Returns : | index of the entry contents. |
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()).
def text_index_to_layout_index(text_index)
| index of the entry contents. |
Returns : | index of the entry layout text. |
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()).
def im_context_filter_keypress(event)
| The key event. |
This method is available in PyGTK 2.22 and above.
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.
def callback(entry, user_param1, ...)
| the entry that received the signal |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
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
def callback(entry, user_param1, ...)
| the object which received the signal. |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
The "backspace" signal is emitted when the Backspace key is entered from the keyboard.
def callback(entry, user_param1, ...)
| the entry that received the signal |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
The "copy-clipboard" signal is emitted when the selection text in the entry is copied to the clipboard.
def callback(entry, user_param1, ...)
| the entry that received the signal |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
The "cut-clipboard" signal is emitted when the selection in the entry is cut (removed from the entry) and placed in the clipboard.
def callback(entry, delete_type, count, user_param1, ...)
| the entry that received the signal |
| the type of deletion |
| the number of deletions of the type to perform |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
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:
def callback(entry, icon_pos, event, user_param1, ...)
| the entry that received the signal |
| The position of the clicked icon. |
| The button press event. |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
The "icon-press" signal is emitted when an activatable icon is clicked.
def callback(entry, icon_pos, event, user_param1, ...)
| the entry that received the signal |
| The position of the clicked icon. |
| The button press event. |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
The "icon-press" signal is emitted when the button release from a mouse click over an activatable icon.
def callback(entry, string, user_param1, ...)
| the entry that received the signal |
| the text being inserted in the entry |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
The "insert-at-cursor" signal is emitted when text is being inserted in the entry.
def callback(entry, step, count, extend_selection, user_param1, ...)
| the entry that received the signal |
| the size of the step to move the cursor |
| the number of steps to move the cursor |
| if True extend the selection as well as moving the cursor |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
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:
def callback(entry, user_param1, ...)
| the entry that received the signal |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
The "paste-clipboard" signal is emitted when the contents of the clipboard are pasted into the entry.
def callback(entry, menu, user_param1, ...)
| the entry that received the signal |
| the menu that needs populating |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
The "populate-popup" signal is emitted when the
menu needs populating.
def callback(entry, preedit, user_param1, ...)
| the entry that received the signal |
| the current preedit string |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
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.
def callback(entry, user_param1, ...)
| the entry that received the signal |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
The "toggle-overwrite" signal is emitted when the internal entry attribute "overwrite_mode" is toggled by pressing the Insert key.