|
Graphics.UI.Gtk.Entry.Entry | Portability | portable (depends on GHC) | Stability | provisional | Maintainer | gtk2hs-users@lists.sourceforge.net |
|
|
|
|
|
Description |
A single line text entry field
|
|
Synopsis |
|
|
|
|
Detail
|
|
The Entry widget is a single line text entry widget. A fairly large set
of key bindings are supported by default. If the entered text is longer than
the allocation of the widget, the widget will scroll so that the cursor
position is visible.
|
|
Class Hierarchy
|
|
| GObject
| +----Object
| +----Widget
| +----Entry
| +----SpinButton
|
|
Types
|
|
|
|
|
|
|
|
|
|
|
|
|
Constructors
|
|
|
Creates a new Entry widget.
|
|
Methods
|
|
|
Sets the text in the widget to the given value, replacing the current
contents.
|
|
|
Retrieves the contents of the entry widget.
See also Graphics.UI.Gtk.Display.Entry.Editable.editableGetChars.
|
|
|
Appends the given text to the contents of the widget.
- Warning: this function is deprecated and should not be used in
newly-written code.
|
|
|
Prepends the given text to the contents of the widget.
- Warning: this function is deprecated and should not be used in
newly-written code.
|
|
|
:: EntryClass self | | => self | visible - True if the contents of the entry are displayed
as plaintext.
| -> Bool | | -> IO () | | Sets whether the contents of the entry are visible or not. When
visibility is set to False, characters are displayed as the invisible
char, and will also appear that way when the text in the entry widget is
copied elsewhere.
The default invisible char is the asterisk '*', but it can be changed
with entrySetInvisibleChar.
|
|
|
|
|
|
|
Sets the character to use in place of the actual text when
entrySetVisibility has been called to set text visibility to False. i.e.
this is the character used in "password mode" to show the user how many
characters have been typed. The default invisible char is an asterisk
('*'). If you set the invisible char to '\0', then the user will get
no feedback at all; there will be no text on the screen as they type.
|
|
|
:: EntryClass self | | => self | returns the current invisible char, or '\0', if the
entry does not show invisible text at all.
| -> IO Char | | Retrieves the character displayed in place of the real characters for
entries with visisbility set to false. See entrySetInvisibleChar.
|
|
|
|
:: EntryClass self | | => self | max - the maximum length of the entry, or 0 for no maximum.
(other than the maximum length of entries.) The value passed in
will be clamped to the range 0-65536.
| -> Int | | -> IO () | | Sets the maximum allowed length of the contents of the widget. If the
current contents are longer than the given length, then they will be
truncated to fit.
|
|
|
|
:: EntryClass self | | => self | returns the maximum allowed number of characters in Entry,
or 0 if there is no maximum.
| -> IO Int | | Retrieves the maximum allowed length of the text in entry. See
entrySetMaxLength.
|
|
|
entryGetActivatesDefault | Source |
|
:: EntryClass self | | => self | returns True if the entry will activate the default widget
| -> IO Bool | | Query whether pressing return will activate the default widget.
|
|
|
entrySetActivatesDefault | Source |
|
:: EntryClass self | | => self | setting - True to activate window's default widget on Enter
keypress
| -> Bool | | -> IO () | | If setting is True, pressing Enter in the entry will activate the
default widget for the window containing the entry. This usually means that
the dialog box containing the entry will be closed, since the default widget
is usually one of the dialog buttons.
(For experts: if setting is True, the entry calls
Graphics.UI.Gtk.Windows.Window.windowActivateDefault on the window
containing the entry, in the default
handler for the "activate" signal.)
This setting is useful in Dialog boxes where enter should press the
default button.
|
|
|
|
:: EntryClass self | | => self | returns whether the entry has a beveled frame
| -> IO Bool | | Query if the text Entry is displayed with a frame around it.
|
|
|
|
Sets whether the entry has a beveled frame around it.
|
|
|
|
|
|
:: EntryClass self | | => self | nChars - width in chars
| -> Int | | -> IO () | | Changes the size request of the entry to be about the right size for
nChars characters. Note that it changes the size request, the size can
still be affected by how you pack the widget into containers. If nChars is
-1, the size reverts to the default entry size.
This setting is only considered when the widget formulates its size
request. Make sure that it is not mapped (shown) before you change this
value.
|
|
|
|
:: EntryClass self | | => self | xalign - The horizontal alignment, from 0 (left) to 1
(right). Reversed for RTL layouts
| -> Float | | -> IO () | | Sets the alignment for the contents of the entry. This controls the
horizontal positioning of the contents when the displayed text is shorter
than the width of the entry.
- Available since Gtk version 2.4
|
|
|
|
|
|
|
Sets the auxiliary completion object to use with the entry. All further
configuration of the completion mechanism is done on completion using the
EntryCompletion API.
- Available since Gtk version 2.4
|
|
|
:: EntryClass self | | => self | returns The auxiliary completion object currently
in use by entry.
| -> IO EntryCompletion | | Returns the auxiliary completion object currently in use by the entry.
- Available since Gtk version 2.4
|
|
|
Attributes
|
|
|
The current position of the insertion cursor in chars.
Allowed values: [0,65535]
Default value: 0
|
|
|
The position of the opposite end of the selection from the cursor in
chars.
Allowed values: [0,65535]
Default value: 0
|
|
|
Whether the entry contents can be edited.
Default value: True
|
|
|
Maximum number of characters for this entry. Zero if no maximum.
Allowed values: [0,65535]
Default value: 0
|
|
|
False displays the "invisible char" instead of the actual text
(password mode).
Default value: True
|
|
|
False removes outside bevel from entry.
Default value: True
|
|
|
The character to use when masking entry contents (in "password mode").
Default value: '*'
|
|
|
Whether to activate the default widget (such as the default button in a
dialog) when Enter is pressed.
Default value: False
|
|
|
Number of characters to leave space for in the entry.
Allowed values: >= -1
Default value: -1
|
|
|
Number of pixels of the entry scrolled off the screen to the left.
Allowed values: >= 0
Default value: 0
|
|
|
The contents of the entry.
Default value: ""
|
|
|
The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL
layouts.
Allowed values: [0,1]
Default value: 0
|
|
|
'alignment' property. See entryGetAlignment and entrySetAlignment
|
|
|
'completion' property. See entryGetCompletion and
entrySetCompletion
|
|
Signals
|
|
|
|
|
Emitted when the user presses return within
the Entry field.
|
|
|
|
|
Emitted when the current selection has been
copied to the clipboard.
|
|
|
|
|
Emitted when the current selection has been
cut to the clipboard.
|
|
|
|
|
Emitted when the current selection has
been pasted from the clipboard.
|
|
|
|
|
Emitted when the user changes from
overwriting to inserting.
|
|
Produced by Haddock version 2.6.0 |