Gtk2::Entry(3)

📦

version 1.24993 · 2 versions

1.24993 · fedora 43 (latest)
1.24993 · fedora 44

💖 Gtk2::Entry — the manual page, bestie edition 💖

okay so. Gtk2::Entry(3) — that's the page we're on, from the User Contributed Perl Documentation corner of the world. It's a wrapper for GtkEntry. That's it. That's the vibe. One line of text box energy and honestly? iconic.

✨ HIERARCHY ✨

the family tree, no cap. this is where Entry sits in the whole ancestry situation:

  Glib::Object
  +----Glib::InitiallyUnowned
       +----Gtk2::Object
            +----Gtk2::Widget
                 +----Gtk2::Entry

it's giving "descended from greatness" fr fr 💅

🦋 INTERFACES 🦋

these are the interfaces it implements — the little personality traits it picked up along the way:

Glib::Object::_Unregistered::AtkImplementorIface
Gtk2::Buildable
Gtk2::Editable
Gtk2::CellEditable

so it can be built, it can be edited, it can be edited in a cell. versatile queen 👑

🌸 METHODS 🌸

this is the big one. buckle up, there's a LOT. take it slow, hydrate, we got this.

make a fresh lil Entry. blank slate. main character debut ✨

$buffer (Gtk2::EntryBuffer)

same but you hand it a buffer to live in.

$max (integer)

new entry, but it comes with a character limit already installed. built different.

`boolean = $entry->get_activates_default` / `$entry->set_activates_default ($setting)`

$setting (boolean)

get/set whether hitting enter in here triggers the default widget. the "just press go" setting 💅

`double = $entry->get_alignment`

`$entry->set_alignment ($xalign)`

$xalign (double)

how far left/right the text sits in the box. alignment check, but make it literal ✨

`$entry->append_text ($text)`

$text (string)

stick text on the end. the "and also" of text entry.

`entrybuffer = $entry->get_buffer`

`$entry->set_buffer ($buffer)`

$buffer (Gtk2::EntryBuffer)

the buffer is where the actual text lives. you can grab it or swap it out.

`entrycompletion or undef = $entry->get_completion`

`$entry->set_completion ($completion)`

$completion (Gtk2::EntryCompletion or undef)

autocomplete bestie! may be undef, so check before you use it, fr.

`integer = $entry->get_current_icon_drag_source`

which icon is currently being dragged from. a whole integer for that. sure.

`adjustment or undef = $entry->get_cursor_hadjustment`

`$entry->set_cursor_hadjustment ($adjustment)`

$adjustment (Gtk2::Adjustment or undef)

horizontal scrolling behavior for the cursor. can be undef, no biggie.

`$entry->set_editable ($editable)`

$editable (boolean)

can the user actually type in it or is it just for show. read-only mode is valid too 👑

`boolean = $entry->get_has_frame` / `$entry->set_has_frame ($setting)`

$setting (boolean)

does it have the cute little border frame around it. aesthetic choice, honestly.

`boolean = $entry->get_icon_activatable ($icon_pos)`

$icon_pos (Gtk2::EntryIconPosition)

`$entry->set_icon_activatable ($icon_pos, $activatable)`

$icon_pos (Gtk2::EntryIconPosition)
$activatable (boolean)

can you click the icon. yes/no. $icon_pos tells it which icon you mean.

`integer = $entry->get_icon_at_pos ($x, $y)`

$x (integer)
$y (integer)

give it coordinates, it tells you which icon is sitting there. coordinate girlie 🔥

`$entry->set_icon_drag_source ($icon_pos, $target_list, $actions)`

$icon_pos (Gtk2::EntryIconPosition)
$target_list (Gtk2::TargetList)
$actions (Gtk2::Gdk::DragAction)

make an icon draggable. drag source era.

`$entry->set_icon_from_icon_name ($icon_pos, $icon_name)`

$icon_pos (Gtk2::EntryIconPosition)
$icon_name (string or undef)

set the icon by name. undef is allowed, so you can clear it too.

`$entry->set_icon_from_pixbuf ($icon_pos, $pixbuf)`

$icon_pos (Gtk2::EntryIconPosition)
$pixbuf (Gtk2::Gdk::Pixbuf or undef)

