gtk.Entry

class Entry : gtk.Widget.Widget, gtk.CellEditableIF.CellEditableIF, gtk.EditableIF.EditableIF;
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.

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 #GtkEntry:caps-lock-warning property.

Since 2.16, GtkEntry 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, GtkEntry 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 #GtkEntry::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.

# CSS nodes

|[ entry ├── image.left ├── image.right ├── undershoot.left ├── undershoot.right ├── [selection] ├── [progress[.pulse]] ╰── [window.popup] ]|

GtkEntry has a main node with the name entry. Depending on the properties of the entry, the style classes .read-only and .flat may appear. The style classes .warning and .error may also be used with entries.

When the entry shows icons, it adds subnodes with the name image and the style class .left or .right, depending on where the icon appears.

When the entry has a selection, it adds a subnode with the name selection.

When the entry shows progress, it adds a subnode with the name progress. The node has the style class .pulse when the shown progress is pulsing.

The CSS node for a context menu is added as a subnode below entry as well.

The undershoot nodes are used to draw the underflow indication when content is scrolled out of view. These nodes get the .left and .right style classes added depending on where the indication is drawn.

When touch is used and touch selection handles are shown, they are using CSS nodes with name cursor-handle. They get the .top or .bottom style class depending on where they are shown in relation to the selection. If there is just a single handle for the text cursor, it gets the style class .insertion-cursor.

protected GtkEntry* gtkEntry ;
the main Gtk struct

GtkEntry* getEntryStruct ();
Get the main Gtk struct

protected void* getStruct ();
the main Gtk struct as a void*

this(GtkEntry* gtkEntry, bool ownedRef = false);
Sets our main struct and passes it to the parent class.

this(string text);
this(string text, int max);
StockID getStockId (GtkEntryIconPosition iconPos);
Gets the stock id of action. Since 2.16

Returns:
the stock id

void setStockId (GtkEntryIconPosition iconPos, StockID stockId);
Sets the stock id on action Since 2.16

Params:
StockID stockId the stock id

static GType getType ();
this();
Creates a new entry.

Returns:
a new #GtkEntry.

Throws:
ConstructionException GTK+ fails to create the object.

this(EntryBuffer buffer);
Creates a new entry with the specified text buffer.

Params:
EntryBuffer buffer The buffer to use for the new #GtkEntry.

Returns:
a new #GtkEntry

Since:
2.18

Throws:
ConstructionException GTK+ fails to create the object.

bool getActivatesDefault ();
Retrieves the value set by gtk_entry_set_activates_default().

Returns:
%TRUE if the entry will activate the default widget

float getAlignment ();
Gets the value set by gtk_entry_set_alignment().

Returns:
the alignment

Since:
2.4

PgAttributeList getAttributes ();
Gets the attribute list that was set on the entry using gtk_entry_set_attributes(), if any.

Returns:
the attribute list, or %NULL if none was set.

Since:
3.6

EntryBuffer getBuffer ();
Get the #GtkEntryBuffer object which holds the text for this widget.

Returns:
A #GtkEntryBuffer object.

Since:
2.18

EntryCompletion getCompletion ();
Returns the auxiliary completion object currently in use by @entry.

Returns:
The auxiliary completion object currently in use by @entry.

Since:
2.4

int getCurrentIconDragSource ();
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 #GtkWidget::drag-data-get callback.

Returns:
index of the icon which is the source of the current DND operation, or -1.

Since:
2.16

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

Returns:
the horizontal cursor adjustment, or %NULL if none has been set.

Since:
2.12

bool getHasFrame ();
Gets the value set by gtk_entry_set_has_frame().

Returns:
whether the entry has a beveled frame

bool getIconActivatable (GtkEntryIconPosition iconPos);
Returns whether the icon is activatable.

Params:
GtkEntryIconPosition iconPos Icon position

Returns:
%TRUE if the icon is activatable.

Since:
2.16

void getIconArea (GtkEntryIconPosition iconPos, out GdkRectangle iconArea);
Gets the area where entry’s icon at @icon_pos is drawn. This function is useful when drawing something to the entry in a draw callback.

If the entry is not realized or has no icon at the given position, @icon_area is filled with zeros.

See also gtk_entry_get_text_area()

Params:
GtkEntryIconPosition iconPos Icon position
GdkRectangle iconArea Return location for the icon’s area

Since:
3.0

int getIconAtPos (int x, int y);
Finds the icon at the given position and return its index. The position’s coordinates are relative to the @entry’s top left corner. If @x, @y doesn’t lie inside an icon, -1 is returned. This function is intended for use in a #GtkWidget::query-tooltip signal handler.

Params:
int x the x coordinate of the position to find
int y the y coordinate of the position to find

Returns:
the index of the icon at the given position, or -1

Since:
2.16

IconIF getIconGicon (GtkEntryIconPosition iconPos);
Retrieves the #GIcon used for the icon, or %NULL if there is no icon or if the icon was set by some other method (e.g., by stock, pixbuf, or icon name).

Params:
GtkEntryIconPosition iconPos Icon position

Returns:
A #GIcon, or %NULL if no icon is set or if the icon is not a #GIcon

Since:
2.16

string getIconName (GtkEntryIconPosition iconPos);
Retrieves the icon name used for the icon, or %NULL if there is no icon or if the icon was set by some other method (e.g., by pixbuf, stock or gicon).

Params:
GtkEntryIconPosition iconPos Icon position

Returns:
An icon name, or %NULL if no icon is set or if the icon wasn’t set from an icon name

Since:
2.16

Pixbuf getIconPixbuf (GtkEntryIconPosition iconPos);
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 #GdkPixbuf, a #GIcon, a stock item, or an icon name.

Params:
GtkEntryIconPosition iconPos Icon position

Returns:
A #GdkPixbuf, or %NULL if no icon is set for this position.

Since:
2.16

bool getIconSensitive (GtkEntryIconPosition iconPos);
Returns whether the icon appears sensitive or insensitive.

Params:
GtkEntryIconPosition iconPos Icon position

Returns:
%TRUE if the icon is sensitive.

Since:
2.16

string getIconStock (GtkEntryIconPosition iconPos);
Retrieves the stock id used for the icon, or %NULL if there is no icon or if the icon was set by some other method (e.g., by pixbuf, icon name or gicon).

Deprecated:
Use gtk_entry_get_icon_name() instead.

Params:
GtkEntryIconPosition iconPos Icon position

Returns:
A stock id, or %NULL if no icon is set or if the icon wasn’t set from a stock id

Since:
2.16

GtkImageType getIconStorageType (GtkEntryIconPosition iconPos);
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.

Params:
GtkEntryIconPosition iconPos Icon position

Returns:
image representation being used

Since:
2.16

string getIconTooltipMarkup (GtkEntryIconPosition iconPos);
Gets the contents of the tooltip on the icon at the specified position in @entry.

Params:
GtkEntryIconPosition iconPos the icon position

Returns:
the tooltip text, or %NULL. Free the returned string with g_free() when done.

Since:
2.16

string getIconTooltipText (GtkEntryIconPosition iconPos);
Gets the contents of the tooltip on the icon at the specified position in @entry.

Params:
GtkEntryIconPosition iconPos the icon position

Returns:
the tooltip text, or %NULL. Free the returned string with g_free() when done.

Since:
2.16

Border getInnerBorder ();
This function returns the entry’s #GtkEntry:inner-border property. See gtk_entry_set_inner_border() for more information.

Deprecated:
Use the standard border and padding CSS properties (through objects like #GtkStyleContext and #GtkCssProvider); the value returned by this function is ignored by #GtkEntry.

Returns:
the entry’s #GtkBorder, or %NULL if none was set.

Since:
2.10

GtkInputHints getInputHints ();
Gets the value of the #GtkEntry:input-hints property.

Since:
3.6

GtkInputPurpose getInputPurpose ();
Gets the value of the #GtkEntry:input-purpose property.

Since:
3.6

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

Returns:
the current invisible char, or 0, if the entry does not show invisible text at all.

PgLayout getLayout ();
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.

Returns:
the #PangoLayout for this entry

void getLayoutOffsets (out int x, out int 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.

Params:
int x location to store X offset of layout, or %NULL
int y location to store Y offset of layout, or %NULL

int getMaxLength ();
Retrieves the maximum allowed length of the text in @entry. See gtk_entry_set_max_length().

This is equivalent to:

|[ GtkEntryBuffer *buffer; buffer = gtk_entry_get_buffer (entry); gtk_entry_buffer_get_max_length (buffer); ]|

Returns:
the maximum allowed number of characters in #GtkEntry, or 0 if there is no maximum.

int getMaxWidthChars ();
Retrieves the desired maximum width of @entry, in characters. See gtk_entry_set_max_width_chars().

Returns:
the maximum width of the entry, in characters

Since:
3.12

bool getOverwriteMode ();
Gets the value set by gtk_entry_set_overwrite_mode().

Returns:
whether the text is overwritten when typing.

Since:
2.14

string getPlaceholderText ();
Retrieves the text that will be displayed when @entry is empty and unfocused

Returns:
a pointer to the placeholder text as a string. This string points to internally allocated storage in the widget and must not be freed, modified or stored.

Since:
3.2

double getProgressFraction ();
Returns the current fraction of the task that’s been completed. See gtk_entry_set_progress_fraction().

Returns:
a fraction from 0.0 to 1.0

Since:
2.16

double getProgressPulseStep ();
Retrieves the pulse step set with gtk_entry_set_progress_pulse_step().

Returns:
a fraction from 0.0 to 1.0

Since:
2.16

PgTabArray getTabs ();
Gets the tabstops that were set on the entry using gtk_entry_set_tabs(), if any.

Returns:
the tabstops, or %NULL if none was set.

Since:
3.10

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

This is equivalent to:

|[ GtkEntryBuffer *buffer; buffer = gtk_entry_get_buffer (entry); gtk_entry_buffer_get_text (buffer); ]|

Returns:
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.

void getTextArea (out GdkRectangle textArea);
Gets the area where the entry’s text is drawn. This function is useful when drawing something to the entry in a draw callback.

If the entry is not realized, @text_area is filled with zeros.

See also gtk_entry_get_icon_area().

Params:
GdkRectangle textArea Return location for the text area.

Since:
3.0

ushort getTextLength ();
Retrieves the current length of the text in @entry.

This is equivalent to:

|[ GtkEntryBuffer *buffer; buffer = gtk_entry_get_buffer (entry); gtk_entry_buffer_get_length (buffer); ]|

Returns:
the current number of characters in #GtkEntry, or 0 if there are none.

Since:
2.14

bool getVisibility ();
Retrieves whether the text in @entry is visible. See gtk_entry_set_visibility().

Returns:
%TRUE if the text is currently visible

int getWidthChars ();
Gets the value set by gtk_entry_set_width_chars().

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

void grabFocusWithoutSelecting ();
Causes @entry to have keyboard focus.

It behaves like gtk_widget_grab_focus(), except that it doesn't select the contents of the entry. You only want to call this on some special entries which the user usually doesn't want to replace all text in, such as search-as-you-type entries.

Since:
3.16

bool imContextFilterKeypress (GdkEventKey* event);
Allow the #GtkEntry 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_im_context_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 #GtkEntry. See gtk_text_view_reset_im_context() for an example of use.

Params:
GdkEventKey* event the key event

Returns:
%TRUE if the input method handled the key event.

Since:
2.22

int layoutIndexToTextIndex (int layoutIndex);
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()).

Params:
int layoutIndex byte index into the entry layout text

Returns:
byte index into the entry contents

void progressPulse ();
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()).

Since:
2.16

void resetImContext ();
Reset the input method context of the entry if needed.

This can be necessary in the case where modifying the buffer would confuse on-going input method behavior.

Since:
2.22

void setActivatesDefault (bool 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 #GtkEntry::activate signal.)

Params:
bool setting %TRUE to activate window’s default widget on Enter keypress

void setAlignment (float 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.

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

Since:
2.4

void setAttributes (PgAttributeList attrs);
Sets a #PangoAttrList; the attributes in the list are applied to the entry text.

Params:
PgAttributeList attrs a #PangoAttrList

Since:
3.6

void setBuffer (EntryBuffer buffer);
Set the #GtkEntryBuffer object which holds the text for this widget.

Params:
EntryBuffer buffer a #GtkEntryBuffer

Since:
2.18

void setCompletion (EntryCompletion 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.

Params:
EntryCompletion completion The #GtkEntryCompletion or %NULL

Since:
2.4

void setCursorHadjustment (Adjustment 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.

Params:
Adjustment adjustment an adjustment which should be adjusted when the cursor is moved, or %NULL

Since:
2.12

void setHasFrame (bool setting);
Sets whether the entry has a beveled frame around it.

Params:
bool setting new value

void setIconActivatable (GtkEntryIconPosition iconPos, bool activatable);
Sets whether the icon is activatable.

Params:
GtkEntryIconPosition iconPos Icon position
bool activatable %TRUE if the icon should be activatable

Since:
2.16

void setIconDragSource (GtkEntryIconPosition iconPos, TargetList targetList, GdkDragAction actions);
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 #GtkWidget::drag-data-get (or possibly #GtkWidget::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 #GtkWidget::drag-begin signal to set a different icon. Note that you have to use g_signal_connect_after() to ensure that your signal handler gets executed after the default handler.

Params:
GtkEntryIconPosition iconPos icon position
TargetList targetList the targets (data formats) in which the data can be provided
GdkDragAction actions a bitmask of the allowed drag actions

Since:
2.16

void setIconFromGicon (GtkEntryIconPosition iconPos, IconIF icon);
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 %NULL, no icon will be shown in the specified position.

Params:
GtkEntryIconPosition iconPos The position at which to set the icon
IconIF icon The icon to set, or %NULL

Since:
2.16

void setIconFromIconName (GtkEntryIconPosition iconPos, string iconName);
Sets the icon shown in the entry at the specified position from the current icon theme.

If the icon name isn’t known, a “broken image” icon will be displayed instead.

If @icon_name is %NULL, no icon will be shown in the specified position.

Params:
GtkEntryIconPosition iconPos The position at which to set the icon
string iconName An icon name, or %NULL

Since:
2.16

void setIconFromPixbuf (GtkEntryIconPosition iconPos, Pixbuf pixbuf);
Sets the icon shown in the specified position using a pixbuf.

If @pixbuf is %NULL, no icon will be shown in the specified position.

Params:
GtkEntryIconPosition iconPos Icon position
Pixbuf pixbuf A #GdkPixbuf, or %NULL

Since:
2.16

void setIconFromStock (GtkEntryIconPosition iconPos, string stockId);
Sets the icon shown in the entry at the specified position from a stock image.

If @stock_id is %NULL, no icon will be shown in the specified position.

Deprecated:
Use gtk_entry_set_icon_from_icon_name() instead.

Params:
GtkEntryIconPosition iconPos Icon position
string stockId The name of the stock item, or %NULL

Since:
2.16

void setIconSensitive (GtkEntryIconPosition iconPos, bool sensitive);
Sets the sensitivity for the specified icon.

Params:
GtkEntryIconPosition iconPos Icon position
bool sensitive Specifies whether the icon should appear sensitive or insensitive

Since:
2.16

void setIconTooltipMarkup (GtkEntryIconPosition iconPos, string tooltip);
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][PangoMarkupFormat].

Use %NULL for @tooltip to remove an existing tooltip.

See also gtk_widget_set_tooltip_markup() and gtk_entry_set_icon_tooltip_text().

Params:
GtkEntryIconPosition iconPos the icon position
string tooltip the contents of the tooltip for the icon, or %NULL

Since:
2.16

void setIconTooltipText (GtkEntryIconPosition iconPos, string tooltip);
Sets @tooltip as the contents of the tooltip for the icon at the specified position.

Use %NULL for @tooltip to remove an existing tooltip.

See also gtk_widget_set_tooltip_text() and gtk_entry_set_icon_tooltip_markup().

Params:
GtkEntryIconPosition iconPos the icon position
string tooltip the contents of the tooltip for the icon, or %NULL

Since:
2.16

void setInnerBorder (Border 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.

Deprecated:
Use the standard border and padding CSS properties (through objects like #GtkStyleContext and #GtkCssProvider); the value set with this function is ignored by #GtkEntry.

Params:
Border border a #GtkBorder, or %NULL

Since:
2.10

void setInputHints (GtkInputHints hints);
Sets the #GtkEntry:input-hints property, which allows input methods to fine-tune their behaviour.

Params:
GtkInputHints hints the hints

Since:
3.6

void setInputPurpose (GtkInputPurpose purpose);
Sets the #GtkEntry:input-purpose property which can be used by on-screen keyboards and other input methods to adjust their behaviour.

Params:
GtkInputPurpose purpose the purpose

Since:
3.6

void setInvisibleChar (dchar 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. By default, GTK+ picks the best invisible char available in the current font. 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.

Params:
dchar ch a Unicode character

void setMaxLength (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.

This is equivalent to:

|[ GtkEntryBuffer *buffer; buffer = gtk_entry_get_buffer (entry); gtk_entry_buffer_set_max_length (buffer, max); ]|

Params:
int 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.

void setMaxWidthChars (int nChars);
Sets the desired maximum width in characters of @entry.

Params:
int nChars the new desired maximum width, in characters

Since:
3.12

void setOverwriteMode (bool overwrite);
Sets whether the text is overwritten when typing in the #GtkEntry.

Params:
bool overwrite new value

Since:
2.14

void setPlaceholderText (string text);
Sets text to be displayed in @entry when it is empty and unfocused. This can be used to give a visual hint of the expected contents of the #GtkEntry.

Note that since the placeholder text gets removed when the entry received focus, using this feature is a bit problematic if the entry is given the initial focus in a window. Sometimes this can be worked around by delaying the initial focus setting until the first key event arrives.

Params:
string text a string to be displayed when @entry is empty and unfocused, or %NULL

Since:
3.2

void setProgressFraction (double fraction);
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.

Params:
double fraction fraction of the task that’s been completed

Since:
2.16

void setProgressPulseStep (double fraction);
Sets the fraction of total entry width to move the progress bouncing block for each call to gtk_entry_progress_pulse().

Params:
double fraction fraction between 0.0 and 1.0

Since:
2.16

void setTabs (PgTabArray tabs);
Sets a #PangoTabArray; the tabstops in the array are applied to the entry text.

Params:
PgTabArray tabs a #PangoTabArray

Since:
3.10

void setText (string text);
Sets the text in the widget to the given value, replacing the current contents.

See gtk_entry_buffer_set_text().

Params:
string text the new text

void setVisibility (bool 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.

By default, GTK+ picks the best invisible character available in the current font, but it can be changed with gtk_entry_set_invisible_char().

Note that you probably want to set #GtkEntry:input-purpose to %GTK_INPUT_PURPOSE_PASSWORD or %GTK_INPUT_PURPOSE_PIN to inform input methods about the purpose of this entry, in addition to setting visibility to %FALSE.

Params:
bool visible %TRUE if the contents of the entry are displayed as plaintext

void setWidthChars (int nChars);
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.

Params:
int nChars width in chars

int textIndexToLayoutIndex (int textIndex);
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()).

Params:
int textIndex byte index into the entry contents

Returns:
byte index into the entry layout text

void unsetInvisibleChar ();
Unsets the invisible char previously set with gtk_entry_set_invisible_char(). So that the default invisible char is used again.

Since:
2.16

gulong addOnActivate (void delegate(Entry) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::activate signal is emitted when the user hits the Enter key.

While this signal is used as a [keybinding signal][GtkBindingSignal], it is also commonly used by applications to intercept activation of entries.

The default bindings for this signal are all forms of the Enter key.

gulong addOnBackspace (void delegate(Entry) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::backspace signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it.

The default bindings for this signal are Backspace and Shift-Backspace.

gulong addOnCopyClipboard (void delegate(Entry) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::copy-clipboard signal is a [keybinding signal][GtkBindingSignal] which gets emitted to copy the selection to the clipboard.

The default bindings for this signal are Ctrl-c and Ctrl-Insert.

gulong addOnCutClipboard (void delegate(Entry) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::cut-clipboard signal is a [keybinding signal][GtkBindingSignal] which gets emitted to cut the selection to the clipboard.

The default bindings for this signal are Ctrl-x and Shift-Delete.

gulong addOnDeleteFromCursor (void delegate(GtkDeleteType, int, Entry) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::delete-from-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a text deletion.

If the @type is %GTK_DELETE_CHARS, GTK+ deletes the selection if there is one, otherwise it deletes the requested number of characters.

The default bindings for this signal are Delete for deleting a character and Ctrl-Delete for deleting a word.

Params:
type the granularity of the deletion, as a #GtkDeleteType
count the number of @type units to delete

gulong addOnIconPress (void delegate(GtkEntryIconPosition, GdkEventButton*, Entry) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::icon-press signal is emitted when an activatable icon is clicked.

Params:
iconPos The position of the clicked icon
event the button press event

Since:
2.16

gulong addOnIconPress (void delegate(GtkEntryIconPosition, Event, Entry) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::icon-press signal is emitted when an activatable icon is clicked.

Params:
iconPos The position of the clicked icon
event the button press event

Since:
2.16

gulong addOnIconRelease (void delegate(GtkEntryIconPosition, GdkEventButton*, Entry) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::icon-release signal is emitted on the button release from a mouse click over an activatable icon.

Params:
iconPos The position of the clicked icon
event the button release event

Since:
2.16

gulong addOnIconRelease (void delegate(GtkEntryIconPosition, Event, Entry) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::icon-release signal is emitted on the button release from a mouse click over an activatable icon.

Params:
iconPos The position of the clicked icon
event the button release event

Since:
2.16

gulong addOnInsertAtCursor (void delegate(string, Entry) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::insert-at-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates the insertion of a fixed string at the cursor.

This signal has no default bindings.

Params:
str the string to insert

gulong addOnMoveCursor (void delegate(GtkMovementStep, int, bool, Entry) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::move-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a cursor movement. If the cursor is not visible in @entry, this signal causes the viewport to be moved instead.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically.

The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifer does not. There are too many key combinations to list them all here. - Arrow keys move by individual characters/lines - Ctrl-arrow key combinations move by words/paragraphs - Home/End keys move to the ends of the buffer

Params:
step the granularity of the move, as a #GtkMovementStep
count the number of @step units to move
extendSelection %TRUE if the move should extend the selection

gulong addOnPasteClipboard (void delegate(Entry) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::paste-clipboard signal is a [keybinding signal][GtkBindingSignal] which gets emitted to paste the contents of the clipboard into the text view.

The default bindings for this signal are Ctrl-v and Shift-Insert.

gulong addOnPopulatePopup (void delegate(Widget, Entry) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::populate-popup signal gets emitted before showing the context menu of the entry.

If you need to add items to the context menu, connect to this signal and append your items to the @widget, which will be a #GtkMenu in this case.

If #GtkEntry:populate-all is %TRUE, this signal will also be emitted to populate touch popups. In this case, @widget will be a different container, e.g. a #GtkToolbar. The signal handler should not make assumptions about the type of @widget.

Params:
widget the container that is being populated

gulong addOnPreeditChanged (void delegate(string, Entry) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
If 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.

Params:
preedit the current preedit string

Since:
2.20

gulong addOnToggleOverwrite (void delegate(Entry) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::toggle-overwrite signal is a [keybinding signal][GtkBindingSignal] which gets emitted to toggle the overwrite mode of the entry.

The default bindings for this signal is Insert.

Page was generated with on Sun Apr 23 22:52:56 2017