![]() |
![]() |
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.
Public Member Functions | |
Entry () | |
gboolean | get_activates_default () const |
Retrieves the value set by set_activates_default(). | |
float | get_alignment () const |
Gets the value set by set_alignment(). | |
Glib::RefPtr<const EntryCompletion> | get_completion () const |
Returns the auxiliary completion object currently in use by entry . | |
Glib::RefPtr<EntryCompletion> | get_completion () |
Returns the auxiliary completion object currently in use by entry . | |
bool | get_has_frame () const |
Gets the value set by set_has_frame(). | |
gunichar | get_invisible_char () const |
Retrieves the character displayed in place of the real characters for entries with visisbility set to false. | |
Glib::RefPtr<const Pango::Layout> | get_layout () const |
Gets the Pango::Layout used to display the entry. | |
Glib::RefPtr<Pango::Layout> | get_layout () |
Gets the Pango::Layout used to display the entry. | |
void | get_layout_offsets (int& x, int& y) |
Obtains the position of the Pango::Layout used to render text in the entry, in widget coordinates. | |
int | get_max_length () const |
Retrieves the maximum allowed length of the text in entry . | |
Glib::ustring | get_text () const |
Retrieves the contents of the entry widget. | |
guint16 | get_text_length () const |
bool | get_visibility () const |
Retrieves whether the text in entry is visible. | |
int | get_width_chars () const |
Gets the value set by set_width_chars(). | |
const GtkEntry* | gobj () const |
Provides access to the underlying C GtkObject. | |
GtkEntry* | gobj () |
Provides access to the underlying C GtkObject. | |
int | layout_index_to_text_index (int layout_index) const |
Converts from a position in the entry contents (returned by get_text()) to a position in the entry's Pango::Layout (returned by get_layout(), with text retrieved via pango_layout_get_text()). | |
Glib::PropertyProxy_ReadOnly< bool > | property_activates_default () const |
Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed. | |
Glib::PropertyProxy<bool> | property_activates_default () |
Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed. | |
Glib::PropertyProxy_ReadOnly< int > | property_cursor_position () const |
The current position of the insertion cursor in chars. | |
Glib::PropertyProxy_ReadOnly< bool > | property_editable () const |
Whether the entry contents can be edited. | |
Glib::PropertyProxy<bool> | property_editable () |
Whether the entry contents can be edited. | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_frame () const |
FALSE removes outside bevel from entry. | |
Glib::PropertyProxy<bool> | property_has_frame () |
FALSE removes outside bevel from entry. | |
Glib::PropertyProxy_ReadOnly< gunichar > | property_invisible_char () const |
The character to use when masking entry contents (in password mode). | |
Glib::PropertyProxy<gunichar> | property_invisible_char () |
The character to use when masking entry contents (in password mode). | |
Glib::PropertyProxy_ReadOnly< int > | property_max_length () const |
Maximum number of characters for this entry. | |
Glib::PropertyProxy<int> | property_max_length () |
Maximum number of characters for this entry. | |
Glib::PropertyProxy_ReadOnly< int > | property_scroll_offset () const |
Number of pixels of the entry scrolled off the screen to the left. | |
Glib::PropertyProxy_ReadOnly< int > | property_selection_bound () const |
The position of the opposite end of the selection from the cursor in chars. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_text () const |
The contents of the entry. | |
Glib::PropertyProxy<Glib::ustring> | property_text () |
The contents of the entry. | |
Glib::PropertyProxy_ReadOnly< bool > | property_visibility () const |
FALSE displays the invisible char instead of the actual text (password mode). | |
Glib::PropertyProxy<bool> | property_visibility () |
FALSE displays the invisible char instead of the actual text (password mode). | |
Glib::PropertyProxy_ReadOnly< int > | property_width_chars () const |
Number of characters to leave space for in the entry. | |
Glib::PropertyProxy<int> | property_width_chars () |
Number of characters to leave space for in the entry. | |
void | set_activates_default (bool setting=true) |
If setting is true , pressing Enter in the entry will activate the default widget for the window containing the entry. | |
void | set_alignment (AlignmentEnum xalign) |
Sets the alignment for the contents of the entry. | |
void | set_alignment (float xalign) |
Sets the alignment for the contents of the entry. | |
void | set_completion (const Glib::RefPtr<EntryCompletion>& completion) |
Sets completion to be the auxiliary completion object to use with entry . | |
void | set_has_frame (bool setting=true) |
Sets whether the entry has a beveled frame around it. | |
void | 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 . | |
void | set_max_length (int max) |
Sets the maximum allowed length of the contents of the widget. | |
void | set_text (const Glib::ustring& text) |
void | set_visibility (bool visible=true) |
void | set_width_chars (int n_chars) |
Changes the size request of the entry to be about the right size for n_chars characters. | |
Glib::SignalProxy0<void> | signal_activate () |
Glib::SignalProxy1< void, const Glib::ustring& > | signal_insert_at_cursor () |
Glib::SignalProxy1< void, Menu* > | signal_populate_popup () |
int | text_index_to_layout_index (int text_index) const |
Converts from a position in the entry's Pango::Layout (returned by get_layout()) to a position in the entry contents (returned by get_text()). | |
virtual | ~Entry () |
Protected Member Functions | |
virtual void | on_activate () |
virtual void | on_insert_at_cursor (const Glib::ustring& str) |
virtual void | on_populate_popup (Menu* menu) |
Related Functions | |
(Note that these are not member functions.) | |
Gtk::Entry* | wrap (GtkEntry* object, bool take_copy=false) |
|
|
|
|
|
Retrieves the value set by set_activates_default().
|
|
Gets the value set by set_alignment().
|
|
Returns the auxiliary completion object currently in use by entry .
|
|
Returns the auxiliary completion object currently in use by entry .
|
|
Gets the value set by set_has_frame().
|
|
Retrieves the character displayed in place of the real characters for entries with visisbility set to false. See set_invisible_char().
|
|
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(). 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 layout_index_to_text_index() and text_index_to_layout_index() are needed to convert byte indices in the layout to byte indices in the entry contents.
|
|
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(). 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 layout_index_to_text_index() and 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 layout_index_to_text_index() and text_index_to_layout_index() are needed to convert byte indices in the layout to byte indices in the entry contents.
|
|
Retrieves the maximum allowed length of the text in entry . See set_max_length().
|
|
Retrieves the contents of the entry widget. See also Gtk::Editable::get_chars().
|
|
|
|
Retrieves whether the text in entry is visible. See set_visibility().
|
|
Gets the value set by set_width_chars().
|
|
Provides access to the underlying C GtkObject.
Reimplemented from Gtk::CellEditable. Reimplemented in Gtk::SpinButton. |
|
Provides access to the underlying C GtkObject.
Reimplemented from Gtk::CellEditable. Reimplemented in Gtk::SpinButton. |
|
Converts from a position in the entry contents (returned by get_text()) to a position in the entry's Pango::Layout (returned by get_layout(), with text retrieved via pango_layout_get_text()).
|
|
|
|
|
|
|
|
Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
The current position of the insertion cursor in chars. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Whether the entry contents can be edited. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Whether the entry contents can be edited. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
FALSE removes outside bevel from entry. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
FALSE removes outside bevel from entry. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
The character to use when masking entry contents (in password mode). You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
The character to use when masking entry contents (in password mode). You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Maximum number of characters for this entry. Zero if no maximum. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Maximum number of characters for this entry. Zero if no maximum. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Number of pixels of the entry scrolled off the screen to the left. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
The position of the opposite end of the selection from the cursor in chars. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
The contents of the entry. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
The contents of the entry. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
FALSE displays the invisible char instead of the actual text (password mode). You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
FALSE displays the invisible char instead of the actual text (password mode). You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Number of characters to leave space for in the entry. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Number of characters to leave space for in the entry. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
If setting is 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
|
|
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.
|
|
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.
|
|
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 Gtk::EntryCompletion API.
|
|
Sets whether the entry has a beveled frame around it.
|
|
Sets the character to use in place of the actual text when set_visibility() has been called to set text visibility to 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.
|
|
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.
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
Converts from a position in the entry's Pango::Layout (returned by get_layout()) to a position in the entry contents (returned by get_text()).
|
|
|