GtkEntry

Name

GtkEntry -- a single line text entry field.

Synopsis


#include <gtk/gtk.h>


struct      GtkEntry;
GtkWidget*  gtk_entry_new                   (void);
GtkWidget*  gtk_entry_new_with_max_length   (gint max);
void        gtk_entry_set_text              (GtkEntry *entry,
                                             const gchar *text);
void        gtk_entry_append_text           (GtkEntry *entry,
                                             const gchar *text);
void        gtk_entry_prepend_text          (GtkEntry *entry,
                                             const gchar *text);
void        gtk_entry_set_position          (GtkEntry *entry,
                                             gint position);
G_CONST_RETURN gchar* gtk_entry_get_text    (GtkEntry *entry);
void        gtk_entry_select_region         (GtkEntry *entry,
                                             gint start,
                                             gint end);
void        gtk_entry_set_visibility        (GtkEntry *entry,
                                             gboolean visible);
void        gtk_entry_set_invisible_char    (GtkEntry *entry,
                                             gunichar ch);
void        gtk_entry_set_editable          (GtkEntry *entry,
                                             gboolean editable);
void        gtk_entry_set_max_length        (GtkEntry *entry,
                                             gint max);
gboolean    gtk_entry_get_activates_default (GtkEntry *entry);
gboolean    gtk_entry_get_has_frame         (GtkEntry *entry);
gint        gtk_entry_get_width_chars       (GtkEntry *entry);
void        gtk_entry_set_activates_default (GtkEntry *entry,
                                             gboolean setting);
void        gtk_entry_set_has_frame         (GtkEntry *entry,
                                             gboolean setting);
void        gtk_entry_set_width_chars       (GtkEntry *entry,
                                             gint n_chars);

Object Hierarchy


  GObject
   +----GtkObject
         +----GtkWidget
               +----GtkEntry

Args


  "text-position"        gint                 : Read / Write
  "editable"             gboolean             : Read / Write
  "max-length"           gint                 : Read / Write
  "visibility"           gboolean             : Read / Write
  "invisible-char"       guint                : Read / Write
  "activates-default"    gboolean             : Read / Write
  "width-chars"          gint                 : Read / Write

Signal Prototypes


"activate"  void        user_function      (GtkEntry *entry,
                                            gpointer user_data);
"changed"   void        user_function      (GtkEntry *entry,
                                            gpointer user_data);
"copy-clipboard"
            void        user_function      (GtkEntry *entry,
                                            gpointer user_data);
"cut-clipboard"
            void        user_function      (GtkEntry *entry,
                                            gpointer user_data);
"delete-from-cursor"
            void        user_function      (GtkEntry *entry,
                                            GtkDeleteType arg1,
                                            gint arg2,
                                            gpointer user_data);
"delete-text"
            void        user_function      (GtkEntry *entry,
                                            gint arg1,
                                            gint arg2,
                                            gpointer user_data);
"insert-at-cursor"
            void        user_function      (GtkEntry *entry,
                                            gchar *arg1,
                                            gpointer user_data);
"insert-text"
            void        user_function      (GtkEntry *entry,
                                            gchar *arg1,
                                            gint arg2,
                                            gpointer arg3,
                                            gpointer user_data);
"move-cursor"
            void        user_function      (GtkEntry *entry,
                                            GtkMovementStep arg1,
                                            gint arg2,
                                            gboolean arg3,
                                            gpointer user_data);
"paste-clipboard"
            void        user_function      (GtkEntry *entry,
                                            gpointer user_data);
"populate-popup"
            void        user_function      (GtkEntry *entry,
                                            GtkMenu *arg1,
                                            gpointer user_data);
"toggle-overwrite"
            void        user_function      (GtkEntry *entry,
                                            gpointer user_data);

Description

The GtkEntry 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.

Details

struct GtkEntry

struct GtkEntry;

The GtkEntry struct contains only private data.


gtk_entry_new ()

GtkWidget*  gtk_entry_new                   (void);

Creates a new GtkEntry widget.

Returns :a new GtkEntry.


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 existance 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.

max :the new maximum length.
Returns :a new GtkEntry.


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.

entry :a GtkEntry.
text :the new text.


gtk_entry_append_text ()

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

Appends the given text to the contents of the widget.

entry :a GtkEntry.
text :the text to append.


gtk_entry_prepend_text ()

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

Prepends the given text to the contents of th ewidget.

entry :a GtkEntry.
text :the text to prepend.


gtk_entry_set_position ()

void        gtk_entry_set_position          (GtkEntry *entry,
                                             gint position);

Sets the cursor position in an entry to the given value. This function is obsolete. You should use gtk_editable_set_position() instead.

entry :a GtkEntry.
position :the position of the cursor. The cursor is displayed before the character with the given (base 0) index in the widget. The value must be less than or equal to the number of characters in the widget. A value of -1 indicates that the position should be set after the last character in the entry. Note that this position is in characters, not in bytes.


gtk_entry_get_text ()

G_CONST_RETURN gchar* gtk_entry_get_text    (GtkEntry *entry);