set the icon from a pixbuf. also accepts undef. flexible 💅

`$entry->set_icon_from_stock ($icon_pos, $stock_id)`

$icon_pos (Gtk2::EntryIconPosition)
$stock_id (string or undef)

stock icon by id. undef clears it, as usual.

`string or undef = $entry->get_icon_name ($icon_pos)`

$icon_pos (Gtk2::EntryIconPosition)

grab the icon name. might be undef! check it, bestie.

`pixbuf or undef = $entry->get_icon_pixbuf ($icon_pos)`

$icon_pos (Gtk2::EntryIconPosition)

grab the pixbuf. also possibly undef.

`boolean = $entry->get_icon_sensitive ($icon_pos)`

$icon_pos (Gtk2::EntryIconPosition)

`$entry->set_icon_sensitive ($icon_pos, $sensitive)`

$icon_pos (Gtk2::EntryIconPosition)
$sensitive (boolean)

is the icon "sensitive" (i.e. reacting to input). set it, get it, slay.

`string or undef = $entry->get_icon_stock ($icon_pos)`

$icon_pos (Gtk2::EntryIconPosition)

the stock id of that icon. undef possible, obviously.

`imagetype = $entry->get_icon_storage_type ($icon_pos)`

$icon_pos (Gtk2::EntryIconPosition)

what kind of image storage this icon uses. the lore ✨

$icon_pos (Gtk2::EntryIconPosition)

$icon_pos (Gtk2::EntryIconPosition)
$tooltip (string or undef)

tooltip, but with markup. undef is fine, it's fine, everything's fine.

$icon_pos (Gtk2::EntryIconPosition)

$icon_pos (Gtk2::EntryIconPosition)
$tooltip (string or undef)

plain text tooltip version. the markup one and this one are siblings, don't mix them up.

`window = $entry->get_icon_window ($icon_pos)`

$icon_pos (Gtk2::EntryIconPosition)

the actual window for that icon. window era 🌈

`boolean = $entry->im_context_filter_keypress ($event)`

$event (Gtk2::Gdk::Event)

filter a keypress through the input method context. returns a boolean. iykyk.

`border or undef = $entry->get_inner_border`

`$entry->set_inner_border ($border)`

$border (Gtk2::Border or undef)

the inner border. can be undef. get it, set it, move on.

`character = $entry->get_invisible_char` / `$entry->set_invisible_char ($ch)`

$ch (character)

which character shows up when the text is invisible (password mode, we see you 👀).

`layout = $entry->get_layout`

grab the Pango layout the entry is using.

`integer = $entry->layout_index_to_text_index ($layout_index)`

$layout_index (integer)

translate a layout index into a text index. two different numbering systems, one little converter. obsessed.

`(x, y) = $entry->get_layout_offsets`

returns both offsets at once. list context girlie 💅

`integer = $entry->get_max_length` / `$entry->set_max_length ($max)`

$max (integer)

get or set the max number of characters. the limit does exist.

`boolean = $entry->get_overwrite_mode`

`$entry->set_overwrite_mode ($overwrite)`

$overwrite (boolean)

overwrite mode instead of insert mode. retro typing vibe fr.

`$entry->set_position ($position)`

$position (integer)

put the cursor at a position. simple. clean. iconic.

`$entry->prepend_text ($text)`

$text (string)

text at the FRONT. the opposite of append_text. balance ✨

`double = $entry->get_progress_fraction`

`$entry->set_progress_fraction ($fraction)`

$fraction (double)

progress bar inside your text entry. how much is done. a double. go off.

`$entry->progress_pulse`

pulse the progress bar forward. the lil "still working on it" wiggle.

`double = $entry->get_progress_pulse_step`

`$entry->set_progress_pulse_step ($fraction)`

$fraction (double)

how big each pulse step is. tune it to taste.

`$entry->reset_im_context`

reset the input method context. clean slate for the IM.

`$entry->select_region ($start, $end)`

$start (integer)
$end (integer)

select a range of text programmatically. highlight it, bestie 💅

`string = $entry->get_text`

get the text. the whole point, honestly.

`integer = $entry->text_index_to_layout_index ($text_index)`

