GtkEntry

typedef struct _GtkEntry GtkEntry;

The GtkEntry struct contains only private data.

gtk_entry_new ()

GtkWidget*          gtk_entry_new                       (void);

Creates a new entry.

gtk_entry_new_with_max_length ()

GtkWidget*          gtk_entry_new_with_max_length       (gint max);

Creates a new GtkEntry widget with the given maximum length.

Note: the existence of this function is inconsistent with the rest of the GTK+ API. The normal setup would be to just require the user to make an extra call to gtk_entry_set_max_length() instead. It is not expected that this function will be removed, but it would be better practice not to use it.

gtk_entry_set_text ()

void                gtk_entry_set_text                  (GtkEntry *entry,
                                                         const gchar *text);

Sets the text in the widget to the given value, replacing the current contents.

gtk_entry_append_text ()

void                gtk_entry_append_text               (GtkEntry *entry,
                                                         const gchar *text);

Appends the given text to the contents of the widget.

gtk_entry_prepend_text ()

void                gtk_entry_prepend_text              (GtkEntry *entry,
                                                         const gchar *text);

Prepends the given text to the contents of the widget.

gtk_entry_set_position ()

void                gtk_entry_set_position              (GtkEntry *entry,
                                                         gint position);

Sets the cursor position in an entry to the given value.

gtk_entry_get_text ()

const gchar*        gtk_entry_get_text                  (GtkEntry *entry);

Retrieves the contents of the entry widget. See also gtk_editable_get_chars().

gtk_entry_get_text_length ()

guint16             gtk_entry_get_text_length           (GtkEntry *entry);

Retrieves the current length of the text in entry.

Since 2.14

gtk_entry_select_region ()

void                gtk_entry_select_region             (GtkEntry *entry,
                                                         gint start,
                                                         gint end);

Selects a region of text. The characters that are selected are those characters at positions from start_pos up to, but not including end_pos. If end_pos is negative, then the the characters selected will be those characters from start_pos to the end of the text.

gtk_entry_set_visibility ()

