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::Buildable
18         Gtk2::Editable
19         Gtk2::CellEditable
20

METHODS

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

PROPERTIES

127       'activates-default' (boolean : readable / writable / private)
128           Whether to activate the default widget (such as the default button
129           in a dialog) when Enter is pressed
130
131       'buffer' (Glib::Object::_Unregistered::GtkEntryBuffer : readable /
132       writable / construct / private)
133           Text buffer object which actually stores entry text
134
135       'caps-lock-warning' (boolean : readable / writable / private)
136           Whether password entries will show a warning when Caps Lock is on
137
138       'cursor-position' (integer : readable / private)
139           The current position of the insertion cursor in chars
140
141       'editable' (boolean : readable / writable / private)
142           Whether the entry contents can be edited
143
144       'has-frame' (boolean : readable / writable / private)
145           FALSE removes outside bevel from entry
146
147       'im-module' (string : readable / writable / private)
148           Which IM module should be used
149
150       'inner-border' (Gtk2::Border : readable / writable / private)
151           Border between text and frame. Overrides the inner-border style
152           property
153
154       'invisible-char' (Glib::UInt : readable / writable / private)
155           The character to use when masking entry contents (in "password
156           mode")
157
158       'invisible-char-set' (boolean : readable / writable / private)
159           Whether the invisible char has been set
160
161       'max-length' (integer : readable / writable / private)
162           Maximum number of characters for this entry. Zero if no maximum
163
164       'overwrite-mode' (boolean : readable / writable / private)
165           Whether new text overwrites existing text
166
167       'primary-icon-activatable' (boolean : readable / writable / private)
168           Whether the primary icon is activatable
169
170       'primary-icon-gicon' (Glib::Object::_Unregistered::GIcon : readable /
171       writable / private)
172           GIcon for primary icon
173
174       'primary-icon-name' (string : readable / writable / private)
175           Icon name for primary icon
176
177       'primary-icon-pixbuf' (Gtk2::Gdk::Pixbuf : readable / writable /
178       private)
179           Primary pixbuf for the entry
180
181       'primary-icon-sensitive' (boolean : readable / writable / private)
182           Whether the primary icon is sensitive
183
184       'primary-icon-stock' (string : readable / writable / private)
185           Stock ID for primary icon
186
187       'primary-icon-storage-type' (Gtk2::ImageType : readable / private)
188           The representation being used for primary icon
189
190       'primary-icon-tooltip-markup' (string : readable / writable / private)
191           The contents of the tooltip on the primary icon
192
193       'primary-icon-tooltip-text' (string : readable / writable / private)
194           The contents of the tooltip on the primary icon
195
196       'progress-fraction' (double : readable / writable / private)
197           The current fraction of the task that's been completed
198
199       'progress-pulse-step' (double : readable / writable / private)
200           The fraction of total entry width to move the progress bouncing
201           block for each call to gtk_entry_progress_pulse()
202
203       'scroll-offset' (integer : readable / private)
204           Number of pixels of the entry scrolled off the screen to the left
205
206       'secondary-icon-activatable' (boolean : readable / writable / private)
207           Whether the secondary icon is activatable
208
209       'secondary-icon-gicon' (Glib::Object::_Unregistered::GIcon : readable /
210       writable / private)
211           GIcon for secondary icon
212
213       'secondary-icon-name' (string : readable / writable / private)
214           Icon name for secondary icon
215
216       'secondary-icon-pixbuf' (Gtk2::Gdk::Pixbuf : readable / writable /
217       private)
218           Secondary pixbuf for the entry
219
220       'secondary-icon-sensitive' (boolean : readable / writable / private)
221           Whether the secondary icon is sensitive
222
223       'secondary-icon-stock' (string : readable / writable / private)
224           Stock ID for secondary icon
225
226       'secondary-icon-storage-type' (Gtk2::ImageType : readable / private)
227           The representation being used for secondary icon
228
229       'secondary-icon-tooltip-markup' (string : readable / writable /
230       private)
231           The contents of the tooltip on the secondary icon
232
233       'secondary-icon-tooltip-text' (string : readable / writable / private)
234           The contents of the tooltip on the secondary icon
235
236       'selection-bound' (integer : readable / private)
237           The position of the opposite end of the selection from the cursor
238           in chars
239
240       'shadow-type' (Gtk2::ShadowType : readable / writable / private)
241           Which kind of shadow to draw around the entry when has-frame is set
242
243       'text' (string : readable / writable / private)
244           The contents of the entry
245
246       'text-length' (Glib::UInt : readable / private)
247           Length of the text currently in the entry
248
249       'truncate-multiline' (boolean : readable / writable / private)
250           Whether to truncate multiline pastes to one line.
251
252       'visibility' (boolean : readable / writable / private)
253           FALSE displays the "invisible char" instead of the actual text
254           (password mode)
255
256       'width-chars' (integer : readable / writable / private)
257           Number of characters to leave space for in the entry
258
259       'xalign' (Glib::Float : readable / writable / private)
260           The horizontal alignment, from 0 (left) to 1 (right). Reversed for
261           RTL layouts.
262

SIGNALS

264       activate (Gtk2::Entry)
265       preedit-changed (Gtk2::Entry, string)
266       move-cursor (Gtk2::Entry, Gtk2::MovementStep, integer, boolean)
267       insert-at-cursor (Gtk2::Entry, string)
268       delete-from-cursor (Gtk2::Entry, Gtk2::DeleteType, integer)
269       backspace (Gtk2::Entry)
270       cut-clipboard (Gtk2::Entry)
271       copy-clipboard (Gtk2::Entry)
272       paste-clipboard (Gtk2::Entry)
273       toggle-overwrite (Gtk2::Entry)
274       populate-popup (Gtk2::Entry, Gtk2::Menu)
275       icon-press (Gtk2::Entry, GtkEntryIconPosition, Gtk2::Gdk::Event)
276       icon-release (Gtk2::Entry, GtkEntryIconPosition, Gtk2::Gdk::Event)
277

ENUMS AND FLAGS

279   enum Gtk2::DeleteType
280       ·   'chars' / 'GTK_DELETE_CHARS'
281
282       ·   'word-ends' / 'GTK_DELETE_WORD_ENDS'
283
284       ·   'words' / 'GTK_DELETE_WORDS'
285
286       ·   'display-lines' / 'GTK_DELETE_DISPLAY_LINES'
287
288       ·   'display-line-ends' / 'GTK_DELETE_DISPLAY_LINE_ENDS'
289
290       ·   'paragraph-ends' / 'GTK_DELETE_PARAGRAPH_ENDS'
291
292       ·   'paragraphs' / 'GTK_DELETE_PARAGRAPHS'
293
294       ·   'whitespace' / 'GTK_DELETE_WHITESPACE'
295
296   enum Gtk2::ImageType
297       ·   'empty' / 'GTK_IMAGE_EMPTY'
298
299       ·   'pixmap' / 'GTK_IMAGE_PIXMAP'
300
301       ·   'image' / 'GTK_IMAGE_IMAGE'
302
303       ·   'pixbuf' / 'GTK_IMAGE_PIXBUF'
304
305       ·   'stock' / 'GTK_IMAGE_STOCK'
306
307       ·   'icon-set' / 'GTK_IMAGE_ICON_SET'
308
309       ·   'animation' / 'GTK_IMAGE_ANIMATION'
310
311       ·   'icon-name' / 'GTK_IMAGE_ICON_NAME'
312
313       ·   'gicon' / 'GTK_IMAGE_GICON'
314
315   enum Gtk2::MovementStep
316       ·   'logical-positions' / 'GTK_MOVEMENT_LOGICAL_POSITIONS'
317
318       ·   'visual-positions' / 'GTK_MOVEMENT_VISUAL_POSITIONS'
319
320       ·   'words' / 'GTK_MOVEMENT_WORDS'
321
322       ·   'display-lines' / 'GTK_MOVEMENT_DISPLAY_LINES'
323
324       ·   'display-line-ends' / 'GTK_MOVEMENT_DISPLAY_LINE_ENDS'
325
326       ·   'paragraphs' / 'GTK_MOVEMENT_PARAGRAPHS'
327
328       ·   'paragraph-ends' / 'GTK_MOVEMENT_PARAGRAPH_ENDS'
329
330       ·   'pages' / 'GTK_MOVEMENT_PAGES'
331
332       ·   'buffer-ends' / 'GTK_MOVEMENT_BUFFER_ENDS'
333
334       ·   'horizontal-pages' / 'GTK_MOVEMENT_HORIZONTAL_PAGES'
335
336   enum Gtk2::ShadowType
337       ·   'none' / 'GTK_SHADOW_NONE'
338
339       ·   'in' / 'GTK_SHADOW_IN'
340
341       ·   'out' / 'GTK_SHADOW_OUT'
342
343       ·   'etched-in' / 'GTK_SHADOW_ETCHED_IN'
344
345       ·   'etched-out' / 'GTK_SHADOW_ETCHED_OUT'
346
347   enum GtkEntryIconPosition
348       ·   'primary' / 'GTK_ENTRY_ICON_PRIMARY'
349
350       ·   'secondary' / 'GTK_ENTRY_ICON_SECONDARY'
351

COPYRIGHT

356       Copyright (C) 2003-2008 by the gtk2-perl team.
357
358       This software is licensed under the LGPL.  See Gtk2 for a full notice.
359
360
361
362perl v5.12.0                      2010-05-02                    Gtk2::Entry(3)