$text_index (integer)

the reverse converter of layout_index_to_text_index. they're a matching set 🫶

`unsigned = $entry->get_text_length`

how long the text is. unsigned. count it.

`$entry->set_text ($text)`

$text (string)

set the text. the other whole point.

`window = $entry->get_text_window`

the window for the text area itself. yes, separately. two windows, because why not.

`$entry->unset_invisible_char`

undo the invisible char. back to default behavior, periodt.

`boolean = $entry->get_visibility` / `$entry->set_visibility ($visible)`

$visible (boolean)

is the text visible or hidden. the password-mode toggle, lowkey.

`integer = $entry->get_width_chars` / `$entry->set_width_chars ($n_chars)`

$n_chars (integer)

how wide the entry is, measured in characters. $n_chars of them, exactly.

okay bestie that's part 1 and there is more coming so don't go anywhere 💖

💖 PROPERTIES 💖

okay bestie, this is the full property menu. every bullet is name — type : default value : flags — then the vibe. no skips, no cap. 💅

'activates-default' — boolean : default false : readable / writable / private / static-nick / static-blurb — Whether to activate the default widget (like the default button in a dialog) when Enter is pressed. ✨
'buffer' — Gtk2::EntryBuffer : default undef : readable / writable / construct / private / static-nick / static-blurb — Text buffer object which actually stores entry text. the storage bestie. 🎀
'caps-lock-warning' — boolean : default true : readable / writable / private / static-nick / static-blurb — Whether password entries will show a warning when Caps Lock is on. iconic. 🔥
'cursor-position' — integer : default 0 : readable / private / static-nick / static-blurb — The current position of the insertion cursor in chars. read-only vibes. 👀
'editable' — boolean : default true : readable / writable / private / static-nick / static-blurb — Whether the entry contents can be edited. that's the whole question. 💅
'has-frame' — boolean : default true : readable / writable / private / static-nick / static-blurb — FALSE removes outside bevel from entry. no frame, no problem. ✨
'im-module' — string : default undef : readable / writable / private / static-nick / static-blurb — Which IM module should be used. that's it, that's the tweet. 🦋
'inner-border' — Gtk2::Border : default undef : readable / writable / private / static-nick / static-blurb — Border between text and frame. Overrides the inner-border style property. boss move. 👑
'invisible-char' — Glib::UInt : default 42 "*" : readable / writable / private / static-nick / static-blurb — The character to use when masking entry contents (in "password mode"). default is 42 "*", yes really. 🙈
'invisible-char-set' — boolean : default false : readable / writable / private / static-nick / static-blurb — Whether the invisible char has been set. yes or no bestie. 🌸
'max-length' — integer : default 0 : readable / writable / private / static-nick / static-blurb — Maximum number of characters for this entry. Zero if no maximum. 0 means no maximum. periodt. 💜
'overwrite-mode' — boolean : default false : readable / writable / private / static-nick / static-blurb — Whether new text overwrites existing text. type-over mode energy. ✨
'primary-icon-activatable' — boolean : default false : readable / writable / private / static-nick / static-blurb — Whether the primary icon is activatable. yes/no. 🎀
'primary-icon-gicon' — Glib::Object::_Unregistered::GIcon : default undef : readable / writable / private / static-nick / static-blurb — GIcon for primary icon. exactly that. 🌈
'primary-icon-name' — string : default undef : readable / writable / private / static-nick / static-blurb — Icon name for primary icon. name drop. 💅
'primary-icon-pixbuf' — Gtk2::Gdk::Pixbuf : default undef : readable / writable / private / static-nick / static-blurb — Primary pixbuf for the entry. pixels, but make it primary. ✨
'primary-icon-sensitive' — boolean : default true : readable / writable / private / static-nick / static-blurb — Whether the primary icon is sensitive. default says yes. 🥺
'primary-icon-stock' — string : default undef : readable / writable / private / static-nick / static-blurb — Stock ID for primary icon. old-school but valid. 👑
'primary-icon-storage-type' — Gtk2::ImageType : default "empty" : readable / private / static-nick / static-blurb — The representation being used for primary icon. read-only, default "empty". 🫶
'primary-icon-tooltip-markup' — string : default undef : readable / writable / private / static-nick / static-blurb — The contents of the tooltip on the primary icon. markup edition. 🎀
'primary-icon-tooltip-text' — string : default undef : readable / writable / private / static-nick / static-blurb — The contents of the tooltip on the primary icon. same tooltip energy, text edition. ✨
'progress-fraction' — double : default 0 : readable / writable / private / static-nick / static-blurb — The current fraction of the task that's been completed. progress bar moment. 🔥
'progress-pulse-step' — double : default 0.1 : readable / writable / private / static-nick / static-blurb — The fraction of total entry width to move the progress bouncing block for each call to gtk_entry_progress_pulse(). bouncing block supremacy. 💅
'scroll-offset' — integer : default 0 : readable / private / static-nick / static-blurb — Number of pixels of the entry scrolled off the screen to the left. read-only. 👀
'secondary-icon-activatable' — boolean : default false : readable / writable / private / static-nick / static-blurb — Whether the secondary icon is activatable. the sequel. 💅
'secondary-icon-gicon' — Glib::Object::_Unregistered::GIcon : default undef : readable / writable / private / static-nick / static-blurb — GIcon for secondary icon. matching set. ✨
'secondary-icon-name' — string : default undef : readable / writable / private / static-nick / static-blurb — Icon name for secondary icon. 💖
'secondary-icon-pixbuf' — Gtk2::Gdk::Pixbuf : default undef : readable / writable / private / static-nick / static-blurb — Secondary pixbuf for the entry. the other pixbuf. 🎀
'secondary-icon-sensitive' — boolean : default true : readable / writable / private / static-nick / static-blurb — Whether the secondary icon is sensitive. default yes, be gentle. 🥺
'secondary-icon-stock' — string : default undef : readable / writable / private / static-nick / static-blurb — Stock ID for secondary icon. vintage. 👑
'secondary-icon-storage-type' — Gtk2::ImageType : default "empty" : readable / private / static-nick / static-blurb — The representation being used for secondary icon. read-only, default "empty". 🫶
'secondary-icon-tooltip-markup' — string : default undef : readable / writable / private / static-nick / static-blurb — The contents of the tooltip on the secondary icon. markup flavor. 🎀
'secondary-icon-tooltip-text' — string : default undef : readable / writable / private / static-nick / static-blurb — The contents of the tooltip on the secondary icon. same but text flavor. ✨
'selection-bound' — integer : default 0 : readable / private / static-nick / static-blurb — The position of the opposite end of the selection from the cursor in chars. read-only. 👀
'shadow-type' — Gtk2::ShadowType : default "in" : readable / writable / private / static-nick / static-blurb — Which kind of shadow to draw around the entry when has-frame is set. default "in". 🌈
'text' — string : default "" : readable / writable / private / static-nick / static-blurb — The contents of the entry. main character. 👑
'text-length' — Glib::UInt : default 0 : readable / private / static-nick / static-blurb — Length of the text currently in the entry. read-only. ✨
'truncate-multiline' — boolean : default false : readable / writable / private / static-nick / static-blurb — Whether to truncate multiline pastes to one line. yes/no. 🎀
'visibility' — boolean : default true : readable / writable / private / static-nick / static-blurb — FALSE displays the "invisible char" instead of the actual text (password mode). password mode, bestie. 🙈
'width-chars' — integer : default -1 : readable / writable / private / static-nick / static-blurb — Number of characters to leave space for in the entry. default -1. 💅
'xalign' — float : default 0 : readable / writable / private / static-nick / static-blurb — The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts. ✨

