This enum describes how a line edit should display the action widgets.

See also

addAction(), removeAction(), QWidget::layoutDirection

This enum type describes how a line edit should display its contents.

See also

setEchoMode(), echoMode()

Constructs a line edit with no text. The parent argument is sent to the QWidget constructor. The maximum text length is set to 32767 characters.

See also

setText(), setMaxLength()

Constructs a line edit containing the text contents. The parent and argument is sent to the QWidget constructor. The cursor position is set to the end of the line and the maximum text length to 32767 characters.

See also

text(), setMaxLength()

Destroys the line edit.

Adds the icon to the list of existing actions available for this line edit. The location of the given action is added at the specified position.

Appends action to the list of existing actions available for this widget. A QAction list is typically used to create a context QMenu, however it can be represented in different ways depending on the widget.

A QWidget should only have one of each action. Adding an action which already exists will not cause the same action to be in the widget multiple times. The ownership of action is not transferred to this QWidget.

See also

removeAction(), insertAction(), actions(), QMenu

Add the action to the list of existing actions available for this line edit. The location of the given action is added at the specified position.

Returns the value of the alignment property.

If no text is selected, this method deletes the character to the left of the text cursor and moves the cursor one position to the left. If any text is selected, the cursor is moved to the beginning of the selected text and the selected text is deleted.

See also

del()

Reimplemented from QWidget::changeEvent()

Clears the contents of the line edit.

See also

setText(), insert()

Returns the current QCompleter.

See also

setCompleter()

Shows a context menu. The event parameter is used to obtain the position where the mouse cursor was when the event was generated.

If you do not want the line edit to have a context menu, you can set its contextMenuPolicy to Qt::NoContextMenu. If you want to customize the context menu, reimplement this method. If you want to extend the standard context menu, reimplement this function, call createStandardContextMenu() and extend the menu returned.

See also

setContextMenuPolicy()

Reimplemented from QWidget::contextMenuEvent()

Copies the selected text to the clipboard when the echoMode() is set to EchoMode::Normal.

See also

cut(), paste()

This method creates the standard context menu which is shown when the user clicks on the line edit with the right mouse button. It is called from the default contextMenuEvent() handler. The popup menu's ownership is transferred to the caller.

Moves the cursor back steps characters. If mark is true each character moved over is added to the selection. If mark is false the selection is cleared.

See also

cursorForward()

Moves the cursor forward steps characters. If mark is true each character moved over is added to the selection. If mark is false the selection is cleared.

See also

cursorBackward()

Returns the value of the cursorMoveStyle property.

Returns the value of the cursorPosition property.

Returns the cursor position under the point pos.

This signal is emitted whenever the cursor moves. The previous position is given by oldValue and the new position by newValue.

See also

setCursorPosition(), cursorPosition()

Returns a rectangle that includes the line edit cursor.

Moves the cursor one word backward. If mark is true the word is also selected.

See also

cursorWordForward()

Moves the cursor one word forward. If mark is true the word is also selected.

See also

cursorWordBackward()

Copies the selected text to the clipboard and deletes it when echoMode() is set to EchoMode::Normal. If the current validator disallows deleting the selected text, cut() will copy without deleting.

See also

copy(), paste(), setValidator()

If no text is selected, deletes the character to the right of the text cursor. If any text is selected, the cursor is moved to the beginning of the selected text and the selected text is deleted.

See also

backspace()

Deselects any selected text.

See also

setSelection(), selectAll()

Returns the value of the displayText property.

Returns the value of the property.

Reimplemented from QWidget::dragEnterEvent()

Reimplemented from QWidget::dragLeaveEvent()

Reimplemented from QWidget::dragMoveEvent()

Reimplemented from QWidget::dropEvent()

Returns the value of the echoMode property.

This signal is emitted when the Return or Enter key is pressed or the line edit loses focus. If there is a validator() or inputMask() set on the line edit and enter/return is pressed, the editingFinished() signal will only be emitted if the input matches the inputMask() and the validator() returns QValidator::Acceptable.

Moves the text cursor to the end of the line unless it is already there. If mark is true text is selected towards the last position, otherwise any selected text is unselected if the cursor is moved.

See also

home()

Reimplemented from QWidget::event()

Reimplemented from QWidget::focusInEvent()

