Gtk2::Entry(3pm)

1Gtk2::Entry(3)        User Contributed Perl Documentation       Gtk2::Entry(3)
2
3
4

NAME

6       Gtk2::Entry
7

HIERARCHY

9         Glib::Object
10         +----Glib::InitiallyUnowned
11              +----Gtk2::Object
12                   +----Gtk2::Widget
13                        +----Gtk2::Entry
14

INTERFACES

16         Glib::Object::_Unregistered::AtkImplementorIface
17         Gtk2::CellEditable
18         Gtk2::Editable
19

METHODS

21       widget = Gtk2::Entry->new
22
23       widget = Gtk2::Entry->new_with_max_length ($max)
24
25           * $max (integer)
26
27       boolean = $entry->get_activates_default
28
29       $entry->set_activates_default ($setting)
30
31           * $setting (boolean)
32
33       double = $entry->get_alignment
34
35       $entry->set_alignment ($xalign)
36
37           * $xalign (double)
38
39       $entry->append_text ($text)
40
41           * $text (string)
42
43       entrycompletion or undef = $entry->get_completion
44
45       $entry->set_completion ($completion)
46
47           * $completion (Gtk2::EntryCompletion or undef)
48
49       $entry->set_editable ($editable)
50
51           * $editable (boolean)
52
53       boolean = $entry->get_has_frame
54
55       $entry->set_has_frame ($setting)
56
57           * $setting (boolean)
58
59       border or undef = $entry->get_inner_border
60
61       $entry->set_inner_border ($border)
62
63           * $border (Gtk2::Border or undef)
64
65       character = $entry->get_invisible_char
66
67       $entry->set_invisible_char ($ch)
68
69           * $ch (character)
70
71       layout = $entry->get_layout
72
73       integer = $entry->layout_index_to_text_index ($layout_index)
74
75           * $layout_index (integer)
76
77       (x, y) = $entry->get_layout_offsets
78
79       integer = $entry->get_max_length
80
81       $entry->set_max_length ($max)
82
83           * $max (integer)
84
85       $entry->set_position ($position)
86
87           * $position (integer)
88
89       $entry->prepend_text ($text)
90
91           * $text (string)
92
93       $entry->select_region ($start, $end)
94
95           * $start (integer)
96           * $end (integer)
97
98       string = $entry->get_text
99
100       integer = $entry->text_index_to_layout_index ($text_index)
101
102           * $text_index (integer)
103
104       $entry->set_text ($text)
105
106           * $text (string)
107
108       boolean = $entry->get_visibility
109
110       $entry->set_visibility ($visible)
111
112           * $visible (boolean)
113
114       integer = $entry->get_width_chars
115
116       $entry->set_width_chars ($n_chars)
117
118           * $n_chars (integer)
119

PROPERTIES

121       'activates-default' (boolean : readable / writable / private)
122           Whether to activate the default widget (such as the default button
123           in a dialog) when Enter is pressed
124
125       'cursor-position' (integer : readable / private)
126           The current position of the insertion cursor in chars
127
128       'editable' (boolean : readable / writable / private)
129           Whether the entry contents can be edited
130
131       'has-frame' (boolean : readable / writable / private)
132           FALSE removes outside bevel from entry
133
134       'inner-border' (Gtk2::Border : readable / writable / private)
135           Border between text and frame. Overrides the inner-border style
136           property
137
138       'invisible-char' (Glib::UInt : readable / writable / private)
139           The character to use when masking entry contents (in "password
140           mode")
141
142       'max-length' (integer : readable / writable / private)
143           Maximum number of characters for this entry. Zero if no maximum
144
145       'scroll-offset' (integer : readable / private)
146           Number of pixels of the entry scrolled off the screen to the left
147
148       'selection-bound' (integer : readable / private)
149           The position of the opposite end of the selection from the cursor
150           in chars
151
152       'text' (string : readable / writable / private)
153           The contents of the entry
154
155       'truncate-multiline' (boolean : readable / writable / private)
156           Whether to truncate multiline pastes to one line.
157
158       'visibility' (boolean : readable / writable / private)
159           FALSE displays the "invisible char" instead of the actual text
160           (password mode)
161
162       'width-chars' (integer : readable / writable / private)
163           Number of characters to leave space for in the entry
164
165       'xalign' (Glib::Float : readable / writable / private)
166           The horizontal alignment, from 0 (left) to 1 (right). Reversed for
167           RTL layouts.
168

SIGNALS

170       activate (Gtk2::Entry)
171       move-cursor (Gtk2::Entry, Gtk2::MovementStep, integer, boolean)
172       populate-popup (Gtk2::Entry, Gtk2::Menu)
173       insert-at-cursor (Gtk2::Entry, string)
174       delete-from-cursor (Gtk2::Entry, Gtk2::DeleteType, integer)
175       backspace (Gtk2::Entry)
176       cut-clipboard (Gtk2::Entry)
177       copy-clipboard (Gtk2::Entry)
178       paste-clipboard (Gtk2::Entry)
179       toggle-overwrite (Gtk2::Entry)
180

ENUMS AND FLAGS

182       enum Gtk2::DeleteType
183
184       * 'chars' / 'GTK_DELETE_CHARS'
185       * 'word-ends' / 'GTK_DELETE_WORD_ENDS'
186       * 'words' / 'GTK_DELETE_WORDS'
187       * 'display-lines' / 'GTK_DELETE_DISPLAY_LINES'
188       * 'display-line-ends' / 'GTK_DELETE_DISPLAY_LINE_ENDS'
189       * 'paragraph-ends' / 'GTK_DELETE_PARAGRAPH_ENDS'
190       * 'paragraphs' / 'GTK_DELETE_PARAGRAPHS'
191       * 'whitespace' / 'GTK_DELETE_WHITESPACE'
192
193       enum Gtk2::MovementStep
194
195       * 'logical-positions' / 'GTK_MOVEMENT_LOGICAL_POSITIONS'
196       * 'visual-positions' / 'GTK_MOVEMENT_VISUAL_POSITIONS'
197       * 'words' / 'GTK_MOVEMENT_WORDS'
198       * 'display-lines' / 'GTK_MOVEMENT_DISPLAY_LINES'
199       * 'display-line-ends' / 'GTK_MOVEMENT_DISPLAY_LINE_ENDS'
200       * 'paragraphs' / 'GTK_MOVEMENT_PARAGRAPHS'
201       * 'paragraph-ends' / 'GTK_MOVEMENT_PARAGRAPH_ENDS'
202       * 'pages' / 'GTK_MOVEMENT_PAGES'
203       * 'buffer-ends' / 'GTK_MOVEMENT_BUFFER_ENDS'
204       * 'horizontal-pages' / 'GTK_MOVEMENT_HORIZONTAL_PAGES'
205

COPYRIGHT

210       Copyright (C) 2003-2007 by the gtk2-perl team.
211
212       This software is licensed under the LGPL.  See Gtk2 for a full notice.
213
214
215
216perl v5.8.8                       2007-03-18                    Gtk2::Entry(3)