🌸 STYLE PROPERTIES 🌸

these are the style-property girlies. same deal: name, type/default/flags, then the vibe. 💜

'icon-prelight' — boolean : default true : readable / private / static-nick / static-blurb — Whether activatable icons should prelight when hovered. default true. ✨
'inner-border' — Gtk2::Border : default undef : readable / private / static-nick / static-blurb — Border between text and frame. simple. 💅
'invisible-char' — Glib::UInt : default 0 "\0" : readable / private / static-nick / static-blurb — The character to use when masking entry contents (in "password mode"). default 0 "\0" — yes, the null char is here. 🙈
'progress-border' — Gtk2::Border : default undef : readable / private / static-nick / static-blurb — Border around the progress bar. cute. 🎀
'state-hint' — boolean : default false : readable / private / static-nick / static-blurb — Whether to pass a proper state when drawing shadow or background. default false. 🌈

🔥 SIGNALS 🔥

here's the signal lineup, with exact signatures. no invented lore, just the facts. 👑

activate (Gtk2::Entry)
backspace (Gtk2::Entry)
copy-clipboard (Gtk2::Entry)
cut-clipboard (Gtk2::Entry)
delete-from-cursor (Gtk2::Entry, Gtk2::DeleteType, integer)
icon-press (Gtk2::Entry, Gtk2::EntryIconPosition, Gtk2::Gdk::Event)
icon-release (Gtk2::Entry, Gtk2::EntryIconPosition, Gtk2::Gdk::Event)
insert-at-cursor (Gtk2::Entry, string)
move-cursor (Gtk2::Entry, Gtk2::MovementStep, integer, boolean)
paste-clipboard (Gtk2::Entry)
populate-popup (Gtk2::Entry, Gtk2::Menu)
preedit-changed (Gtk2::Entry, string)
toggle-overwrite (Gtk2::Entry)

