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)

•: $buffer (Gtk2::EntryBuffer)

Since: gtk+ 2.18

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

•: $max (integer)

boolean = $entry->get_activates_default

$entry->set_activates_default ($setting)

•: $setting (boolean)

double = $entry->get_alignment

Since: gtk+ 2.4

$entry->set_alignment ($xalign)

•: $xalign (double)

Since: gtk+ 2.4

$entry->append_text ($text)

•: $text (string)

entrybuffer = $entry->get_buffer

Since: gtk+ 2.18

$entry->set_buffer ($buffer)

•: $buffer (Gtk2::EntryBuffer)

Since: gtk+ 2.18

entrycompletion or undef = $entry->get_completion

Since: gtk+ 2.4

$entry->set_completion ($completion)

•: $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)

•: $adjustment (Gtk2::Adjustment or undef)

Since: gtk+ 2.12

$entry->set_editable ($editable)

•: $editable (boolean)

boolean = $entry->get_has_frame

$entry->set_has_frame ($setting)

•: $setting (boolean)

boolean = $entry->get_icon_activatable ($icon_pos)

•: $icon_pos (Gtk2::EntryIconPosition)

Since: gtk+ 2.16

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

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

Since: gtk+ 2.16

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

$x (integer)
$y (integer)

Since: gtk+ 2.16

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

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

Since: gtk+ 2.16

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

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

Since: gtk+ 2.16

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

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

Since: gtk+ 2.16

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

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

Since: gtk+ 2.16

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

•: $icon_pos (Gtk2::EntryIconPosition)

Since: gtk+ 2.16

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

•: $icon_pos (Gtk2::EntryIconPosition)

Since: gtk+ 2.16

boolean = $entry->get_icon_sensitive ($icon_pos)

•: $icon_pos (Gtk2::EntryIconPosition)

Since: gtk+ 2.16

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

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

Since: gtk+ 2.16

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

•: $icon_pos (Gtk2::EntryIconPosition)

Since: gtk+ 2.16

imagetype = $entry->get_icon_storage_type ($icon_pos)

•: $icon_pos (Gtk2::EntryIconPosition)

Since: gtk+ 2.16

•: $icon_pos (Gtk2::EntryIconPosition)

Since: gtk+ 2.16

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

Since: gtk+ 2.16

•: $icon_pos (Gtk2::EntryIconPosition)

Since: gtk+ 2.16

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

Since: gtk+ 2.16

window = $entry->get_icon_window ($icon_pos)

•: $icon_pos (Gtk2::EntryIconPosition)

Since: gtk+ 2.20

boolean = $entry->im_context_filter_keypress ($event)

•: $event (Gtk2::Gdk::Event)

Since: gtk+ 2.22

border or undef = $entry->get_inner_border

Since: gtk+ 2.10

$entry->set_inner_border ($border)

•: $border (Gtk2::Border or undef)

Since: gtk+ 2.10

character = $entry->get_invisible_char

$entry->set_invisible_char ($ch)

•: $ch (character)

layout = $entry->get_layout

integer = $entry->layout_index_to_text_index ($layout_index)

•: $layout_index (integer)

Since: gtk+ 2.6

(x, y) = $entry->get_layout_offsets

integer = $entry->get_max_length

$entry->set_max_length ($max)

•: $max (integer)

boolean = $entry->get_overwrite_mode

Since: gtk+ 2.14

$entry->set_overwrite_mode ($overwrite)

•: $overwrite (boolean)

Since: gtk+ 2.14

$entry->set_position ($position)

•: $position (integer)

$entry->prepend_text ($text)

•: $text (string)

double = $entry->get_progress_fraction

Since: gtk+ 2.16

$entry->set_progress_fraction ($fraction)

•: $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)

•: $fraction (double)

Since: gtk+ 2.16

$entry->reset_im_context

Since: gtk+ 2.22

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

$start (integer)
$end (integer)

string = $entry->get_text

integer = $entry->text_index_to_layout_index ($text_index)

•: $text_index (integer)

Since: gtk+ 2.6

unsigned = $entry->get_text_length

Since: gtk+ 2.14

$entry->set_text ($text)

•: $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)

•: $visible (boolean)

integer = $entry->get_width_chars

$entry->set_width_chars ($n_chars)

•: $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

'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'

COPYRIGHT

This software is licensed under the LGPL. See Gtk2 for a full notice.