Retrieve the contents of the entry widget. The returned pointer points to internally allocated storage in the widget and must not be freed, modified or stored. For this reason, this function is deprecated. Use gtk_editable_get_chars() instead.

entry :a GtkEntry.
Returns :the pointer the the contents of the text widget as a string.


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. This function is obsolete. You should use gtk_editable_select_region() instead.

entry :a GtkEntry.
start :the starting position.
end :the end position.


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 asterisks (*'s), and will also appear that way when the text in the entry widget is copied elsewhere.

entry :a GtkEntry.
visible :TRUE if the contents of the entry are displayd as plaintext.


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.

entry : a GtkEntry
ch : a Unicode character


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. This function is obsolete. You should use gtk_editable_set_editable() instead.

entry :a GtkEntry.
editable :TRUE if the user is allowed to edit the text in the widget.


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.

entry :a GtkEntry.
max :the new maximum length.


gtk_entry_get_activates_default ()

gboolean    gtk_entry_get_activates_default (GtkEntry *entry);

Retrieves the value set by gtk_entry_set_activates_default().

entry : a GtkEntry
Returns : TRUE if the entry will activate the default widget


gtk_entry_get_has_frame ()

gboolean    gtk_entry_get_has_frame         (GtkEntry *entry);

Gets the value set by gtk_entry_set_has_frame().

entry : a GtkEntry
Returns : whether the entry has a beveled frame


gtk_entry_get_width_chars ()

gint        gtk_entry_get_width_chars       (GtkEntry *entry);

Gets the value set by gtk_entry_set_width_chars().

entry : a GtkEntry
Returns : number of chars to request space for, or negative if unset


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.)

entry : a GtkEntry
setting : TRUE to activate window's default widget on Enter keypress


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.

entry : a GtkEntry
setting : new value


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 <emphasize>request</emphasize>, 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.

entry : a GtkEntry
n_chars : width in chars

Args

"text-position" (gint : Read / Write)

"editable" (gboolean : Read / Write)

"max-length" (gint : Read / Write)

Determines the maximum allowed length of the contents of the widget. See gtk_entry_set_max_length().

"visibility" (gboolean : Read / Write)

Determines whether the contents of the entry widget are visible or not. See gtk_entry_set_visibility().

"invisible-char" (guint : Read / Write)

"activates-default" (gboolean : Read / Write)

"width-chars" (gint : Read / Write)

Signals

The "activate" signal

void        user_function                  (GtkEntry *entry,
                                            gpointer user_data);

entry :the object which received the signal.
user_data :user data set when the signal handler was connected.


The "changed" signal

void        user_function                  (GtkEntry *entry,
                                            gpointer user_data);

entry :the object which received the signal.
user_data :user data set when the signal handler was connected.


The "copy-clipboard" signal

void        user_function                  (GtkEntry *entry,
                                            gpointer user_data);

entry :the object which received the signal.
user_data :user data set when the signal handler was connected.


The "cut-clipboard" signal

void        user_function                  (GtkEntry *entry,
                                            gpointer user_data);

entry :the object which received the signal.
user_data :user data set when the signal handler was connected.


The "delete-from-cursor" signal

void        user_function                  (GtkEntry *entry,
                                            GtkDeleteType arg1,
                                            gint arg2,
                                            gpointer user_data);

entry :the object which received the signal.
arg1 : 
arg2 : 
user_data :user data set when the signal handler was connected.


The "delete-text" signal

void        user_function                  (GtkEntry *entry,
                                            gint arg1,
                                            gint arg2,
                                            gpointer user_data);

entry :the object which received the signal.
arg1 : 
arg2 : 
user_data :user data set when the signal handler was connected.


The "insert-at-cursor" signal

void        user_function                  (GtkEntry *entry,
                                            gchar *arg1,
                                            gpointer user_data);

entry :the object which received the signal.
arg1 : 
user_data :user data set when the signal handler was connected.


The "insert-text" signal

void        user_function                  (GtkEntry *entry,
                                            gchar *arg1,
                                            gint arg2,
                                            gpointer arg3,
                                            gpointer user_data);

entry :the object which received the signal.
arg1 : 
arg2 : 
arg3 : 
user_data :user data set when the signal handler was connected.


The "move-cursor" signal

void        user_function                  (GtkEntry *entry,
                                            GtkMovementStep arg1,
                                            gint arg2,
                                            gboolean arg3,
                                            gpointer user_data);

entry :the object which received the signal.
arg1 : 
arg2 : 
arg3 : 
user_data :user data set when the signal handler was connected.


The "paste-clipboard" signal

void        user_function                  (GtkEntry *entry,
                                            gpointer user_data);

entry :the object which received the signal.
user_data :user data set when the signal handler was connected.


The "populate-popup" signal

void        user_function                  (GtkEntry *entry,
                                            GtkMenu *arg1,
                                            gpointer user_data);

entry :the object which received the signal.
arg1 : 
user_data :user data set when the signal handler was connected.


The "toggle-overwrite" signal

void        user_function                  (GtkEntry *entry,
                                            gpointer user_data);

entry :the object which received the signal.
user_data :user data set when the signal handler was connected.

See Also

GtkText

a widget for handling multi-line text entry.