Gtk2::Entry

Section: User Contributed Perl Documentation (3)
Updated: 2008-05-05
Index Return to Main Contents
 

NAME

Gtk2::Entry  

HIERARCHY

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

 

INTERFACES

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

 

METHODS

 

widget = Gtk2::Entry->new

 

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)
 

entrycompletion or undef = $entry->get_completion

Since: gtk+ 2.4
 

$entry->set_completion ($completion)

* $completion (Gtk2::EntryCompletion or undef)

Since: gtk+ 2.4

 

$entry->set_editable ($editable)

* $editable (boolean)
 

boolean = $entry->get_has_frame

 

$entry->set_has_frame ($setting)

* $setting (boolean)
 

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)
 

$entry->set_position ($position)

* $position (integer)
 

$entry->prepend_text ($text)

* $text (string)
 

$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

 

$entry->set_text ($text)

* $text (string)
 

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 : readable / writable / private)
Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed
'cursor-position' (integer : readable / private)
The current position of the insertion cursor in chars
'editable' (boolean : readable / writable / private)
Whether the entry contents can be edited
'has-frame' (boolean : readable / writable / private)
FALSE removes outside bevel from entry
'inner-border' (Gtk2::Border : readable / writable / private)
Border between text and frame. Overrides the inner-border style property
'invisible-char' (Glib::UInt : readable / writable / private)
The character to use when masking entry contents (in ``password mode'')
'max-length' (integer : readable / writable / private)
Maximum number of characters for this entry. Zero if no maximum
'scroll-offset' (integer : readable / private)
Number of pixels of the entry scrolled off the screen to the left
'selection-bound' (integer : readable / private)
The position of the opposite end of the selection from the cursor in chars
'text' (string : readable / writable / private)
The contents of the entry
'truncate-multiline' (boolean : readable / writable / private)
Whether to truncate multiline pastes to one line.
'visibility' (boolean : readable / writable / private)
FALSE displays the ``invisible char'' instead of the actual text (password mode)
'width-chars' (integer : readable / writable / private)
Number of characters to leave space for in the entry
'xalign' (Glib::Float : readable / writable / private)
The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.
 

SIGNALS

activate (Gtk2::Entry)
move-cursor (Gtk2::Entry, Gtk2::MovementStep, integer, boolean)
insert-at-cursor (Gtk2::Entry, string)
delete-from-cursor (Gtk2::Entry, Gtk2::DeleteType, integer)
backspace (Gtk2::Entry)
cut-clipboard (Gtk2::Entry)
copy-clipboard (Gtk2::Entry)
paste-clipboard (Gtk2::Entry)
toggle-overwrite (Gtk2::Entry)
populate-popup (Gtk2::Entry, Gtk2::Menu)
 

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

SEE ALSO

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

COPYRIGHT

Copyright (C) 2003-2008 by the gtk2-perl team.

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


 

Index

NAME
HIERARCHY
INTERFACES
METHODS
widget = Gtk2::Entry->new
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)
entrycompletion or undef = $entry->get_completion
$entry->set_completion ($completion)
$entry->set_editable ($editable)
boolean = $entry->get_has_frame
$entry->set_has_frame ($setting)
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)
$entry->set_position ($position)
$entry->prepend_text ($text)
$entry->select_region ($start, $end)
string = $entry->get_text
integer = $entry->text_index_to_layout_index ($text_index)
$entry->set_text ($text)
boolean = $entry->get_visibility
$entry->set_visibility ($visible)
integer = $entry->get_width_chars
$entry->set_width_chars ($n_chars)
PROPERTIES
SIGNALS
ENUMS AND FLAGS
enum Gtk2::DeleteType
enum Gtk2::MovementStep
SEE ALSO
COPYRIGHT

linux.jgfs.net manual pages