Class Fox::FXTextField
In: rdoc-sources/FXTextField.rb
Parent: FXFrame

A text field is a single-line text entry widget. The text field widget supports clipboard for cut-and-paste operations. The text field also sends SEL_COMMAND when the focus moves to another control. TEXTFIELD_ENTER_ONLY can be passed to suppress this feature. Typically, this flag is used in dialogs that close when ENTER is hit in a text field.

Events

The following messages are sent from FXTextField to its target:

SEL_COMMAND:sent when the user presses the Enter key or tabs out of the text field; the message data is a String containing the text.
SEL_CHANGED:sent when the text changes; the message data is a String containing the text.
SEL_VERIFY:sent when the user attempts to enter new text in the text field; the message data is a String containing the proposed new text.
SEL_KEYPRESS:sent when a key goes down; the message data is an FXEvent instance.
SEL_KEYRELEASE:sent when a key goes up; the message data is an FXEvent instance.
SEL_LEFTBUTTONPRESS:sent when the left mouse button goes down; the message data is an FXEvent instance.
SEL_LEFTBUTTONRELEASE:sent when the left mouse button goes up; the message data is an FXEvent instance.
SEL_MIDDLEBUTTONPRESS:sent when the middle mouse button goes down; the message data is an FXEvent instance.
SEL_MIDDLEBUTTONRELEASE:sent when the middle mouse button goes up; the message data is an FXEvent instance.

Textfield styles

TEXTFIELD_PASSWD:Password mode
TEXTFIELD_INTEGER:Integer mode
TEXTFIELD_REAL:Real mode
TEXTFIELD_READONLY:NOT editable
TEXTFIELD_ENTER_ONLY:Only callback when enter hit
TEXTFIELD_LIMITED:Limit entry to given number of columns
TEXTFIELD_OVERSTRIKE:Overstrike mode
TEXTFIELD_NORMAL:FRAME_SUNKEN|FRAME_THICK

Message identifiers

ID_CURSOR_HOME:: ID_CURSOR_END:: ID_CURSOR_RIGHT:: ID_CURSOR_LEFT:: ID_MARK:: ID_EXTEND:: ID_SELECT_ALL:: ID_DESELECT_ALL:: ID_CUT_SEL:: ID_COPY_SEL:: ID_PASTE_SEL:: ID_DELETE_SEL:: ID_OVERST_STRING:: ID_INSERT_STRING:: ID_BACKSPACE:: ID_DELETE:: ID_TOGGLE_EDITABLE:: ID_TOGGLE_OVERSTRIKE:: ID_BLINK::

Methods

Attributes

anchorPos  [RW]  Anchor position [Integer]
cursorPos  [RW]  Cursor position [Integer]
editable  [W]  Text field editability [Boolean]
font  [RW]  Text font [FXFont]
helpText  [RW]  Status line help text [String]
justify  [RW]  Text justification mode, a combination of horizontal justification (JUSTIFY_LEFT, JUSTIFY_RIGHT, or JUSTIFY_CENTER_X), and vertical justification (JUSTIFY_TOP, JUSTIFY_BOTTOM, JUSTIFY_CENTER_Y) [Integer]
numColumns  [RW]  Default width of this text field, in terms of a number of columns times the width of the numeral ‘8’ [Integer]
selBackColor  [RW]  Background color for selected text [FXColor]
selTextColor  [RW]  Foreground color for selected text [FXColor]
text  [RW]  Text [String]
textColor  [RW]  Text color [FXColor]
textStyle  [RW]  Text style [Integer]
tipText  [RW]  Tool tip message [String]

Public Class methods

Return an initialized FXTextField instance. It should be wide enough to display ncols columns.

Parameters:

p:the parent window for this text field [FXComposite]
ncols:number of visible items [Integer]
target:the message target, if any, for this text field [FXObject]
selector:the message identifier for this text field [Integer]
opts:text field options [Integer]
x:initial x-position [Integer]
y:initial y-position [Integer]
width:initial width [Integer]
height:initial height [Integer]
padLeft:internal padding on the left side, in pixels [Integer]
padRight:internal padding on the right side, in pixels [Integer]
padTop:internal padding on the top side, in pixels [Integer]
padBottom:internal padding on the bottom side, in pixels [Integer]

Public Instance methods

Return true if text field may be edited

Extend the selection from the anchor to the given position pos.

Unselect the text

Scroll text to make the given position pos visible.

Set overstrike mode to true or false.

Return true if overstrike mode is set.

Return true if position pos is selected.

Return true if position pos is fully visible.

Select all text

Select len characters starting at given position pos.

[Validate]