💜 ENUMS AND FLAGS 💜

🌈 enum `Gtk2::DeleteType`

'chars' / 'GTK_DELETE_CHARS'
'word-ends' / 'GTK_DELETE_WORD_ENDS'
'words' / 'GTK_DELETE_WORDS'
'display-lines' / 'GTK_DELETE_DISPLAY_LINES'
'display-line-ends' / 'GTK_DELETE_DISPLAY_LINE_ENDS'
'paragraph-ends' / 'GTK_DELETE_PARAGRAPH_ENDS'
'paragraphs' / 'GTK_DELETE_PARAGRAPHS'
'whitespace' / 'GTK_DELETE_WHITESPACE'

🎀 enum `Gtk2::EntryIconPosition`

'primary' / 'GTK_ENTRY_ICON_PRIMARY'
'secondary' / 'GTK_ENTRY_ICON_SECONDARY'

✨ flags `Gtk2::Gdk::DragAction`

'default' / 'GDK_ACTION_DEFAULT'
'copy' / 'GDK_ACTION_COPY'
'move' / 'GDK_ACTION_MOVE'
'link' / 'GDK_ACTION_LINK'
'private' / 'GDK_ACTION_PRIVATE'
'ask' / 'GDK_ACTION_ASK'

🌸 enum `Gtk2::ImageType`

'empty' / 'GTK_IMAGE_EMPTY'
'pixmap' / 'GTK_IMAGE_PIXMAP'
'image' / 'GTK_IMAGE_IMAGE'
'pixbuf' / 'GTK_IMAGE_PIXBUF'
'stock' / 'GTK_IMAGE_STOCK'
'icon-set' / 'GTK_IMAGE_ICON_SET'
'animation' / 'GTK_IMAGE_ANIMATION'
'icon-name' / 'GTK_IMAGE_ICON_NAME'
'gicon' / 'GTK_IMAGE_GICON'

💅 enum `Gtk2::MovementStep`

'logical-positions' / 'GTK_MOVEMENT_LOGICAL_POSITIONS'
'visual-positions' / 'GTK_MOVEMENT_VISUAL_POSITIONS'
'words' / 'GTK_MOVEMENT_WORDS'
'display-lines' / 'GTK_MOVEMENT_DISPLAY_LINES'
'display-line-ends' / 'GTK_MOVEMENT_DISPLAY_LINE_ENDS'
'paragraphs' / 'GTK_MOVEMENT_PARAGRAPHS'
'paragraph-ends' / 'GTK_MOVEMENT_PARAGRAPH_ENDS'
'pages' / 'GTK_MOVEMENT_PAGES'
'buffer-ends' / 'GTK_MOVEMENT_BUFFER_ENDS'
'horizontal-pages' / 'GTK_MOVEMENT_HORIZONTAL_PAGES'

👑 enum `Gtk2::ShadowType`

