|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.trolltech.qt.internal.QSignalEmitterInternal
com.trolltech.qt.QSignalEmitter
com.trolltech.qt.QtJambiObject
com.trolltech.qt.core.QObject
com.trolltech.qt.gui.QWidget
com.trolltech.qt.gui.QLineEdit
public class QLineEdit
The QLineEdit
widget is a one-line text editor. A line edit allows the user to enter and edit a single line of plain text with a useful collection of editing functions, including undo and redo, cut and paste, and drag and drop.
By changing the echoMode()
of a line edit, it can also be used as a "write-only" field, for inputs such as passwords.
The length of the text can be constrained to maxLength()
. The text can be arbitrarily constrained using a validator()
or an inputMask()
, or both.
A related class is QTextEdit
which allows multi-line, rich text editing.
You can change the text with setText()
or insert()
. The text is retrieved with text()
; the displayed text (which may be different, see EchoMode
) is retrieved with displayText()
. Text can be selected with setSelection()
or selectAll()
, and the selection can be cut()
, copy()
ied and paste()
d. The text can be aligned with setAlignment()
.
When the text changes the textChanged()
signal is emitted; when the text changes other than by calling setText()
the textEdited()
signal is emitted; when the cursor is moved the cursorPositionChanged()
signal is emitted; and when the Return or Enter key is pressed the returnPressed()
signal is emitted.
When editing is finished, either because the line edit lost focus or Return/Enter is pressed the editingFinished()
signal is emitted.
Note that if there is a validator set on the line edit, the returnPressed()
/editingFinished()
signals will only be emitted if the validator returns QValidator::Acceptable
.
By default, QLineEdits have a frame as specified by the Windows and Motif style guides; you can turn it off by calling setFrame(false).
The default key bindings are described below. The line edit also provides a context menu (usually invoked by a right mouse click) that presents some of these editing options.
Left Arrow | Moves the cursor one character to the left. |
Shift+Left Arrow | Moves and selects text one character to the left. |
Right Arrow | Moves the cursor one character to the right. |
Shift+Right Arrow | Moves and selects text one character to the right. |
Home | Moves the cursor to the beginning of the line. |
End | Moves the cursor to the end of the line. |
Backspace | Deletes the character to the left of the cursor. |
Ctrl+Backspace | Deletes the word to the left of the cursor. |
Delete | Deletes the character to the right of the cursor. |
Ctrl+Delete | Deletes the word to the right of the cursor. |
Ctrl+A | Select all. |
Ctrl+C | Copies the selected text to the clipboard. |
Ctrl+Insert | Copies the selected text to the clipboard. |
Ctrl+K | Deletes to the end of the line. |
Ctrl+V | Pastes the clipboard text into line edit. |
Shift+Insert | Pastes the clipboard text into line edit. |
Ctrl+X | Deletes the selected text and copies it to the clipboard. |
Shift+Delete | Deletes the selected text and copies it to the clipboard. |
Ctrl+Z | Undoes the last operation. |
Ctrl+Y | Redoes the last undone operation. |
![]() | A line edit shown in the Macintosh widget style. |
![]() | A line edit shown in the Windows XP widget style. |
![]() | A line edit shown in the Plastique widget style. |
QTextEdit
, QLabel
, QComboBox
, GUI Design Handbook: Field, Entry, and Line Edits Example.
Nested Class Summary | |
---|---|
static class |
QLineEdit.EchoMode
This enum type describes how a line edit should display its contents. |
Nested classes/interfaces inherited from class com.trolltech.qt.gui.QWidget |
---|
QWidget.RenderFlag, QWidget.RenderFlags |
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter |
---|
QSignalEmitter.AbstractSignal, QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9 |
Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal |
---|
com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal |
Field Summary | |
---|---|
QSignalEmitter.Signal2 |
cursorPositionChanged
This signal takes 2 generic argument(s). |
QSignalEmitter.Signal0 |
editingFinished
This signal is emitted when the Return or Enter key is pressed or the line edit loses focus. |
QSignalEmitter.Signal0 |
returnPressed
This signal is emitted when the Return or Enter key is pressed. |
QSignalEmitter.Signal0 |
selectionChanged
This signal is emitted whenever the selection changes. |
QSignalEmitter.Signal1 |
textChanged
This signal takes 1 generic argument(s). |
QSignalEmitter.Signal1 |
textEdited
This signal takes 1 generic argument(s). |
Fields inherited from class com.trolltech.qt.gui.QWidget |
---|
customContextMenuRequested |
Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal |
---|
currentSender |
Constructor Summary | |
---|---|
QLineEdit()
Constructs a line edit with no text. |
|
QLineEdit(QWidget parent)
Constructs a line edit with no text. |
|
QLineEdit(java.lang.String arg__1)
Constructs a line edit containing the text contents. |
|
QLineEdit(java.lang.String arg__1,
QWidget parent)
Constructs a line edit containing the text contents. |
Method Summary | |
---|---|
Qt.Alignment |
alignment()
This property holds the alignment of the line edit. |
void |
backspace()
If no text is selected, deletes the character to the left of the text cursor and moves the cursor one position to the left. |
void |
clear()
Clears the contents of the line edit. |
QCompleter |
completer()
Returns the current QCompleter that provides completions. |
void |
copy()
Copies the selected text to the clipboard, if there is any, and if echoMode() is Normal . |
QMenu |
createStandardContextMenu()
This function creates the standard context menu which is shown when the user clicks on the line edit with the right mouse button. |
void |
cursorBackward(boolean mark)
Moves the cursor back steps characters. |
void |
cursorBackward(boolean mark,
int steps)
Moves the cursor back steps characters. |
void |
cursorForward(boolean mark)
Moves the cursor forward steps characters. |
void |
cursorForward(boolean mark,
int steps)
Moves the cursor forward steps characters. |
int |
cursorPosition()
This property holds the current cursor position for this line edit. |
int |
cursorPositionAt(QPoint pos)
Returns the cursor position under the point pos. |
protected QRect |
cursorRect()
Returns a rectangle that includes the lineedit cursor. |
void |
cursorWordBackward(boolean mark)
Moves the cursor one word backward. |
void |
cursorWordForward(boolean mark)
Moves the cursor one word forward. |
void |
cut()
Copies the selected text to the clipboard and deletes it, if there is any, and if echoMode() is Normal . |
void |
del()
If no text is selected, deletes the character to the right of the text cursor. |
void |
deselect()
Deselects any selected text. |
java.lang.String |
displayText()
This property holds the displayed text. |
boolean |
dragEnabled()
This property holds whether the lineedit starts a drag if the user presses and moves the mouse on some selected text. |
QLineEdit.EchoMode |
echoMode()
This property holds the line edit's echo mode. |
void |
end(boolean mark)
Moves the text cursor to the end of the line unless it is already there. |
boolean |
hasAcceptableInput()
This property holds whether the input satisfies the inputMask and the validator.. |
boolean |
hasFrame()
This property holds whether the line edit draws itself with a frame. |
boolean |
hasSelectedText()
This property holds whether there is any text selected. |
void |
home(boolean mark)
Moves the text cursor to the beginning of the line unless it is already there. |
protected void |
initStyleOption(QStyleOptionFrame option)
This is a overloaded function provided for convenience. |
java.lang.String |
inputMask()
This property holds The validation input mask. |
void |
insert(java.lang.String arg__1)
Deletes any selected text, inserts newText, and validates the result. |
boolean |
isModified()
This property holds whether the line edit's contents has been modified by the user. |
boolean |
isReadOnly()
This property holds whether the line edit is read only. |
boolean |
isRedoAvailable()
This property holds whether redo is available. |
boolean |
isUndoAvailable()
This property holds whether undo is available. |
int |
maxLength()
This property holds the maximum permitted length of the text. |
void |
paste()
Inserts the clipboard's text at the cursor position, deleting any selected text, providing the line edit is not read-only . |
void |
redo()
Redoes the last operation if redo is available . |
void |
selectAll()
Selects all the text (i. |
java.lang.String |
selectedText()
This property holds the selected text. |
int |
selectionStart()
selectionStart() returns the index of the first selected character in the line edit or -1 if no text is selected. |
void |
setAlignment(Qt.Alignment flag)
This property holds the alignment of the line edit. |
void |
setAlignment(Qt.AlignmentFlag[] flag)
This property holds the alignment of the line edit. |
void |
setCompleter(QCompleter completer)
Sets this line edit to provide auto completions from the completer, c. |
void |
setCursorPosition(int arg__1)
This property holds the current cursor position for this line edit. |
void |
setDragEnabled(boolean b)
This property holds whether the lineedit starts a drag if the user presses and moves the mouse on some selected text. |
void |
setEchoMode(QLineEdit.EchoMode arg__1)
This property holds the line edit's echo mode. |
void |
setFrame(boolean arg__1)
This property holds whether the line edit draws itself with a frame. |
void |
setInputMask(java.lang.String inputMask)
This property holds The validation input mask. |
void |
setMaxLength(int arg__1)
This property holds the maximum permitted length of the text. |
void |
setModified(boolean arg__1)
This property holds whether the line edit's contents has been modified by the user. |
void |
setReadOnly(boolean arg__1)
This property holds whether the line edit is read only. |
void |
setSelection(int arg__1,
int arg__2)
Selects text from position start and for length characters. |
void |
setText(java.lang.String arg__1)
This property holds the line edit's text. |
void |
setValidator(QValidator arg__1)
Sets this line edit to only accept input that the validator, v, will accept. |
java.lang.String |
text()
This property holds the line edit's text. |
void |
undo()
Undoes the last operation if undo is available . |
QValidator |
validator()
Returns a pointer to the current input validator, or 0 if no validator has been set. |
Methods inherited from class com.trolltech.qt.core.QObject |
---|
childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, indexOfProperty, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, properties, property, removeEventFilter, setObjectName, setParent, setProperty, startTimer, timerEvent, toString, userProperty |
Methods inherited from class com.trolltech.qt.QtJambiObject |
---|
dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr |
Methods inherited from class com.trolltech.qt.QSignalEmitter |
---|
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread |
Methods inherited from class com.trolltech.qt.internal.QSignalEmitterInternal |
---|
__qt_signalInitialization |
Methods inherited from class java.lang.Object |
---|
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.trolltech.qt.QtJambiInterface |
---|
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership |
Field Detail |
---|
public final QSignalEmitter.Signal2 cursorPositionChanged
This signal takes 2 generic argument(s). We list their type and the name they go by in the description of this signal. <java.lang.Integer(named: old), java.lang.Integer(named: new)>:
This signal is emitted whenever the cursor moves. The previous position is given by old, and the new position by new.
setCursorPosition()
, and cursorPosition()
.
public final QSignalEmitter.Signal0 editingFinished
validator()
or inputMask()
set on the line edit and enter/return is pressed, the editingFinished()
signal will only be emitted if the input follows the inputMask()
and the validator()
returns QValidator::Acceptable
.
public final QSignalEmitter.Signal0 returnPressed
validator()
or inputMask()
set on the line edit, the returnPressed()
signal will only be emitted if the input follows the inputMask()
and the validator()
returns QValidator::Acceptable
.
public final QSignalEmitter.Signal0 selectionChanged
hasSelectedText()
, and selectedText()
.
public final QSignalEmitter.Signal1 textChanged
This signal takes 1 generic argument(s). We list their type and the name they go by in the description of this signal. <java.lang.String(named: text)>:
This signal is emitted whenever the text changes. The text argument is the new text.
Unlike textEdited()
, this signal is also emitted when the text is changed programmatically, for example, by calling setText()
.
public final QSignalEmitter.Signal1 textEdited
This signal takes 1 generic argument(s). We list their type and the name they go by in the description of this signal. <java.lang.String(named: text)>:
This signal is emitted whenever the text is edited. The text argument is the next text.
Unlike textChanged()
, this signal is not emitted when the text is changed programmatically, for example, by calling setText()
.
Constructor Detail |
---|
public QLineEdit()
The maximum text length is set to 32767 characters.
The parent argument is sent to the QWidget
constructor.
setText()
, and setMaxLength()
.
public QLineEdit(QWidget parent)
The maximum text length is set to 32767 characters.
The parent argument is sent to the QWidget
constructor.
setText()
, and setMaxLength()
.
public QLineEdit(java.lang.String arg__1)
The cursor position is set to the end of the line and the maximum text length to 32767 characters.
The parent and argument is sent to the QWidget
constructor.
text()
, and setMaxLength()
.
public QLineEdit(java.lang.String arg__1, QWidget parent)
The cursor position is set to the end of the line and the maximum text length to 32767 characters.
The parent and argument is sent to the QWidget
constructor.
text()
, and setMaxLength()
.
Method Detail |
---|
public final Qt.Alignment alignment()
Qt::AlignJustify
will map to Qt::AlignLeft
. By default, this property contains a combination of Qt::AlignLeft
and Qt::AlignVCenter
.
public final void backspace()
del()
.
public final void clear()
setText()
, and insert()
.
public final QCompleter completer()
QCompleter
that provides completions. setCompleter()
.
public final void copy()
echoMode()
is Normal
. cut()
, and paste()
.
public final QMenu createStandardContextMenu()
contextMenuEvent()
handler. The popup menu's ownership is transferred to the caller.
public final void cursorBackward(boolean mark)
cursorForward()
.
public final void cursorBackward(boolean mark, int steps)
cursorForward()
.
public final void cursorForward(boolean mark)
cursorBackward()
.
public final void cursorForward(boolean mark, int steps)
cursorBackward()
.
public final int cursorPosition()
By default, this property contains a value of 0.
public final int cursorPositionAt(QPoint pos)
protected final QRect cursorRect()
public final void cursorWordBackward(boolean mark)
cursorWordForward()
.
public final void cursorWordForward(boolean mark)
cursorWordBackward()
.
public final void cut()
echoMode()
is Normal
. If the current validator disallows deleting the selected text, cut()
will copy without deleting.
copy()
, paste()
, and setValidator()
.
public final void del()
backspace()
.
public final void deselect()
setSelection()
, and selectAll()
.
public final java.lang.String displayText()
echoMode
is Normal
this returns the same as text()
; if EchoMode
is Password
or PasswordEchoOnEdit
it returns a string of asterisks text()
.length() characters long, e.g. "******"; if EchoMode
is NoEcho
returns an empty string, "". By default, this property contains an empty string.
setEchoMode()
, text()
, and EchoMode
.
public final boolean dragEnabled()
public final QLineEdit.EchoMode echoMode()
The most common setting is Normal
, in which the text entered by the user is displayed verbatim, but QLineEdit
also supports modes that allow the entered text to be suppressed or obscured: these include NoEcho
, Password
and PasswordEchoOnEdit
.
The widget's display and the ability to copy or drag the text is affected by this setting.
By default, this property is set to Normal
.
EchoMode
, and displayText()
.
public final void end(boolean mark)
home()
.
public final boolean hasAcceptableInput()
inputMask
and the validator.. By default, this property is true. setInputMask()
, and setValidator()
.
public final boolean hasFrame()
public final boolean hasSelectedText()
hasSelectedText()
returns true if some or all of the text has been selected by the user; otherwise returns false. By default, this property is false.
selectedText()
.
public final void home(boolean mark)
end()
.
public final java.lang.String inputMask()
inputMask()
returns an empty string. Sets the QLineEdit
's validation mask. Validators can be used instead of, or in conjunction with masks; see setValidator()
.
Unset the mask and return to normal QLineEdit
operation by passing an empty string ("") or just calling setInputMask()
with no arguments.
The table below shows the characters that can be used in an input mask. A space character, the default character for a blank, is needed for cases where a character is permitted but not required.
A | ASCII alphabetic character required. A-Z, a-z. |
a | ASCII alphabetic character permitted but not required. |
N | ASCII alphanumeric character required. A-Z, a-z, 0-9. |
n | ASCII alphanumeric character permitted but not required. |
X | Any character required. |
x | Any character permitted but not required. |
9 | ASCII digit required. 0-9. |
0 | ASCII digit permitted but not required. |
D | ASCII digit required. 1-9. |
d | ASCII digit permitted but not required (1-9). |
# | ASCII digit or plus/minus sign permitted but not required. |
H | Hexadecimal character required. A-F, a-f, 0-9. |
h | Hexadecimal character permitted but not required. |
B | Binary character required. 0-1. |
b | Binary character permitted but not required. |
> | All following alphabetic characters are uppercased. |
< | All following alphabetic characters are lowercased. |
! | Switch off case conversion. |
\ | Use \ to escape the special characters listed above to use them as separators. |
Examples:
000.000.000.000;_ | IP address; blanks are _. |
HH:HH:HH:HH:HH:HH;_ | MAC address |
0000-00-00 | ISO Date; blanks are space |
>AAAAA-AAAAA-AAAAA-AAAAA-AAAAA;# | License number; blanks are - and all (alphabetic) characters are converted to uppercase. |
validators
. maxLength
.
public final void insert(java.lang.String arg__1)
setText()
, and clear()
.
public final boolean isModified()
QLineEdit
; it has a default value of false and is changed to true whenever the user changes the line edit's contents. This is useful for things that need to provide a default value but do not start out knowing what the default should be (perhaps it depends on other fields on the form). Start the line edit without the best default, and when the default is known, if modified() returns false (the user hasn't entered any text), insert the default value.
Calling setText()
resets the modified flag to false.
public final boolean isReadOnly()
echoMode()
is Normal
), but cannot edit it. QLineEdit
does not show a cursor in read-only mode.
By default, this property is false.
public final boolean isRedoAvailable()
By default, this property is false.
public final boolean isUndoAvailable()
By default, this property is false.
public final int maxLength()
If truncation occurs any selected text will be unselected, the cursor position is set to 0 and the first part of the string is shown.
If the line edit has an input mask, the mask defines the maximum string length.
By default, this property contains a value of 32767.
inputMask
.
public final void paste()
read-only
. If the end result would not be acceptable to the current validator
, nothing happens.
copy()
, and cut()
.
public final void redo()
available
.
public final void selectAll()
setSelection()
, and deselect()
.
public final java.lang.String selectedText()
By default, this property contains an empty string.
hasSelectedText()
.
public final int selectionStart()
selectionStart()
returns the index of the first selected character in the line edit or -1 if no text is selected. selectedText()
.
public final void setAlignment(Qt.AlignmentFlag[] flag)
Qt::AlignJustify
will map to Qt::AlignLeft
. By default, this property contains a combination of Qt::AlignLeft
and Qt::AlignVCenter
.
public final void setAlignment(Qt.Alignment flag)
Qt::AlignJustify
will map to Qt::AlignLeft
. By default, this property contains a combination of Qt::AlignLeft
and Qt::AlignVCenter
.
public final void setCompleter(QCompleter completer)
QCompleter::setCompletionMode()
. To use a QCompleter
with a QValidator
or QLineEdit::inputMask
, you need to ensure that the model provided to QCompleter
contains valid entries. You can use the QSortFilterProxyModel
to ensure that the QCompleter
's model contains only valid entries.
If c == 0, setCompleter()
removes the current completer, effectively disabling auto completion.
completer()
, and QCompleter
.
public final void setCursorPosition(int arg__1)
By default, this property contains a value of 0.
public final void setDragEnabled(boolean b)
public final void setEchoMode(QLineEdit.EchoMode arg__1)
The most common setting is Normal
, in which the text entered by the user is displayed verbatim, but QLineEdit
also supports modes that allow the entered text to be suppressed or obscured: these include NoEcho
, Password
and PasswordEchoOnEdit
.
The widget's display and the ability to copy or drag the text is affected by this setting.
By default, this property is set to Normal
.
EchoMode
, and displayText()
.
public final void setFrame(boolean arg__1)
public final void setInputMask(java.lang.String inputMask)
inputMask()
returns an empty string. Sets the QLineEdit
's validation mask. Validators can be used instead of, or in conjunction with masks; see setValidator()
.
Unset the mask and return to normal QLineEdit
operation by passing an empty string ("") or just calling setInputMask()
with no arguments.
The table below shows the characters that can be used in an input mask. A space character, the default character for a blank, is needed for cases where a character is permitted but not required.
A | ASCII alphabetic character required. A-Z, a-z. |
a | ASCII alphabetic character permitted but not required. |
N | ASCII alphanumeric character required. A-Z, a-z, 0-9. |
n | ASCII alphanumeric character permitted but not required. |
X | Any character required. |
x | Any character permitted but not required. |
9 | ASCII digit required. 0-9. |
0 | ASCII digit permitted but not required. |
D | ASCII digit required. 1-9. |
d | ASCII digit permitted but not required (1-9). |
# | ASCII digit or plus/minus sign permitted but not required. |
H | Hexadecimal character required. A-F, a-f, 0-9. |
h | Hexadecimal character permitted but not required. |
B | Binary character required. 0-1. |
b | Binary character permitted but not required. |
> | All following alphabetic characters are uppercased. |
< | All following alphabetic characters are lowercased. |
! | Switch off case conversion. |
\ | Use \ to escape the special characters listed above to use them as separators. |
Examples:
000.000.000.000;_ | IP address; blanks are _. |
HH:HH:HH:HH:HH:HH;_ | MAC address |
0000-00-00 | ISO Date; blanks are space |
>AAAAA-AAAAA-AAAAA-AAAAA-AAAAA;# | License number; blanks are - and all (alphabetic) characters are converted to uppercase. |
validators
. maxLength
.
public final void setMaxLength(int arg__1)
If truncation occurs any selected text will be unselected, the cursor position is set to 0 and the first part of the string is shown.
If the line edit has an input mask, the mask defines the maximum string length.
By default, this property contains a value of 32767.
inputMask
.
public final void setModified(boolean arg__1)
QLineEdit
; it has a default value of false and is changed to true whenever the user changes the line edit's contents. This is useful for things that need to provide a default value but do not start out knowing what the default should be (perhaps it depends on other fields on the form). Start the line edit without the best default, and when the default is known, if modified() returns false (the user hasn't entered any text), insert the default value.
Calling setText()
resets the modified flag to false.
public final void setReadOnly(boolean arg__1)
echoMode()
is Normal
), but cannot edit it. QLineEdit
does not show a cursor in read-only mode.
By default, this property is false.
public final void setSelection(int arg__1, int arg__2)
deselect()
, selectAll()
, and selectedText()
.
public final void setText(java.lang.String arg__1)
modified
property to false. The text is not validated when inserted with setText()
. The text is truncated to maxLength()
length.
By default, this property contains an empty string.
insert()
, and clear()
.
public final void setValidator(QValidator arg__1)
If v == 0, setValidator()
removes the current input validator. The initial setting is to have no input validator (i.e. any input is accepted up to maxLength()
).
validator()
, QIntValidator
, QDoubleValidator
, and QRegExpValidator
.
public final java.lang.String text()
modified
property to false. The text is not validated when inserted with setText()
. The text is truncated to maxLength()
length.
By default, this property contains an empty string.
insert()
, and clear()
.
public final void undo()
available
. Deselects any current selection, and updates the selection start to the current cursor position.
public final QValidator validator()
setValidator()
.
protected final void initStyleOption(QStyleOptionFrame option)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |