The Gtk.GEntry.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.
When using an entry for passwords and other sensitive information, it can be put into "password mode" using Gtk.GEntry.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.GEntry.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 Gtk.GEntry.Gtk_Entry: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.GEntry.Set_Progress_Fraction or Gtk.GEntry.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.GEntry.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 Gtk.GEntry.Gtk_Entry::icon-press signal. To allow DND operations from an icon, use Gtk.GEntry.Set_Icon_Drag_Source. To set a tooltip on an icon, use Gtk.GEntry.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[.read-only][.flat][.warning][.error]
├── 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.
A Gtk_Entry is a single line text editing widget. The text is automatically scrolled if it is longer than can be displayed on the screen, so that the cursor position is visible at all times.
See Gtk_Text_View for a multiple-line text editing widget.
<screenshot>gtk-gentry</screenshot> <group>Numeric/Text Data Entry</group> <testgtk>create_entry.adb</testgtk>
function "+"
(Widget : access Gtk_Entry_Record'Class)
return Gtk.Buildable.Gtk_Buildable
function "+"
(Widget : access Gtk_Entry_Record'Class)
return Gtk.Cell_Editable.Gtk_Cell_Editable
function "+"
(Widget : access Gtk_Entry_Record'Class)
return Gtk.Editable.Gtk_Editable
function "-"
(Interf : Gtk.Buildable.Gtk_Buildable)
return Gtk_Entry
function "-"
(Interf : Gtk.Cell_Editable.Gtk_Cell_Editable)
return Gtk_Entry
function "-"
(Interf : Gtk.Editable.Gtk_Editable)
return Gtk_Entry
Activates_Default_Property : constant Glib.Properties.Property_Boolean;
Attributes_Property : constant Glib.Properties.Property_Object;
Type: Pango.Attributes.Pango_Attr_List A list of Pango attributes to apply to the text of the entry.
This is mainly useful to change the size or weight of the text.
The Pango.Attributes.Pango_Attribute's Start_Index and End_Index must refer to the Gtk.Entry_Buffer.Gtk_Entry_Buffer text, i.e. without the preedit string.
Buffer_Property : constant Glib.Properties.Property_Object;
Type: Gtk.Entry_Buffer.Gtk_Entry_Buffer
Caps_Lock_Warning_Property : constant Glib.Properties.Property_Boolean;
Whether password entries will show a warning when Caps Lock is on.
Note that the warning is shown using a secondary icon, and thus does not work if you are using the secondary icon position for some other purpose.
type Cb_GObject_Gtk_Delete_Type_Gint_Void is not null access procedure
(Self : access Glib.Object.GObject_Record'Class;
The_Type : Gtk.Enums.Gtk_Delete_Type;
Count : Glib.Gint);
type Cb_GObject_Gtk_Entry_Icon_Position_Void is not null access procedure
(Self : access Glib.Object.GObject_Record'Class;
Icon_Pos : Gtk_Entry_Icon_Position);
type Cb_GObject_Gtk_Movement_Step_Gint_Boolean_Void is not null access procedure
(Self : access Glib.Object.GObject_Record'Class;
Step : Gtk.Enums.Gtk_Movement_Step;
Count : Glib.Gint;
Extend_Selection : Boolean);
type Cb_GObject_Gtk_Widget_Void is not null access procedure
(Self : access Glib.Object.GObject_Record'Class;
Widget : not null access Gtk.Widget.Gtk_Widget_Record'Class);
type Cb_GObject_UTF8_String_Void is not null access procedure
(Self : access Glib.Object.GObject_Record'Class;
String : UTF8_String);
type Cb_GObject_Void is not null access procedure
(Self : access Glib.Object.GObject_Record'Class);
type Cb_Gtk_Entry_Gtk_Delete_Type_Gint_Void is not null access procedure
(Self : access Gtk_Entry_Record'Class;
The_Type : Gtk.Enums.Gtk_Delete_Type;
Count : Glib.Gint);
type Cb_Gtk_Entry_Gtk_Entry_Icon_Position_Void is not null access procedure
(Self : access Gtk_Entry_Record'Class;
Icon_Pos : Gtk_Entry_Icon_Position);
type Cb_Gtk_Entry_Gtk_Movement_Step_Gint_Boolean_Void is not null access procedure
(Self : access Gtk_Entry_Record'Class;
Step : Gtk.Enums.Gtk_Movement_Step;
Count : Glib.Gint;
Extend_Selection : Boolean);
type Cb_Gtk_Entry_Gtk_Widget_Void is not null access procedure
(Self : access Gtk_Entry_Record'Class;
Widget : not null access Gtk.Widget.Gtk_Widget_Record'Class);
type Cb_Gtk_Entry_UTF8_String_Void is not null access procedure
(Self : access Gtk_Entry_Record'Class;
String : UTF8_String);
type Cb_Gtk_Entry_Void is not null access procedure (Self : access Gtk_Entry_Record'Class);
Completion_Property : constant Glib.Properties.Property_Object;
Type: Gtk.Entry_Completion.Gtk_Entry_Completion The auxiliary completion object to use with the entry.
procedure Copy_Clipboard (Editable : not null access Gtk_Entry_Record)
Cursor_Position_Property : constant Glib.Properties.Property_Int;
procedure Cut_Clipboard (Editable : not null access Gtk_Entry_Record)
procedure Delete_Selection (Editable : not null access Gtk_Entry_Record)
procedure Delete_Text
(Editable : not null access Gtk_Entry_Record;
Start_Pos : Glib.Gint;
End_Pos : Glib.Gint := -1)
Editable_Property : constant Glib.Properties.Property_Boolean;
procedure Editing_Done (Cell_Editable : not null access Gtk_Entry_Record)
Enable_Emoji_Completion_Property : constant Glib.Properties.Property_Boolean;
function Get_Activates_Default
(The_Entry : not null access Gtk_Entry_Record) return Boolean
Retrieves the value set by Gtk.GEntry.Set_Activates_Default.
True if the entry will activate the default widget
function Get_Alignment
(The_Entry : not null access Gtk_Entry_Record) return Gfloat
Gets the value set by Gtk.GEntry.Set_Alignment. Since: gtk+ 2.4
the alignment
function Get_Attributes
(The_Entry : not null access Gtk_Entry_Record)
return Pango.Attributes.Pango_Attr_List
Gets the attribute list that was set on the entry using Gtk.GEntry.Set_Attributes, if any. Since: gtk+ 3.6
the attribute list, or null if none was set.
function Get_Buffer
(The_Entry : not null access Gtk_Entry_Record)
return Gtk.Entry_Buffer.Gtk_Entry_Buffer
Get the Gtk.Entry_Buffer.Gtk_Entry_Buffer object which holds the text for this widget. Since: gtk+ 2.18
A Gtk.Entry_Buffer.Gtk_Entry_Buffer object.
function Get_Chars
(Editable : not null access Gtk_Entry_Record;
Start_Pos : Glib.Gint;
End_Pos : Glib.Gint := -1) return UTF8_String
function Get_Completion
(The_Entry : not null access Gtk_Entry_Record)
return Gtk.Entry_Completion.Gtk_Entry_Completion
Returns the auxiliary completion object currently in use by Entry. Since: gtk+ 2.4
The auxiliary completion object currently in use by Entry.
function Get_Current_Icon_Drag_Source
(The_Entry : not null access Gtk_Entry_Record) return Glib.Gint
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 Gtk.Widget.Gtk_Widget::drag-data-get callback. Since: gtk+ 2.16
index of the icon which is the source of the current DND operation, or -1.
function Get_Cursor_Hadjustment
(The_Entry : not null access Gtk_Entry_Record)
return Gtk.Adjustment.Gtk_Adjustment
Retrieves the horizontal cursor adjustment for the entry. See Gtk.GEntry.Set_Cursor_Hadjustment. Since: gtk+ 2.12
the horizontal cursor adjustment, or null if none has been set.
function Get_Editable
(Editable : not null access Gtk_Entry_Record) return Boolean
function Get_Has_Frame
(The_Entry : not null access Gtk_Entry_Record) return Boolean
Gets the value set by Gtk.GEntry.Set_Has_Frame.
whether the entry has a beveled frame
function Get_Icon_Activatable
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position) return Boolean
Returns whether the icon is activatable. Since: gtk+ 2.16
Icon position
True if the icon is activatable.
procedure Get_Icon_Area
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position;
Icon_Area : out Gdk.Rectangle.Gdk_Rectangle)
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. Otherwise, Icon_Area will be filled with the icon's allocation, relative to Entry's allocation. See also Gtk.GEntry.Get_Text_Area Since: gtk+ 3.0
Icon position
Return location for the icon's area
function Get_Icon_At_Pos
(The_Entry : not null access Gtk_Entry_Record;
X : Glib.Gint;
Y : Glib.Gint) return Glib.Gint
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 Gtk.Widget.Gtk_Widget::query-tooltip signal handler. Since: gtk+ 2.16
the x coordinate of the position to find
the y coordinate of the position to find
the index of the icon at the given position, or -1
function Get_Icon_Gicon
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position) return Glib.G_Icon.G_Icon
Retrieves the Glib.G_Icon.G_Icon 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). Since: gtk+ 2.16
Icon position
A Glib.G_Icon.G_Icon, or null if no icon is set or if the icon is not a Glib.G_Icon.G_Icon
function Get_Icon_Name
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position) return UTF8_String
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). Since: gtk+ 2.16
Icon position
An icon name, or null if no icon is set or if the icon wasn't set from an icon name
function Get_Icon_Pixbuf
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position) return Gdk.Pixbuf.Gdk_Pixbuf
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 Gdk.Pixbuf.Gdk_Pixbuf, a Glib.G_Icon.G_Icon, a stock item, or an icon name. Since: gtk+ 2.16
Icon position
A Gdk.Pixbuf.Gdk_Pixbuf, or null if no icon is set for this position.
function Get_Icon_Sensitive
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position) return Boolean
Returns whether the icon appears sensitive or insensitive. Since: gtk+ 2.16
Icon position
True if the icon is sensitive.
function Get_Icon_Stock
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position) return UTF8_String
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). Since: gtk+ 2.16 Deprecated since 3.10, 1
Icon position
A stock id, or null if no icon is set or if the icon wasn't set from a stock id
function Get_Icon_Storage_Type
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position) return Gtk.Image.Gtk_Image_Type
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.Image_Empty. Since: gtk+ 2.16
Icon position
image representation being used
function Get_Icon_Tooltip_Markup
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position) return UTF8_String
Gets the contents of the tooltip on the icon at the specified position in Entry. Since: gtk+ 2.16
the icon position
the tooltip text, or null. Free the returned string with g_free when done.
function Get_Icon_Tooltip_Text
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position) return UTF8_String
Gets the contents of the tooltip on the icon at the specified position in Entry. Since: gtk+ 2.16
the icon position
the tooltip text, or null. Free the returned string with g_free when done.
function Get_Inner_Border
(The_Entry : not null access Gtk_Entry_Record)
return Gtk.Style.Gtk_Border
This function returns the entry's Gtk.GEntry.Gtk_Entry:inner-border property. See Gtk.GEntry.Set_Inner_Border for more information. Since: gtk+ 2.10 Deprecated since 3.4, 1
the entry's Gtk.Style.Gtk_Border, or null if none was set.
function Get_Input_Hints
(The_Entry : not null access Gtk_Entry_Record)
return Gtk.Enums.Gtk_Input_Hints
Gets the value of the Gtk.GEntry.Gtk_Entry:input-hints property. Since: gtk+ 3.6
function Get_Input_Purpose
(The_Entry : not null access Gtk_Entry_Record)
return Gtk.Enums.Gtk_Input_Purpose
Gets the value of the Gtk.GEntry.Gtk_Entry:input-purpose property. Since: gtk+ 3.6
function Get_Invisible_Char
(The_Entry : not null access Gtk_Entry_Record) return Gunichar
Retrieves the character displayed in place of the real characters for entries with visibility set to false. See Gtk.GEntry.Set_Invisible_Char.
the current invisible char, or 0, if the entry does not show invisible text at all.
function Get_Layout
(The_Entry : not null access Gtk_Entry_Record)
return Pango.Layout.Pango_Layout
Gets the Pango.Layout.Pango_Layout used to display the entry. The layout is useful to e.g. convert text positions to pixel positions, in combination with Gtk.GEntry.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.GEntry.Layout_Index_To_Text_Index and Gtk.GEntry.Text_Index_To_Layout_Index are needed to convert byte indices in the layout to byte indices in the entry contents.
the Pango.Layout.Pango_Layout for this entry
procedure Get_Layout_Offsets
(The_Entry : not null access Gtk_Entry_Record;
X : out Glib.Gint;
Y : out Glib.Gint)
Obtains the position of the Pango.Layout.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.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.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.GEntry.Layout_Index_To_Text_Index and Gtk.GEntry.Text_Index_To_Layout_Index are needed to convert byte indices in the layout to byte indices in the entry contents.
location to store X offset of layout, or null
location to store Y offset of layout, or null
function Get_Max_Length
(The_Entry : not null access Gtk_Entry_Record) return Glib.Gint
Retrieves the maximum allowed length of the text in Entry. See Gtk.GEntry.Set_Max_Length. This is equivalent to getting Entry's Gtk.Entry_Buffer.Gtk_Entry_Buffer and calling Gtk.Entry_Buffer.Get_Max_Length on it.
the maximum allowed number of characters in Gtk.GEntry.Gtk_Entry, or 0 if there is no maximum.
function Get_Max_Width_Chars
(The_Entry : not null access Gtk_Entry_Record) return Glib.Gint
Retrieves the desired maximum width of Entry, in characters. See Gtk.GEntry.Set_Max_Width_Chars. Since: gtk+ 3.12
the maximum width of the entry, in characters
function Get_Overwrite_Mode
(The_Entry : not null access Gtk_Entry_Record) return Boolean
Gets the value set by Gtk.GEntry.Set_Overwrite_Mode. Since: gtk+ 2.14
whether the text is overwritten when typing.
function Get_Placeholder_Text
(The_Entry : not null access Gtk_Entry_Record) return UTF8_String
Retrieves the text that will be displayed when Entry is empty and unfocused Since: gtk+ 3.2
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.
function Get_Position
(Editable : not null access Gtk_Entry_Record) return Glib.Gint
function Get_Progress_Fraction
(The_Entry : not null access Gtk_Entry_Record) return Gdouble
Returns the current fraction of the task that's been completed. See Gtk.GEntry.Set_Progress_Fraction. Since: gtk+ 2.16
a fraction from 0.0 to 1.0
function Get_Progress_Pulse_Step
(The_Entry : not null access Gtk_Entry_Record) return Gdouble
Retrieves the pulse step set with Gtk.GEntry.Set_Progress_Pulse_Step. Since: gtk+ 2.16
a fraction from 0.0 to 1.0
procedure Get_Selection_Bounds
(Editable : not null access Gtk_Entry_Record;
Start_Pos : out Glib.Gint;
End_Pos : out Glib.Gint;
Has_Selection : out Boolean)
function Get_Tabs
(The_Entry : not null access Gtk_Entry_Record)
return Pango.Tabs.Pango_Tab_Array
Gets the tabstops that were set on the entry using Gtk.GEntry.Set_Tabs, if any. Since: gtk+ 3.10
the tabstops, or null if none was set.
function Get_Text
(The_Entry : not null access Gtk_Entry_Record) return UTF8_String
Retrieves the contents of the entry widget. See also Gtk.Editable.Get_Chars. This is equivalent to getting Entry's Gtk.Entry_Buffer.Gtk_Entry_Buffer and calling Gtk.Entry_Buffer.Get_Text on it.
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.
procedure Get_Text_Area
(The_Entry : not null access Gtk_Entry_Record;
Text_Area : out Gdk.Rectangle.Gdk_Rectangle)
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.GEntry.Get_Icon_Area. Since: gtk+ 3.0
Return location for the text area.
function Get_Text_Length
(The_Entry : not null access Gtk_Entry_Record) return Guint16
Retrieves the current length of the text in Entry. This is equivalent to getting Entry's Gtk.Entry_Buffer.Gtk_Entry_Buffer and calling Gtk.Entry_Buffer.Get_Length on it. Since: gtk+ 2.14
the current number of characters in Gtk.GEntry.Gtk_Entry, or 0 if there are none.
function Get_Type return Glib.GType
function Get_Visibility
(The_Entry : not null access Gtk_Entry_Record) return Boolean
Retrieves whether the text in Entry is visible. See Gtk.GEntry.Set_Visibility.
True if the text is currently visible
function Get_Width_Chars
(The_Entry : not null access Gtk_Entry_Record) return Glib.Gint
Gets the value set by Gtk.GEntry.Set_Width_Chars.
number of chars to request space for, or negative if unset
procedure Grab_Focus_Without_Selecting
(The_Entry : not null access Gtk_Entry_Record)
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: gtk+ 3.16
type Gtk_Entry is access all Gtk_Entry_Record'Class;
type Gtk_Entry_Icon_Position is (
Gtk_Entry_Icon_Primary,
Gtk_Entry_Icon_Secondary);
Specifies the side of the entry at which an icon is placed.
package Gtk_Entry_Icon_Position_Properties is
new Generic_Internal_Discrete_Property (Gtk_Entry_Icon_Position);
function Gtk_Entry_New return Gtk_Entry
Creates a new entry.
function Gtk_Entry_New_With_Buffer
(Buffer : not null access Gtk.Entry_Buffer.Gtk_Entry_Buffer_Record'Class)
return Gtk_Entry
Creates a new entry with the specified text buffer. Since: gtk+ 2.18
The buffer to use for the new Gtk.GEntry.Gtk_Entry.
type Gtk_Entry_Record is new Gtk_Widget_Record with null record;
subtype Gtk_GEntry is Gtk_Entry;
procedure Gtk_New (The_Entry : out Gtk_Entry)
Creates a new entry. Initialize does nothing if the object was already created with another call to Initialize* or G_New.
procedure Gtk_New_With_Buffer
(The_Entry : out Gtk_Entry;
Buffer : not null access Gtk.Entry_Buffer.Gtk_Entry_Buffer_Record'Class)
Creates a new entry with the specified text buffer. Since: gtk+ 2.18 Initialize_With_Buffer does nothing if the object was already created with another call to Initialize* or G_New.
The buffer to use for the new Gtk.GEntry.Gtk_Entry.
Has_Frame_Property : constant Glib.Properties.Property_Boolean;
function Im_Context_Filter_Keypress
(The_Entry : not null access Gtk_Entry_Record;
Event : Gdk.Event.Gdk_Event_Key) return Boolean
Allow the Gtk.GEntry.Gtk_Entry 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 Gtk.GEntry.Gtk_Entry. See Gtk.Text_View.Reset_Im_Context for an example of use. Since: gtk+ 2.22
the key event
True if the input method handled the key event.
Im_Module_Property : constant Glib.Properties.Property_String;
Which IM (input method) module should be used for this entry. See Gtk.IM_Context.Gtk_IM_Context.
Setting this to a non-null value overrides the system-wide IM module setting. See the GtkSettings Gtk.Settings.Gtk_Settings:gtk-im-module property.
package Implements_Gtk_Buildable is new Glib.Types.Implements
(Gtk.Buildable.Gtk_Buildable, Gtk_Entry_Record, Gtk_Entry);
package Implements_Gtk_Cell_Editable is new Glib.Types.Implements
(Gtk.Cell_Editable.Gtk_Cell_Editable, Gtk_Entry_Record, Gtk_Entry);
package Implements_Gtk_Editable is new Glib.Types.Implements
(Gtk.Editable.Gtk_Editable, Gtk_Entry_Record, Gtk_Entry);
procedure Initialize (The_Entry : not null access Gtk_Entry_Record'Class)
Creates a new entry. Initialize does nothing if the object was already created with another call to Initialize* or G_New.
procedure Initialize_With_Buffer
(The_Entry : not null access Gtk_Entry_Record'Class;
Buffer : not null access Gtk.Entry_Buffer.Gtk_Entry_Buffer_Record'Class)
Creates a new entry with the specified text buffer. Since: gtk+ 2.18 Initialize_With_Buffer does nothing if the object was already created with another call to Initialize* or G_New.
The buffer to use for the new Gtk.GEntry.Gtk_Entry.
Inner_Border_Property : constant Glib.Properties.Property_Boxed;
Type: Gtk.Style.Gtk_Border Sets the text area's border between the text and the frame.
Input_Hints_Property : constant Gtk.Enums.Property_Gtk_Input_Hints;
Additional hints (beyond Gtk.GEntry.Gtk_Entry:input-purpose) that allow input methods to fine-tune their behaviour.
Input_Purpose_Property : constant Gtk.Enums.Property_Gtk_Input_Purpose;
The purpose of this text field.
This property can be used by on-screen keyboards and other input methods to adjust their behaviour.
Note that setting the purpose to Gtk.Enums.Input_Purpose_Password or Gtk.Enums.Input_Purpose_Pin is independent from setting Gtk.GEntry.Gtk_Entry:visibility.
procedure Insert_Text
(Editable : access Gtk_Entry_Record;
New_Text : UTF8_String;
Position : in out Gint)
Convenience subprogram, identical to Insert_Text above without the requirement to supply the New_Text_Length argument.
procedure Insert_Text
(Editable : not null access Gtk_Entry_Record;
New_Text : UTF8_String;
New_Text_Length : Glib.Gint;
Position : in out Glib.Gint)
Invisible_Char_Property : constant Glib.Properties.Property_Uint;
The invisible character is used when masking entry contents (in \"password mode\")"). When it is not explicitly set with the Gtk.GEntry.Gtk_Entry:invisible-char property, GTK+ determines the character to use from a list of possible candidates, depending on availability in the current font.
This style property allows the theme to prepend a character to the list of candidates.
Invisible_Char_Set_Property : constant Glib.Properties.Property_Boolean;
Whether the invisible char has been set for the Gtk.GEntry.Gtk_Entry.
function Layout_Index_To_Text_Index
(The_Entry : not null access Gtk_Entry_Record;
Layout_Index : Glib.Gint) return Glib.Gint
Converts from a position in the entry's Pango.Layout.Pango_Layout (returned by Gtk.GEntry.Get_Layout) to a position in the entry contents (returned by Gtk.GEntry.Get_Text).
byte index into the entry layout text
byte index into the entry contents
Max_Length_Property : constant Glib.Properties.Property_Int;
Max_Width_Chars_Property : constant Glib.Properties.Property_Int;
The desired maximum width of the entry, in characters. If this property is set to -1, the width will be calculated automatically.
procedure On_Activate
(Self : not null access Gtk_Entry_Record;
Call : Cb_GObject_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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.
procedure On_Activate
(Self : not null access Gtk_Entry_Record;
Call : Cb_Gtk_Entry_Void;
After : Boolean := False)
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.
procedure On_Backspace
(Self : not null access Gtk_Entry_Record;
Call : Cb_GObject_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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.
procedure On_Backspace
(Self : not null access Gtk_Entry_Record;
Call : Cb_Gtk_Entry_Void;
After : Boolean := False)
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.
procedure On_Copy_Clipboard
(Self : not null access Gtk_Entry_Record;
Call : Cb_GObject_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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.
procedure On_Copy_Clipboard
(Self : not null access Gtk_Entry_Record;
Call : Cb_Gtk_Entry_Void;
After : Boolean := False)
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.
procedure On_Cut_Clipboard
(Self : not null access Gtk_Entry_Record;
Call : Cb_GObject_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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.
procedure On_Cut_Clipboard
(Self : not null access Gtk_Entry_Record;
Call : Cb_Gtk_Entry_Void;
After : Boolean := False)
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.
procedure On_Delete_From_Cursor
(Self : not null access Gtk_Entry_Record;
Call : Cb_GObject_Gtk_Delete_Type_Gint_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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.Enums.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.
Callback parameters: -- @param The_Type the granularity of the deletion, as a -- Gtk.Enums.Gtk_Delete_Type -- @param Count the number of Type units to delete
procedure On_Delete_From_Cursor
(Self : not null access Gtk_Entry_Record;
Call : Cb_Gtk_Entry_Gtk_Delete_Type_Gint_Void;
After : Boolean := False)
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.Enums.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.
Callback parameters: -- @param The_Type the granularity of the deletion, as a -- Gtk.Enums.Gtk_Delete_Type -- @param Count the number of Type units to delete
procedure On_Icon_Press
(Self : not null access Gtk_Entry_Record;
Call : Cb_GObject_Gtk_Entry_Icon_Position_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
The ::icon-press signal is emitted when an activatable icon is clicked.
procedure On_Icon_Press
(Self : not null access Gtk_Entry_Record;
Call : Cb_Gtk_Entry_Gtk_Entry_Icon_Position_Void;
After : Boolean := False)
The ::icon-press signal is emitted when an activatable icon is clicked.
procedure On_Icon_Release
(Self : not null access Gtk_Entry_Record;
Call : Cb_GObject_Gtk_Entry_Icon_Position_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
The ::icon-release signal is emitted on the button release from a mouse click over an activatable icon.
procedure On_Icon_Release
(Self : not null access Gtk_Entry_Record;
Call : Cb_Gtk_Entry_Gtk_Entry_Icon_Position_Void;
After : Boolean := False)
The ::icon-release signal is emitted on the button release from a mouse click over an activatable icon.
procedure On_Insert_At_Cursor
(Self : not null access Gtk_Entry_Record;
Call : Cb_GObject_UTF8_String_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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.
procedure On_Insert_At_Cursor
(Self : not null access Gtk_Entry_Record;
Call : Cb_Gtk_Entry_UTF8_String_Void;
After : Boolean := False)
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.
procedure On_Insert_Emoji
(Self : not null access Gtk_Entry_Record;
Call : Cb_GObject_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
The ::insert-emoji signal is a [keybinding signal][GtkBindingSignal] which gets emitted to present the Emoji chooser for the Entry.
The default bindings for this signal are Ctrl-. and Ctrl-;
procedure On_Insert_Emoji
(Self : not null access Gtk_Entry_Record;
Call : Cb_Gtk_Entry_Void;
After : Boolean := False)
The ::insert-emoji signal is a [keybinding signal][GtkBindingSignal] which gets emitted to present the Emoji chooser for the Entry.
The default bindings for this signal are Ctrl-. and Ctrl-;
procedure On_Move_Cursor
(Self : not null access Gtk_Entry_Record;
Call : Cb_GObject_Gtk_Movement_Step_Gint_Boolean_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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
Callback parameters: -- @param Step the granularity of the move, as a -- Gtk.Enums.Gtk_Movement_Step -- @param Count the number of Step units to move -- @param Extend_Selection True if the move should extend the selection
procedure On_Move_Cursor
(Self : not null access Gtk_Entry_Record;
Call : Cb_Gtk_Entry_Gtk_Movement_Step_Gint_Boolean_Void;
After : Boolean := False)
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
Callback parameters: -- @param Step the granularity of the move, as a -- Gtk.Enums.Gtk_Movement_Step -- @param Count the number of Step units to move -- @param Extend_Selection True if the move should extend the selection
procedure On_Paste_Clipboard
(Self : not null access Gtk_Entry_Record;
Call : Cb_GObject_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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.
procedure On_Paste_Clipboard
(Self : not null access Gtk_Entry_Record;
Call : Cb_Gtk_Entry_Void;
After : Boolean := False)
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.
procedure On_Populate_Popup
(Self : not null access Gtk_Entry_Record;
Call : Cb_GObject_Gtk_Widget_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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 Gtk.Menu.Gtk_Menu in this case.
If Gtk.GEntry.Gtk_Entry: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 Gtk.Toolbar.Gtk_Toolbar. The signal handler should not make assumptions about the type of Widget.
procedure On_Populate_Popup
(Self : not null access Gtk_Entry_Record;
Call : Cb_Gtk_Entry_Gtk_Widget_Void;
After : Boolean := False)
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 Gtk.Menu.Gtk_Menu in this case.
If Gtk.GEntry.Gtk_Entry: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 Gtk.Toolbar.Gtk_Toolbar. The signal handler should not make assumptions about the type of Widget.
procedure On_Preedit_Changed
(Self : not null access Gtk_Entry_Record;
Call : Cb_GObject_UTF8_String_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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.
procedure On_Preedit_Changed
(Self : not null access Gtk_Entry_Record;
Call : Cb_Gtk_Entry_UTF8_String_Void;
After : Boolean := False)
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.
procedure On_Toggle_Overwrite
(Self : not null access Gtk_Entry_Record;
Call : Cb_GObject_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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.
procedure On_Toggle_Overwrite
(Self : not null access Gtk_Entry_Record;
Call : Cb_Gtk_Entry_Void;
After : Boolean := False)
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.
Overwrite_Mode_Property : constant Glib.Properties.Property_Boolean;
If text is overwritten when typing in the Gtk.GEntry.Gtk_Entry.
procedure Paste_Clipboard (Editable : not null access Gtk_Entry_Record)
Placeholder_Text_Property : constant Glib.Properties.Property_String;
The text that will be displayed in the Gtk.GEntry.Gtk_Entry when it is empty and unfocused.
Populate_All_Property : constant Glib.Properties.Property_Boolean;
If :populate-all is True, the Gtk.GEntry.Gtk_Entry::populate-popup signal is also emitted for touch popups.
Primary_Icon_Activatable_Property : constant Glib.Properties.Property_Boolean;
Whether the primary icon is activatable.
GTK+ emits the Gtk.GEntry.Gtk_Entry::icon-press and Gtk.GEntry.Gtk_Entry::icon-release signals only on sensitive, activatable icons.
Sensitive, but non-activatable icons can be used for purely informational purposes.
Primary_Icon_Gicon_Property : constant Glib.Properties.Property_Boxed;
Type: Glib.G_Icon.G_Icon The Glib.G_Icon.G_Icon to use for the primary icon for the entry.
Primary_Icon_Name_Property : constant Glib.Properties.Property_String;
The icon name to use for the primary icon for the entry.
Primary_Icon_Pixbuf_Property : constant Glib.Properties.Property_Object;
Type: Gdk.Pixbuf.Gdk_Pixbuf A pixbuf to use as the primary icon for the entry.
Primary_Icon_Sensitive_Property : constant Glib.Properties.Property_Boolean;
Whether the primary icon is sensitive.
An insensitive icon appears grayed out. GTK+ does not emit the Gtk.GEntry.Gtk_Entry::icon-press and Gtk.GEntry.Gtk_Entry::icon-release signals and does not allow DND from insensitive icons.
An icon should be set insensitive if the action that would trigger when clicked is currently not available.
Primary_Icon_Stock_Property : constant Glib.Properties.Property_String;
The stock id to use for the primary icon for the entry.
Primary_Icon_Storage_Type_Property : constant Gtk.Image.Property_Gtk_Image_Type;
Type: Gtk.Image.Gtk_Image_Type The representation which is used for the primary icon of the entry.
Primary_Icon_Tooltip_Markup_Property : constant Glib.Properties.Property_String;
The contents of the tooltip on the primary icon, which is marked up with the [Pango text markup language][PangoMarkupFormat].
Also see Gtk.GEntry.Set_Icon_Tooltip_Markup.
Primary_Icon_Tooltip_Text_Property : constant Glib.Properties.Property_String;
The contents of the tooltip on the primary icon.
Also see Gtk.GEntry.Set_Icon_Tooltip_Text.
Progress_Fraction_Property : constant Glib.Properties.Property_Double;
Type: Gdouble The current fraction of the task that's been completed.
procedure Progress_Pulse (The_Entry : not null access Gtk_Entry_Record)
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.GEntry.Progress_Pulse causes the block to move by a little bit (the amount of movement per pulse is determined by Gtk.GEntry.Set_Progress_Pulse_Step). Since: gtk+ 2.16
Progress_Pulse_Step_Property : constant Glib.Properties.Property_Double;
Type: Gdouble The fraction of total entry width to move the progress bouncing block for each call to Gtk.GEntry.Progress_Pulse.
type Property_Gtk_Entry_Icon_Position is new Gtk_Entry_Icon_Position_Properties.Property;
procedure Remove_Widget
(Cell_Editable : not null access Gtk_Entry_Record)
procedure Reset_Im_Context (The_Entry : not null access Gtk_Entry_Record)
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: gtk+ 2.22
Scroll_Offset_Property : constant Glib.Properties.Property_Int;
Secondary_Icon_Activatable_Property : constant Glib.Properties.Property_Boolean;
Whether the secondary icon is activatable.
GTK+ emits the Gtk.GEntry.Gtk_Entry::icon-press and Gtk.GEntry.Gtk_Entry::icon-release signals only on sensitive, activatable icons.
Sensitive, but non-activatable icons can be used for purely informational purposes.
Secondary_Icon_Gicon_Property : constant Glib.Properties.Property_Boxed;
Type: Glib.G_Icon.G_Icon The Glib.G_Icon.G_Icon to use for the secondary icon for the entry.
Secondary_Icon_Name_Property : constant Glib.Properties.Property_String;
The icon name to use for the secondary icon for the entry.
Secondary_Icon_Pixbuf_Property : constant Glib.Properties.Property_Object;
Type: Gdk.Pixbuf.Gdk_Pixbuf An pixbuf to use as the secondary icon for the entry.
Secondary_Icon_Sensitive_Property : constant Glib.Properties.Property_Boolean;
Whether the secondary icon is sensitive.
An insensitive icon appears grayed out. GTK+ does not emit the Gtk.GEntry.Gtk_Entry::icon-press and Gtk.GEntry.Gtk_Entry::icon-release signals and does not allow DND from insensitive icons.
An icon should be set insensitive if the action that would trigger when clicked is currently not available.
Secondary_Icon_Stock_Property : constant Glib.Properties.Property_String;
The stock id to use for the secondary icon for the entry.
Secondary_Icon_Storage_Type_Property : constant Gtk.Image.Property_Gtk_Image_Type;
Type: Gtk.Image.Gtk_Image_Type The representation which is used for the secondary icon of the entry.
Secondary_Icon_Tooltip_Markup_Property : constant Glib.Properties.Property_String;
The contents of the tooltip on the secondary icon, which is marked up with the [Pango text markup language][PangoMarkupFormat].
Also see Gtk.GEntry.Set_Icon_Tooltip_Markup.
Secondary_Icon_Tooltip_Text_Property : constant Glib.Properties.Property_String;
The contents of the tooltip on the secondary icon.
Also see Gtk.GEntry.Set_Icon_Tooltip_Text.
procedure Select_Region
(Editable : not null access Gtk_Entry_Record;
Start_Pos : Glib.Gint;
End_Pos : Glib.Gint := -1)
Selection_Bound_Property : constant Glib.Properties.Property_Int;
procedure Set_Activates_Default
(The_Entry : not null access Gtk_Entry_Record;
Setting : Boolean)
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 Gtk.GEntry.Gtk_Entry::activate signal.)
True to activate window's default widget on Enter keypress
procedure Set_Alignment
(The_Entry : not null access Gtk_Entry_Record;
Xalign : Gfloat)
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: gtk+ 2.4
The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts
procedure Set_Attributes
(The_Entry : not null access Gtk_Entry_Record;
Attrs : Pango.Attributes.Pango_Attr_List)
Sets a Pango.Attributes.Pango_Attr_List; the attributes in the list are applied to the entry text. Since: gtk+ 3.6
a Pango.Attributes.Pango_Attr_List
procedure Set_Buffer
(The_Entry : not null access Gtk_Entry_Record;
Buffer : not null access Gtk.Entry_Buffer.Gtk_Entry_Buffer_Record'Class)
Set the Gtk.Entry_Buffer.Gtk_Entry_Buffer object which holds the text for this widget. Since: gtk+ 2.18
a Gtk.Entry_Buffer.Gtk_Entry_Buffer
procedure Set_Completion
(The_Entry : not null access Gtk_Entry_Record;
Completion : access Gtk.Entry_Completion.Gtk_Entry_Completion_Record'Class)
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.Entry_Completion.Gtk_Entry_Completion API. Completion is disabled if Completion is set to null. Since: gtk+ 2.4
The Gtk.Entry_Completion.Gtk_Entry_Completion or null
procedure Set_Cursor_Hadjustment
(The_Entry : not null access Gtk_Entry_Record;
Adjustment : access Gtk.Adjustment.Gtk_Adjustment_Record'Class)
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: gtk+ 2.12
an adjustment which should be adjusted when the cursor is moved, or null
procedure Set_Editable
(Editable : not null access Gtk_Entry_Record;
Is_Editable : Boolean)
procedure Set_Has_Frame
(The_Entry : not null access Gtk_Entry_Record;
Setting : Boolean := True)
Sets whether the entry has a beveled frame around it.
new value
procedure Set_Icon_Activatable
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position;
Activatable : Boolean)
Sets whether the icon is activatable. Since: gtk+ 2.16
Icon position
True if the icon should be activatable
procedure Set_Icon_Drag_Source
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position;
Target_List : Gtk.Target_List.Gtk_Target_List;
Actions : Gdk.Drag_Contexts.Gdk_Drag_Action)
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 Gtk.Widget.Gtk_Widget::drag-data-get (or possibly Gtk.Widget.Gtk_Widget::drag-data-delete) signal, and use Gtk.GEntry.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 Gtk.Widget.Gtk_Widget::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. Since: gtk+ 2.16
icon position
the targets (data formats) in which the data can be provided
a bitmask of the allowed drag actions
procedure Set_Icon_From_Gicon
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position;
Icon : Glib.G_Icon.G_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. Since: gtk+ 2.16
The position at which to set the icon
The icon to set, or null
procedure Set_Icon_From_Icon_Name
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position;
Icon_Name : UTF8_String := "")
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. Since: gtk+ 2.16
The position at which to set the icon
An icon name, or null
procedure Set_Icon_From_Pixbuf
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position;
Pixbuf : access Gdk.Pixbuf.Gdk_Pixbuf_Record'Class)
Sets the icon shown in the specified position using a pixbuf. If Pixbuf is null, no icon will be shown in the specified position. Since: gtk+ 2.16
Icon position
A Gdk.Pixbuf.Gdk_Pixbuf, or null
procedure Set_Icon_From_Stock
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position;
Stock_Id : UTF8_String := "")
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. Since: gtk+ 2.16 Deprecated since 3.10, 1
Icon position
The name of the stock item, or null
procedure Set_Icon_Sensitive
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position;
Sensitive : Boolean)
Sets the sensitivity for the specified icon. Since: gtk+ 2.16
Icon position
Specifies whether the icon should appear sensitive or insensitive
procedure Set_Icon_Tooltip_Markup
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position;
Tooltip : UTF8_String := "")
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.GEntry.Set_Icon_Tooltip_Text. Since: gtk+ 2.16
the icon position
the contents of the tooltip for the icon, or null
procedure Set_Icon_Tooltip_Text
(The_Entry : not null access Gtk_Entry_Record;
Icon_Pos : Gtk_Entry_Icon_Position;
Tooltip : UTF8_String := "")
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.GEntry.Set_Icon_Tooltip_Markup. If you unset the widget tooltip via Gtk.Widget.Set_Tooltip_Text or Gtk.Widget.Set_Tooltip_Markup, this sets GtkWidget:has-tooltip to False, which suppresses icon tooltips too. You can resolve this by then calling Gtk.Widget.Set_Has_Tooltip to set GtkWidget:has-tooltip back to True, or setting at least one non-empty tooltip on any icon achieves the same result. Since: gtk+ 2.16
the icon position
the contents of the tooltip for the icon, or null
procedure Set_Inner_Border
(The_Entry : not null access Gtk_Entry_Record;
Border : Gtk.Style.Gtk_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: gtk+ 2.10 Deprecated since 3.4, 1
a Gtk.Style.Gtk_Border, or null
procedure Set_Input_Hints
(The_Entry : not null access Gtk_Entry_Record;
Hints : Gtk.Enums.Gtk_Input_Hints)
Sets the Gtk.GEntry.Gtk_Entry:input-hints property, which allows input methods to fine-tune their behaviour. Since: gtk+ 3.6
the hints
procedure Set_Input_Purpose
(The_Entry : not null access Gtk_Entry_Record;
Purpose : Gtk.Enums.Gtk_Input_Purpose)
Sets the Gtk.GEntry.Gtk_Entry:input-purpose property which can be used by on-screen keyboards and other input methods to adjust their behaviour. Since: gtk+ 3.6
the purpose
procedure Set_Invisible_Char
(The_Entry : not null access Gtk_Entry_Record;
Char : Gunichar)
Sets the character to use in place of the actual text when Gtk.GEntry.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.
a Unicode character
procedure Set_Max_Length
(The_Entry : not null access Gtk_Entry_Record;
Max : Glib.Gint)
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 getting Entry's Gtk.Entry_Buffer.Gtk_Entry_Buffer and calling Gtk.Entry_Buffer.Set_Max_Length on it. ]|
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.
procedure Set_Max_Width_Chars
(The_Entry : not null access Gtk_Entry_Record;
N_Chars : Glib.Gint)
Sets the desired maximum width in characters of Entry. Since: gtk+ 3.12
the new desired maximum width, in characters
procedure Set_Overwrite_Mode
(The_Entry : not null access Gtk_Entry_Record;
Overwrite : Boolean)
Sets whether the text is overwritten when typing in the Gtk.GEntry.Gtk_Entry. Since: gtk+ 2.14
new value
procedure Set_Placeholder_Text
(The_Entry : not null access Gtk_Entry_Record;
Text : UTF8_String := "")
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 Gtk.GEntry.Gtk_Entry. 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. Since: gtk+ 3.2
a string to be displayed when Entry is empty and unfocused, or null
procedure Set_Position
(Editable : not null access Gtk_Entry_Record;
Position : Glib.Gint)
procedure Set_Progress_Fraction
(The_Entry : not null access Gtk_Entry_Record;
Fraction : Gdouble)
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. Since: gtk+ 2.16
fraction of the task that's been completed
procedure Set_Progress_Pulse_Step
(The_Entry : not null access Gtk_Entry_Record;
Fraction : Gdouble)
Sets the fraction of total entry width to move the progress bouncing block for each call to Gtk.GEntry.Progress_Pulse. Since: gtk+ 2.16
fraction between 0.0 and 1.0
procedure Set_Tabs
(The_Entry : not null access Gtk_Entry_Record;
Tabs : Pango.Tabs.Pango_Tab_Array)
Sets a Pango.Tabs.Pango_Tab_Array; the tabstops in the array are applied to the entry text. Since: gtk+ 3.10
a Pango.Tabs.Pango_Tab_Array
procedure Set_Text
(The_Entry : not null access Gtk_Entry_Record;
Text : UTF8_String)
Sets the text in the widget to the given value, replacing the current contents. See Gtk.Entry_Buffer.Set_Text.
the new text
procedure Set_Visibility
(The_Entry : not null access Gtk_Entry_Record;
Visible : Boolean)
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.GEntry.Set_Invisible_Char. Note that you probably want to set Gtk.GEntry.Gtk_Entry:input-purpose to Gtk.Enums.Input_Purpose_Password or Gtk.Enums.Input_Purpose_Pin to inform input methods about the purpose of this entry, in addition to setting visibility to False.
True if the contents of the entry are displayed as plaintext
procedure Set_Width_Chars
(The_Entry : not null access Gtk_Entry_Record;
Width : Glib.Gint)
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.
width in chars
Shadow_Type_Property : constant Gtk.Enums.Property_Gtk_Shadow_Type;
Which kind of shadow to draw around the entry when Gtk.GEntry.Gtk_Entry:has-frame is set to True.
Show_Emoji_Icon_Property : constant Glib.Properties.Property_Boolean;
Signal_Activate : constant Glib.Signal_Name := "activate";
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.
Signal_Backspace : constant Glib.Signal_Name := "backspace";
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.
Signal_Copy_Clipboard : constant Glib.Signal_Name := "copy-clipboard";
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.
Signal_Cut_Clipboard : constant Glib.Signal_Name := "cut-clipboard";
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.
Signal_Delete_From_Cursor : constant Glib.Signal_Name := "delete-from-cursor";
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.Enums.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.
Callback parameters: -- @param The_Type the granularity of the deletion, as a -- Gtk.Enums.Gtk_Delete_Type -- @param Count the number of Type units to delete
Signal_Icon_Press : constant Glib.Signal_Name := "icon-press";
The ::icon-press signal is emitted when an activatable icon is clicked.
Signal_Icon_Release : constant Glib.Signal_Name := "icon-release";
The ::icon-release signal is emitted on the button release from a mouse click over an activatable icon.
Signal_Insert_At_Cursor : constant Glib.Signal_Name := "insert-at-cursor";
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.
Signal_Insert_Emoji : constant Glib.Signal_Name := "insert-emoji";
The ::insert-emoji signal is a [keybinding signal][GtkBindingSignal] which gets emitted to present the Emoji chooser for the Entry.
The default bindings for this signal are Ctrl-. and Ctrl-;
Signal_Move_Cursor : constant Glib.Signal_Name := "move-cursor";
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
Callback parameters: -- @param Step the granularity of the move, as a -- Gtk.Enums.Gtk_Movement_Step -- @param Count the number of Step units to move -- @param Extend_Selection True if the move should extend the selection
Signal_Paste_Clipboard : constant Glib.Signal_Name := "paste-clipboard";
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.
Signal_Populate_Popup : constant Glib.Signal_Name := "populate-popup";
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 Gtk.Menu.Gtk_Menu in this case.
If Gtk.GEntry.Gtk_Entry: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 Gtk.Toolbar.Gtk_Toolbar. The signal handler should not make assumptions about the type of Widget.
Signal_Preedit_Changed : constant Glib.Signal_Name := "preedit-changed";
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.
Signal_Toggle_Overwrite : constant Glib.Signal_Name := "toggle-overwrite";
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.
procedure Start_Editing
(Cell_Editable : not null access Gtk_Entry_Record;
Event : Gdk.Event.Gdk_Event)
Tabs_Property : constant Glib.Properties.Property_Boxed;
Type: Pango.Tab_Array
function Text_Index_To_Layout_Index
(The_Entry : not null access Gtk_Entry_Record;
Text_Index : Glib.Gint) return Glib.Gint
Converts from a position in the entry contents (returned by Gtk.GEntry.Get_Text) to a position in the entry's Pango.Layout.Pango_Layout (returned by Gtk.GEntry.Get_Layout, with text retrieved via Pango.Layout.Get_Text).
byte index into the entry contents
byte index into the entry layout text
Text_Length_Property : constant Glib.Properties.Property_Uint;
The length of the text in the Gtk.GEntry.Gtk_Entry.
Text_Property : constant Glib.Properties.Property_String;
Truncate_Multiline_Property : constant Glib.Properties.Property_Boolean;
When True, pasted multi-line text is truncated to the first line.
procedure Unset_Invisible_Char
(The_Entry : not null access Gtk_Entry_Record)
Unsets the invisible char previously set with Gtk.GEntry.Set_Invisible_Char. So that the default invisible char is used again. Since: gtk+ 2.16
Visibility_Property : constant Glib.Properties.Property_Boolean;
Width_Chars_Property : constant Glib.Properties.Property_Int;
Xalign_Property : constant Glib.Properties.Property_Float;
The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.