Reimplemented from QWidget::focusOutEvent()

Returns the widget's text margins for left, top, right, and bottom.

See also

setTextMargins()

Returns the value of the acceptableInput property.

Returns the value of the frame property.

Returns the value of the hasSelectedText property.

Moves the text cursor to the beginning of the line unless it is already there. If mark is true, text is selected towards the first position, otherwise any selected text is unselected if the cursor is moved.

See also

end()

Initialize option with the values from this QLineEdit. This method is useful for subclasses when they need a QStyleOptionFrame but do not want to fill in all the information themselves.

See also

QStyleOption::initFrom()

Returns the value for the inputMask property.

See also

setInputMask()

Reimplemented from QWidget::inputMethodEvent()

Reimplemented from QWidget::inputMethodQuery()

Deletes any selected text, inserts newText and validates the result. If the result is invalid this method does nothing.

See also

setText(), clear()

Returns true if the clearButtonEnabled property is enabled, otherwise returns false.

Returns the value of the modified property.

Returns the value of the readOnly property.

Returns the value of the redoAvailable property.

Returns the value of the undoAvailable property.

Converts the given key press event into a line edit action. If Return or Enter is pressed and the current text is valid (or can be made valid by the validator), the signal returnPressed() is emitted.

The default key bindings are listed in the class detailed description.

Reimplemented from QWidget::keyPressEvent()

Returns the value of the maxLength property.

Returns a minimum size for the line edit. The width returned is enough for at least one character.

Reimplemented from QWidget::minimumSizeHint()

Reimplemented from QWidget::mouseDoubleClickEvent()

Reimplemented from QWidget::mouseMoveEvent()

Reimplemented from QWidget::mousePressEvent()

Reimplemented from QWidget::mouseReleaseEvent()

Reimplemented from QWidget::paintEvent()

Inserts the clipboard's text at the cursor position, deleting any selected text, providing the line edit is not read-only. If the end result would not be acceptable to the current validator then this method does nothing.

See also

copy(), cut()

Returns the value of the placeholderText property.

Redoes the last operation if redo is available.

This signal is emitted when the Return or Enter key is pressed. If there is a validator() or inputMask() set on the line edit, the returnPressed() signal will only be emitted if the input matches the inputMask() and the validator() returns QValidator::Acceptable.

Selects all the text and moves the cursor to the end. This is useful when a default value has been inserted. If the user types before clicking on the widget the default selected text will be deleted.

See also

setSelection(), deselect()

Returns the value of the property.

This signal is emitted when the selection changes.

See also

hasSelectedText(), selectedText()

Returns the index of the first selected character in the line edit or -1 if no text is selected.

See also

selectedText()

Sets the value of the alignment property.

Sets the value of the clearButtonEnabled property.

Sets this line edit to provide auto completion using completer. The completion mode is set using QCompleter::setCompletionMode(). If the value for completer is a nullptr this method removes the current QCompleter.

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.

See also

completer(), QCompleter

Sets the value of the cursorMoveStyle property to style.

Sets the value of the cursorPosition property.

Sets the value of the dragEnabled property to enable.

Sets the value of the echoMode property.

Sets the value of the frame property.

Sets the inputMask property to inputMask. To unset the mask and return to normal QLineEdit operation pass an empty string or call this method with no arguments.

Refer to the inputMask property for examples.

See also

QLineEdit::inputMask()

Sets the value of the maxLength property.

Sets the value of the modified property.

Sets the value of the placeholderText property.

Sets the value of the readOnly property.

Selects text from position start and for length characters. Negative lengths are allowed.

See also

deselect(), selectAll(), selectedText()

Sets the value of the text property to str.

Sets the margins around the text inside the frame.

See also

textMargins()

Sets the margins around the text inside the frame to have the sizes left, top, right, and bottom.

See also

textMargins(), getTextMargins()

Sets this line edit to check input using validator. This allows setting constraints on the text which may be entered. If the value for validator is a nullptr the current input QValidator is removed. The initial setting is to have no input QValidator.

See also

validator(), QIntValidator, QDoubleValidator, QRegularExpressionValidator

Returns a recommended size for the widget. The width returned, which is in pixels, is usually enough for about 15 to 20 characters.

Reimplemented from QWidget::sizeHint()

Returns the value of the text property.

