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.
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 so need not be 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.
Obtains the position of the Pango::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.
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. Remember when using the Pango::Layout 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.
Parameters:
x
Location to store X offset of layout, or 0.
y
Location to store Y offset of layout, or 0.
int Gtk::Entry::get_max_length
(
)
const
Retrieves the maximum allowed length of the text in entry .
A pointer to the contents of the widget as a string. This string points to internally allocated storage in the widget and must not be freed, modified or stored.
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.)
Parameters:
setting
true to activate window's default widget on Enter keypress.
void Gtk::Entry::set_has_frame
(
bool
setting = true
)
Sets whether the entry has a beveled frame around it.
Parameters:
setting
New value.
void Gtk::Entry::set_invisible_char
(
gunichar
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. 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.
Parameters:
ch
A Unicode character.
void Gtk::Entry::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.
Parameters:
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.
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.