void                gtk_entry_set_visibility            (GtkEntry *entry,
                                                         gboolean 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.

The default invisible char is the asterisk '*', but it can be changed with gtk_entry_set_invisible_char().

gtk_entry_set_invisible_char ()

void                gtk_entry_set_invisible_char        (GtkEntry *entry,
                                                         gunichar ch);

Sets the character to use in place of the actual text when gtk_entry_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 char is an asterisk ('*'). 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.

gtk_entry_set_editable ()

void                gtk_entry_set_editable              (GtkEntry *entry,
                                                         gboolean editable);

Determines if the user can edit the text in the editable widget or not.

gtk_entry_set_max_length ()

void                gtk_entry_set_max_length            (GtkEntry *entry,
                                                         gint 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.

gtk_entry_get_activates_default ()

gboolean            gtk_entry_get_activates_default     (GtkEntry *entry);

Retrieves the value set by gtk_entry_set_activates_default().

gtk_entry_get_has_frame ()

gboolean            gtk_entry_get_has_frame             (GtkEntry *entry);

Gets the value set by gtk_entry_set_has_frame().

gtk_entry_get_inner_border ()

const GtkBorder*    gtk_entry_get_inner_border          (GtkEntry *entry);

This function returns the entry's "inner-border" property. See gtk_entry_set_inner_border() for more information.

Since 2.10

gtk_entry_get_width_chars ()

gint                gtk_entry_get_width_chars           (GtkEntry *entry);

Gets the value set by gtk_entry_set_width_chars().

gtk_entry_set_activates_default ()

void                gtk_entry_set_activates_default     (GtkEntry *entry,
                                                         gboolean 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.

(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_set_has_frame ()

void                gtk_entry_set_has_frame             (GtkEntry *entry,
                                                         gboolean setting);

Sets whether the entry has a beveled frame around it.

gtk_entry_set_inner_border ()

void                gtk_entry_set_inner_border          (GtkEntry *entry,
                                                         const GtkBorder *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.

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.

Since 2.10

gtk_entry_set_width_chars ()

void                gtk_entry_set_width_chars           (GtkEntry *entry,
                                                         gint 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.

gtk_entry_get_invisible_char ()

gunichar            gtk_entry_get_invisible_char        (GtkEntry *entry);

Retrieves the character displayed in place of the real characters for entries with visibility set to false. See gtk_entry_set_invisible_char().

gtk_entry_set_alignment ()

void                gtk_entry_set_alignment             (GtkEntry *entry,
                                                         gfloat 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.

Since 2.4

gtk_entry_get_alignment ()

gfloat              gtk_entry_get_alignment             (GtkEntry *entry);

Gets the value set by gtk_entry_set_alignment().

Since 2.4

gtk_entry_set_overwrite_mode ()

void                gtk_entry_set_overwrite_mode        (GtkEntry *entry,
                                                         gboolean overwrite);

Sets whether the text is overwritten when typing in the GtkEntry.

Since 2.14

gtk_entry_get_overwrite_mode ()

gboolean            gtk_entry_get_overwrite_mode        (GtkEntry *entry);

Gets the value set by gtk_entry_set_overwrite_mode().

Since 2.14

gtk_entry_get_layout ()

PangoLayout*        gtk_entry_get_layout                (GtkEntry *entry);

Gets the PangoLayout used to display the entry. The layout is useful to e.g. convert text positions to pixel positions, in combination with gtk_entry_get_layout_offsets(). The returned layout is owned by the entry and must not be modified or freed by the caller.

Keep in mind that the layout text may contain a preedit string, so gtk_entry_layout_index_to_text_index() and gtk_entry_text_index_to_layout_index() are needed to convert byte indices in the layout to byte indices in the entry contents.

gtk_entry_get_layout_offsets ()

void                gtk_entry_get_layout_offsets        (GtkEntry *entry,
                                                         gint *x,
                                                         gint *y);

Obtains the position of the PangoLayout 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.

Also useful to convert mouse events into coordinates inside the PangoLayout, 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. Remember when using the PangoLayout functions you need to convert to and from pixels using PANGO_PIXELS() or PANGO_SCALE.

Keep in mind that the layout text may contain a preedit string, so gtk_entry_layout_index_to_text_index() and gtk_entry_text_index_to_layout_index() are needed to convert byte indices in the layout to byte indices in the entry contents.

gtk_entry_layout_index_to_text_index ()

gint                gtk_entry_layout_index_to_text_index
                                                        (GtkEntry *entry,
                                                         gint layout_index);

Converts from a position in the entry contents (returned by gtk_entry_get_text()) to a position in the entry's PangoLayout (returned by gtk_entry_get_layout(), with text retrieved via pango_layout_get_text()).

gtk_entry_text_index_to_layout_index ()

gint                gtk_entry_text_index_to_layout_index
                                                        (GtkEntry *entry,
                                                         gint text_index);

Converts from a position in the entry's PangoLayout (returned by gtk_entry_get_layout()) to a position in the entry contents (returned by gtk_entry_get_text()).

gtk_entry_get_max_length ()

gint                gtk_entry_get_max_length            (GtkEntry *entry);

Retrieves the maximum allowed length of the text in entry. See gtk_entry_set_max_length().

gtk_entry_get_visibility ()

gboolean            gtk_entry_get_visibility            (GtkEntry *entry);

Retrieves whether the text in entry is visible. See gtk_entry_set_visibility().

gtk_entry_set_completion ()

void                gtk_entry_set_completion            (GtkEntry *entry,
                                                         GtkEntryCompletion *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 GtkEntryCompletion API. Completion is disabled if completion is set to NULL.

Since 2.4

gtk_entry_get_completion ()

GtkEntryCompletion* gtk_entry_get_completion            (GtkEntry *entry);

Returns the auxiliary completion object currently in use by entry.

Since 2.4

gtk_entry_set_cursor_hadjustment ()

void                gtk_entry_set_cursor_hadjustment    (GtkEntry *entry,
                                                         GtkAdjustment *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 gtk_scrolled_window_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.

Since 2.12

gtk_entry_get_cursor_hadjustment ()

GtkAdjustment*      gtk_entry_get_cursor_hadjustment    (GtkEntry *entry);

Retrieves the horizontal cursor adjustment for the entry. See gtk_entry_set_cursor_hadjustment().

Since 2.12

hildon_gtk_entry_get_input_mode ()

HildonGtkInputMode  hildon_gtk_entry_get_input_mode     (GtkEntry *entry);

hildon_gtk_entry_set_input_mode ()

void                hildon_gtk_entry_set_input_mode     (GtkEntry *entry,
                                                         HildonGtkInputMode input_mode);

The "activates-default" property

  "activates-default"        gboolean              : Read / Write

Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed.

Default value: FALSE

The "cursor-position" property

  "cursor-position"          gint                  : Read

The current position of the insertion cursor in chars.

Allowed values: [0,65535]

Default value: 0

The "editable" property

  "editable"                 gboolean              : Read / Write

Whether the entry contents can be edited.

Default value: TRUE

The "has-frame" property

  "has-frame"                gboolean              : Read / Write

FALSE removes outside bevel from entry.

Default value: TRUE

The "hildon-input-default" property

  "hildon-input-default"     HildonGtkInputMode    : Read / Write / Construct

Default input mode for this IM context. See HildonGtkInputMode. The default setting for this property is HILDON_GTK_INPUT_MODE_FULL, which means that the default input mode to be used is up to the implementation of the IM context.

Default value: HILDON_GTK_INPUT_MODE_ALPHA|HILDON_GTK_INPUT_MODE_NUMERIC|HILDON_GTK_INPUT_MODE_SPECIAL

Since maemo 5

The "hildon-input-mode" property

  "hildon-input-mode"        HildonGtkInputMode    : Read / Write / Construct

Allowed characters and input mode for the entry. See HildonGtkInputMode.

Default value: HILDON_GTK_INPUT_MODE_ALPHA|HILDON_GTK_INPUT_MODE_NUMERIC|HILDON_GTK_INPUT_MODE_SPECIAL|HILDON_GTK_INPUT_MODE_AUTOCAP|HILDON_GTK_INPUT_MODE_DICTIONARY

Since maemo 2.0

Stability Level Unstable

The "inner-border" property

  "inner-border"             GtkBorder*            : Read / Write

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

Since 2.10

The "invisible-char" property

  "invisible-char"           guint                 : Read / Write

The character to use when masking entry contents (in "password mode").

Default value: '*'

The "max-length" property

  "max-length"               gint                  : Read / Write

Maximum number of characters for this entry. Zero if no maximum.

Allowed values: [0,65535]

Default value: 0

The "overwrite-mode" property

  "overwrite-mode"           gboolean              : Read / Write

If text is overwritten when typing in the GtkEntry.

Default value: FALSE

Since 2.14

The "progress-fraction" property

  "progress-fraction"        gdouble               : Read / Write

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

Allowed values: [0,1]

Default value: 0

Since 2.16

The "progress-pulse-step" property

  "progress-pulse-step"      gdouble               : Read / Write

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

Allowed values: [0,1]

Default value: 0.1

Since 2.16

The "scroll-offset" property

  "scroll-offset"            gint                  : Read

Number of pixels of the entry scrolled off the screen to the left.

Allowed values: >= 0

Default value: 0

The "selection-bound" property

  "selection-bound"          gint                  : Read

The position of the opposite end of the selection from the cursor in chars.

Allowed values: [0,65535]

Default value: 0

The "shadow-type" property

  "shadow-type"              GtkShadowType         : Read / Write

Which kind of shadow to draw around the entry when "has-frame" is set to TRUE.

Default value: GTK_SHADOW_IN

Since 2.12

The "text" property

  "text"                     gchar*                : Read / Write

The contents of the entry.

Default value: ""

The "text-length" property

  "text-length"              guint                 : Read

The length of the text in the GtkEntry.

Allowed values: <= 65535

Default value: 0

Since 2.14

The "truncate-multiline" property

  "truncate-multiline"       gboolean              : Read / Write

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

Default value: TRUE

Since 2.10

The "visibility" property

  "visibility"               gboolean              : Read / Write

FALSE displays the "invisible char" instead of the actual text (password mode).

Default value: TRUE

The "width-chars" property

  "width-chars"              gint                  : Read / Write

Number of characters to leave space for in the entry.

Allowed values: >= -1

Default value: -1

The "xalign" property

  "xalign"                   gfloat                : Read / Write

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

Allowed values: [0,1]

Default value: 0

Since 2.4

The "inner-border" style property

  "inner-border"             GtkBorder*            : Read

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

Since 2.10

The "state-hint" style property

  "state-hint"               gboolean              : Read

Indicates whether to pass a proper widget state when drawing the shadow and the widget background.

Default value: FALSE

Since 2.16

The "activate" signal

void                user_function                      (GtkEntry *entry,
                                                        gpointer  user_data)      : Run Last / Action

The "backspace" signal

void                user_function                      (GtkEntry *entry,
                                                        gpointer  user_data)      : Run Last / Action

The "copy-clipboard" signal

void                user_function                      (GtkEntry *entry,
                                                        gpointer  user_data)      : Run Last / Action

The "cut-clipboard" signal

void                user_function                      (GtkEntry *entry,
                                                        gpointer  user_data)      : Run Last / Action

The "delete-from-cursor" signal

void                user_function                      (GtkEntry     *entry,
                                                        GtkDeleteType arg1,
                                                        gint          arg2,
                                                        gpointer      user_data)      : Run Last / Action

The "insert-at-cursor" signal

void                user_function                      (GtkEntry *entry,
                                                        gchar    *arg1,
                                                        gpointer  user_data)      : Run Last / Action

The "invalid-input" signal

void                user_function                      (GtkEntry           *arg0,
                                                        GtkInvalidInputType arg1,
                                                        gpointer            user_data)      : Run Last / Action

Emitted when the users enters a character that does not belong to the HildonGtkInputMode of the entry, or the maximum number of characters has been reached.

Since maemo 1.0

Stability Level: Unstable

The "move-cursor" signal

void                user_function                      (GtkEntry       *entry,
                                                        GtkMovementStep arg1,
                                                        gint            arg2,
                                                        gboolean        arg3,
                                                        gpointer        user_data)      : Run Last / Action

The "paste-clipboard" signal

void                user_function                      (GtkEntry *entry,
                                                        gpointer  user_data)      : Run Last / Action

The "populate-popup" signal

void                user_function                      (GtkEntry *entry,
                                                        GtkMenu  *arg1,
                                                        gpointer  user_data)      : Run Last

The "toggle-overwrite" signal

void                user_function                      (GtkEntry *entry,
                                                        gpointer  user_data)      : Run Last / Action