This signal is emitted when the text changes. The newText argument is the new text. Unlike the textEdited() signal, this signal is emitted when the text is changed by the user typing or when the program calls setText().

This signal is emitted when the text is edited. The newText argument is the new text.

Returns the text margins for the line edit widget.

See also

setTextMargins()

Undoes the last operation if undo is available. Deselects any current selection and updates the selection start to the current cursor position.

Returns a pointer to the current input validator or nullptr if no validator has been set.

See also

setValidator()

This property holds whether the input satisfies the inputMask and the validator. By default this property is true.

See also

setInputMask(), setValidator()

This property holds the alignment of the line edit. Both horizontal and vertical alignment is allowed here, Qt::AlignJustify will map to Qt::AlignLeft.

By default this property contains a combination of Qt::AlignLeft and Qt::AlignVCenter.

See also

Qt::Alignment

This property holds whether the line edit displays a clear button when it is not empty. If enabled the line edit displays a trailing clear button when it contains some text, otherwise the line edit does not show a clear button, which is the default.

See also

addAction(), removeAction()

This property holds the movement style of cursor in this line edit.

When this property is set to Qt::VisualMoveStyle, the line edit will use visual movement style. Pressing the left arrow key will always cause the cursor to move left, regardless of the text's writing direction. The same behavior applies to right arrow key.

When the property is Qt::LogicalMoveStyle (the default), within a LTR text block, increase cursor position when pressing left arrow key, decrease cursor position when pressing the right arrow key. If the text block is right to left, the opposite behavior applies.

This property holds the current cursor position for this line edit. Setting the cursor position causes a repaint when appropriate.

By default this property contains a value of 0.

This property holds the displayed text.

If echoMode is set to EchoMode::Normal displayText and text() will contain the same value. If EchoMode is set to EchoMode::Password or EchoMode::PasswordEchoOnEdit then displayText will contain a string of asterisks. If EchoMode is set to EchoMode::NoEcho then displayText contains an empty string.

By default this property contains an empty string.

See also

setEchoMode(), text(), EchoMode

This property holds whether the line edit starts a drag if the user presses and moves the mouse on some selected text. Dragging is disabled by default.

This property holds the echo mode for this line edit.

The echo mode determines how the text entered in the line edit is displayed (or echoed) to the user. The most common setting is EchoMode::Normal where the text entered by the user is displayed exactly as they typed it.

QLineEdit also supports modes that allow the entered text to be hidden. 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 EchoMode::Normal.

See also

EchoMode, displayText()

This property holds whether the line edit draws itself with a frame. If enabled (the default) the line edit draws itself inside a frame, otherwise the line edit draws itself without any frame.

This property holds whether there is any text selected. Returns true if some or all of the text has been selected by the user, otherwise returns false.

By default this property is false.

See also

selectedText()

This property holds the value for the input mask. The table below shows the characters which can be used to define an input mask. A space means a character is permitted but not required.

The mask can end with a semicolon followed by one character. This character will be used instead of displaying a "space". The special blank characters are always removed from the text after editing.

See also

maxLength, setValidator()

This property holds the maximum permitted length of the text.

If the text is too long, it is truncated at the limit. 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.

See also

inputMask

This property holds whether the line edit's contents has been modified by the user. The modified flag is never read by 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 has not entered any text), insert the default value.

Calling setText() resets the modified flag to false.

This property holds the line edit's placeholder text. Setting this property makes the line edit display a grayed-out placeholder text as long as the text() is empty and the widget does not have focus.

By default this property contains an empty string.

See also

text()

This property holds whether the line edit is read only. In read only mode the user can still copy the text to the clipboard or drag and drop the text (if echoMode() is set to Normal), but can not edit it. QLineEdit does not show a cursor in read only mode.

By default this property is false.

See also

setEnabled()

This property holds whether redo is available. Redo becomes available once the user has performed one or more undo operations on text in the line edit.

By default this property is false.

This property holds the selected text. If there is no selected text this property's value is an empty string. By default this property contains an empty string.

See also

hasSelectedText()

This property holds the line edit's text.

Setting this property clears the selection, clears the undo/redo history, moves the cursor to the end of the line and resets the 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.

See also

insert(), clear()

This property holds whether undo is available. Undo becomes available once the user has modified the text in the line edit. By default this property is false.