Gtk2::Entry(3) User Contributed Perl Documentation Gtk2::Entry(3) NAME Gtk2::Entry - wrapper for GtkEntry HIERARCHY Glib::Object +----Glib::InitiallyUnowned +----Gtk2::Object +----Gtk2::Widget +----Gtk2::Entry INTERFACES Glib::Object::_Unregistered::AtkImplementorIface Gtk2::Buildable Gtk2::Editable Gtk2::CellEditable METHODS widget = Gtk2::Entry->new widget = Gtk2::Entry->new_with_buffer ($buffer) o $buffer (Gtk2::EntryBuffer) Since: gtk+ 2.18 widget = Gtk2::Entry->new_with_max_length ($max) o $max (integer) boolean = $entry->get_activates_default $entry->set_activates_default ($setting) o $setting (boolean) double = $entry->get_alignment Since: gtk+ 2.4 $entry->set_alignment ($xalign) o $xalign (double) Since: gtk+ 2.4 $entry->append_text ($text) o $text (string) entrybuffer = $entry->get_buffer Since: gtk+ 2.18 $entry->set_buffer ($buffer) o $buffer (Gtk2::EntryBuffer) Since: gtk+ 2.18 entrycompletion or undef = $entry->get_completion Since: gtk+ 2.4 $entry->set_completion ($completion) o $completion (Gtk2::EntryCompletion or undef) Since: gtk+ 2.4 integer = $entry->get_current_icon_drag_source Since: gtk+ 2.16 adjustment or undef = $entry->get_cursor_hadjustment Since: gtk+ 2.12 $entry->set_cursor_hadjustment ($adjustment) o $adjustment (Gtk2::Adjustment or undef) Since: gtk+ 2.12 $entry->set_editable ($editable) o $editable (boolean) boolean = $entry->get_has_frame $entry->set_has_frame ($setting) o $setting (boolean) boolean = $entry->get_icon_activatable ($icon_pos) o $icon_pos (Gtk2::EntryIconPosition) Since: gtk+ 2.16 $entry->set_icon_activatable ($icon_pos, $activatable) o $icon_pos (Gtk2::EntryIconPosition) o $activatable (boolean) Since: gtk+ 2.16 integer = $entry->get_icon_at_pos ($x, $y) o $x (integer) o $y (integer) Since: gtk+ 2.16 $entry->set_icon_drag_source ($icon_pos, $target_list, $actions) o $icon_pos (Gtk2::EntryIconPosition) o $target_list (Gtk2::TargetList) o $actions (Gtk2::Gdk::DragAction) Since: gtk+ 2.16 $entry->set_icon_from_icon_name ($icon_pos, $icon_name) o $icon_pos (Gtk2::EntryIconPosition) o $icon_name (string or undef) Since: gtk+ 2.16 $entry->set_icon_from_pixbuf ($icon_pos, $pixbuf) o $icon_pos (Gtk2::EntryIconPosition) o $pixbuf (Gtk2::Gdk::Pixbuf or undef) Since: gtk+ 2.16 $entry->set_icon_from_stock ($icon_pos, $stock_id) o $icon_pos (Gtk2::EntryIconPosition) o $stock_id (string or undef) Since: gtk+ 2.16 string or undef = $entry->get_icon_name ($icon_pos) o $icon_pos (Gtk2::EntryIconPosition) Since: gtk+ 2.16 pixbuf or undef = $entry->get_icon_pixbuf ($icon_pos) o $icon_pos (Gtk2::EntryIconPosition) Since: gtk+ 2.16 boolean = $entry->get_icon_sensitive ($icon_pos) o $icon_pos (Gtk2::EntryIconPosition) Since: gtk+ 2.16 $entry->set_icon_sensitive ($icon_pos, $sensitive) o $icon_pos (Gtk2::EntryIconPosition) o $sensitive (boolean) Since: gtk+ 2.16 string or undef = $entry->get_icon_stock ($icon_pos) o $icon_pos (Gtk2::EntryIconPosition) Since: gtk+ 2.16 imagetype = $entry->get_icon_storage_type ($icon_pos) o $icon_pos (Gtk2::EntryIconPosition) Since: gtk+ 2.16 string or undef = $entry->get_icon_tooltip_markup ($icon_pos) o $icon_pos (Gtk2::EntryIconPosition) Since: gtk+ 2.16 $entry->set_icon_tooltip_markup ($icon_pos, $tooltip) o $icon_pos (Gtk2::EntryIconPosition) o $tooltip (string or undef) Since: gtk+ 2.16 string or undef = $entry->get_icon_tooltip_text ($icon_pos) o $icon_pos (Gtk2::EntryIconPosition) Since: gtk+ 2.16 $entry->set_icon_tooltip_text ($icon_pos, $tooltip) o $icon_pos (Gtk2::EntryIconPosition) o $tooltip (string or undef) Since: gtk+ 2.16 window = $entry->get_icon_window ($icon_pos) o $icon_pos (Gtk2::EntryIconPosition) Since: gtk+ 2.20 boolean = $entry->im_context_filter_keypress ($event) o $event (Gtk2::Gdk::Event) Since: gtk+ 2.22 border or undef = $entry->get_inner_border Since: gtk+ 2.10 $entry->set_inner_border ($border) o $border (Gtk2::Border or undef) Since: gtk+ 2.10 character = $entry->get_invisible_char $entry->set_invisible_char ($ch) o $ch (character) layout = $entry->get_layout integer = $entry->layout_index_to_text_index ($layout_index) o $layout_index (integer) Since: gtk+ 2.6 (x, y) = $entry->get_layout_offsets integer = $entry->get_max_length $entry->set_max_length ($max) o $max (integer) boolean = $entry->get_overwrite_mode Since: gtk+ 2.14 $entry->set_overwrite_mode ($overwrite) o $overwrite (boolean) Since: gtk+ 2.14 $entry->set_position ($position) o $position (integer) $entry->prepend_text ($text) o $text (string) double = $entry->get_progress_fraction Since: gtk+ 2.16 $entry->set_progress_fraction ($fraction) o $fraction (double) Since: gtk+ 2.16 $entry->progress_pulse Since: gtk+ 2.16 double = $entry->get_progress_pulse_step Since: gtk+ 2.16 $entry->set_progress_pulse_step ($fraction) o $fraction (double) Since: gtk+ 2.16 $entry->reset_im_context Since: gtk+ 2.22 $entry->select_region ($start, $end) o $start (integer) o $end (integer) string = $entry->get_text integer = $entry->text_index_to_layout_index ($text_index) o $text_index (integer) Since: gtk+ 2.6 unsigned = $entry->get_text_length Since: gtk+ 2.14 $entry->set_text ($text) o $text (string) window = $entry->get_text_window Since: gtk+ 2.20 $entry->unset_invisible_char Since: gtk+ 2.16 boolean = $entry->get_visibility $entry->set_visibility ($visible) o $visible (boolean) integer = $entry->get_width_chars $entry->set_width_chars ($n_chars) o $n_chars (integer) PROPERTIES 'activates-default' (boolean : default false : readable / writable / private / static-nick / static-blurb) Whether to activate the default widget (such as 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 '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 'cursor-position' (integer : default 0 : readable / private / static-nick / static-blurb) The current position of the insertion cursor in chars 'editable' (boolean : default true : readable / writable / private / static-nick / static-blurb) Whether the entry contents can be edited 'has-frame' (boolean : default true : readable / writable / private / static-nick / static-blurb) FALSE removes outside bevel from entry 'im-module' (string : default undef : readable / writable / private / static-nick / static-blurb) Which IM module should be used 'inner-border' (Gtk2::Border : default undef : readable / writable / private / static-nick / static-blurb) Border between text and frame. Overrides the inner-border style property 'invisible-char' (Glib::UInt : default 42 "*" : readable / writable / private / static-nick / static-blurb) The character to use when masking entry contents (in "password mode") 'invisible-char-set' (boolean : default false : readable / writable / private / static-nick / static-blurb) Whether the invisible char has been set 'max-length' (integer : default 0 : readable / writable / private / static-nick / static-blurb) Maximum number of characters for this entry. Zero if no maximum 'overwrite-mode' (boolean : default false : readable / writable / private / static-nick / static-blurb) Whether new text overwrites existing text 'primary-icon-activatable' (boolean : default false : readable / writable / private / static-nick / static-blurb) Whether the primary icon is activatable 'primary-icon-gicon' (Glib::Object::_Unregistered::GIcon : default undef : readable / writable / private / static-nick / static-blurb) GIcon for primary icon 'primary-icon-name' (string : default undef : readable / writable / private / static-nick / static-blurb) Icon name for primary icon 'primary-icon-pixbuf' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private / static-nick / static-blurb) Primary pixbuf for the entry 'primary-icon-sensitive' (boolean : default true : readable / writable / private / static-nick / static-blurb) Whether the primary icon is sensitive 'primary-icon-stock' (string : default undef : readable / writable / private / static-nick / static-blurb) Stock ID for primary icon 'primary-icon-storage-type' (Gtk2::ImageType : default "empty" : readable / private / static-nick / static-blurb) The representation being used for primary icon 'primary-icon-tooltip-markup' (string : default undef : readable / writable / private / static-nick / static-blurb) The contents of the tooltip on the primary icon 'primary-icon-tooltip-text' (string : default undef : readable / writable / private / static-nick / static-blurb) The contents of the tooltip on the primary icon 'progress-fraction' (double : default 0 : readable / writable / private / static-nick / static-blurb) The current fraction of the task that's been completed '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() 'scroll-offset' (integer : default 0 : readable / private / static-nick / static-blurb) Number of pixels of the entry scrolled off the screen to the left 'secondary-icon-activatable' (boolean : default false : readable / writable / private / static-nick / static-blurb) Whether the secondary icon is activatable 'secondary-icon-gicon' (Glib::Object::_Unregistered::GIcon : default undef : readable / writable / private / static-nick / static-blurb) GIcon for secondary icon '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 'secondary-icon-sensitive' (boolean : default true : readable / writable / private / static-nick / static-blurb) Whether the secondary icon is sensitive 'secondary-icon-stock' (string : default undef : readable / writable / private / static-nick / static-blurb) Stock ID for secondary icon 'secondary-icon-storage-type' (Gtk2::ImageType : default "empty" : readable / private / static-nick / static-blurb) The representation being used for secondary icon 'secondary-icon-tooltip-markup' (string : default undef : readable / writable / private / static-nick / static-blurb) The contents of the tooltip on the secondary icon 'secondary-icon-tooltip-text' (string : default undef : readable / writable / private / static-nick / static-blurb) The contents of the tooltip on the secondary icon '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 '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 'text' (string : default "" : readable / writable / private / static-nick / static-blurb) The contents of the entry 'text-length' (Glib::UInt : default 0 : readable / private / static-nick / static-blurb) Length of the text currently in the entry 'truncate-multiline' (boolean : default false : readable / writable / private / static-nick / static-blurb) Whether to truncate multiline pastes to one line. 'visibility' (boolean : default true : readable / writable / private / static-nick / static-blurb) FALSE displays the "invisible char" instead of the actual text (password mode) 'width-chars' (integer : default -1 : readable / writable / private / static-nick / static-blurb) Number of characters to leave space for in the entry '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 'icon-prelight' (boolean : default true : readable / private / static-nick / static-blurb) Whether activatable icons should prelight when hovered 'inner-border' (Gtk2::Border : default undef : readable / private / static-nick / static-blurb) Border between text and frame. 'invisible-char' (Glib::UInt : default 0 "\0" : readable / private / static-nick / static-blurb) The character to use when masking entry contents (in "password mode") 'progress-border' (Gtk2::Border : default undef : readable / private / static-nick / static-blurb) Border around the progress bar 'state-hint' (boolean : default false : readable / private / static-nick / static-blurb) Whether to pass a proper state when drawing shadow or background SIGNALS 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 o 'chars' / 'GTK_DELETE_CHARS' o 'word-ends' / 'GTK_DELETE_WORD_ENDS' o 'words' / 'GTK_DELETE_WORDS' o 'display-lines' / 'GTK_DELETE_DISPLAY_LINES' o 'display-line-ends' / 'GTK_DELETE_DISPLAY_LINE_ENDS' o 'paragraph-ends' / 'GTK_DELETE_PARAGRAPH_ENDS' o 'paragraphs' / 'GTK_DELETE_PARAGRAPHS' o 'whitespace' / 'GTK_DELETE_WHITESPACE' enum Gtk2::EntryIconPosition o 'primary' / 'GTK_ENTRY_ICON_PRIMARY' o 'secondary' / 'GTK_ENTRY_ICON_SECONDARY' flags Gtk2::Gdk::DragAction o 'default' / 'GDK_ACTION_DEFAULT' o 'copy' / 'GDK_ACTION_COPY' o 'move' / 'GDK_ACTION_MOVE' o 'link' / 'GDK_ACTION_LINK' o 'private' / 'GDK_ACTION_PRIVATE' o 'ask' / 'GDK_ACTION_ASK' enum Gtk2::ImageType o 'empty' / 'GTK_IMAGE_EMPTY' o 'pixmap' / 'GTK_IMAGE_PIXMAP' o 'image' / 'GTK_IMAGE_IMAGE' o 'pixbuf' / 'GTK_IMAGE_PIXBUF' o 'stock' / 'GTK_IMAGE_STOCK' o 'icon-set' / 'GTK_IMAGE_ICON_SET' o 'animation' / 'GTK_IMAGE_ANIMATION' o 'icon-name' / 'GTK_IMAGE_ICON_NAME' o 'gicon' / 'GTK_IMAGE_GICON' enum Gtk2::MovementStep o 'logical-positions' / 'GTK_MOVEMENT_LOGICAL_POSITIONS' o 'visual-positions' / 'GTK_MOVEMENT_VISUAL_POSITIONS' o 'words' / 'GTK_MOVEMENT_WORDS' o 'display-lines' / 'GTK_MOVEMENT_DISPLAY_LINES' o 'display-line-ends' / 'GTK_MOVEMENT_DISPLAY_LINE_ENDS' o 'paragraphs' / 'GTK_MOVEMENT_PARAGRAPHS' o 'paragraph-ends' / 'GTK_MOVEMENT_PARAGRAPH_ENDS' o 'pages' / 'GTK_MOVEMENT_PAGES' o 'buffer-ends' / 'GTK_MOVEMENT_BUFFER_ENDS' o 'horizontal-pages' / 'GTK_MOVEMENT_HORIZONTAL_PAGES' enum Gtk2::ShadowType o 'none' / 'GTK_SHADOW_NONE' o 'in' / 'GTK_SHADOW_IN' o 'out' / 'GTK_SHADOW_OUT' o 'etched-in' / 'GTK_SHADOW_ETCHED_IN' o 'etched-out' / 'GTK_SHADOW_ETCHED_OUT' SEE ALSO Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget COPYRIGHT Copyright (C) 2003-2011 by the gtk2-perl team. This software is licensed under the LGPL. See Gtk2 for a full notice. perl v5.38.0 2023-07-25 Gtk2::Entry(3)