'none' / 'GTK_SHADOW_NONE'
'in' / 'GTK_SHADOW_IN'
'out' / 'GTK_SHADOW_OUT'
'etched-in' / 'GTK_SHADOW_ETCHED_IN'
'etched-out' / 'GTK_SHADOW_ETCHED_OUT'

🫶 SEE ALSO 🫶

Gtk2
Glib::Object
Glib::InitiallyUnowned
Gtk2::Object
Gtk2::Widget

💖 COPYRIGHT 💖

this page is perl v5.42.0, dated 2025-07-25, and it's Gtk2::Entry(3) — bye bestie, hydrate and read your docs 💖✨

📦 where this page comes from

fedora 43: perl-Gtk2 1.24993-23.fc43 · LicenseRef-Callaway-LGPLv2+
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

Gtk2::Entry(3)

💖 Gtk2::Entry — the manual page, bestie edition 💖

✨ HIERARCHY ✨

🦋 INTERFACES 🦋

🌸 METHODS 🌸

widget = Gtk2::Entry->new

widget = Gtk2::Entry->new_with_buffer ($buffer)

widget = Gtk2::Entry->new_with_max_length ($max)

boolean = $entry->get_activates_default / $entry->set_activates_default ($setting)

double = $entry->get_alignment

$entry->set_alignment ($xalign)

$entry->append_text ($text)

entrybuffer = $entry->get_buffer

$entry->set_buffer ($buffer)

entrycompletion or undef = $entry->get_completion

$entry->set_completion ($completion)

integer = $entry->get_current_icon_drag_source

adjustment or undef = $entry->get_cursor_hadjustment

$entry->set_cursor_hadjustment ($adjustment)

$entry->set_editable ($editable)

boolean = $entry->get_has_frame / $entry->set_has_frame ($setting)

boolean = $entry->get_icon_activatable ($icon_pos)

$entry->set_icon_activatable ($icon_pos, $activatable)

integer = $entry->get_icon_at_pos ($x, $y)

$entry->set_icon_drag_source ($icon_pos, $target_list, $actions)

$entry->set_icon_from_icon_name ($icon_pos, $icon_name)

$entry->set_icon_from_pixbuf ($icon_pos, $pixbuf)

$entry->set_icon_from_stock ($icon_pos, $stock_id)

string or undef = $entry->get_icon_name ($icon_pos)

pixbuf or undef = $entry->get_icon_pixbuf ($icon_pos)

boolean = $entry->get_icon_sensitive ($icon_pos)

$entry->set_icon_sensitive ($icon_pos, $sensitive)

string or undef = $entry->get_icon_stock ($icon_pos)

imagetype = $entry->get_icon_storage_type ($icon_pos)

string or undef = $entry->get_icon_tooltip_markup ($icon_pos)

$entry->set_icon_tooltip_markup ($icon_pos, $tooltip)

string or undef = $entry->get_icon_tooltip_text ($icon_pos)

$entry->set_icon_tooltip_text ($icon_pos, $tooltip)

window = $entry->get_icon_window ($icon_pos)

boolean = $entry->im_context_filter_keypress ($event)

border or undef = $entry->get_inner_border

$entry->set_inner_border ($border)

character = $entry->get_invisible_char / $entry->set_invisible_char ($ch)

layout = $entry->get_layout

integer = $entry->layout_index_to_text_index ($layout_index)

(x, y) = $entry->get_layout_offsets

integer = $entry->get_max_length / $entry->set_max_length ($max)

boolean = $entry->get_overwrite_mode

$entry->set_overwrite_mode ($overwrite)

$entry->set_position ($position)

$entry->prepend_text ($text)

double = $entry->get_progress_fraction

$entry->set_progress_fraction ($fraction)

$entry->progress_pulse

double = $entry->get_progress_pulse_step

$entry->set_progress_pulse_step ($fraction)

$entry->reset_im_context

$entry->select_region ($start, $end)

string = $entry->get_text

integer = $entry->text_index_to_layout_index ($text_index)

unsigned = $entry->get_text_length

$entry->set_text ($text)

window = $entry->get_text_window

$entry->unset_invisible_char

boolean = $entry->get_visibility / $entry->set_visibility ($visible)

integer = $entry->get_width_chars / $entry->set_width_chars ($n_chars)