Класс QLineEdit

Виджет QLineEdit — это однострочный редактор текста. Подробнее...

• Список всех членов, включая унаследованные

Общие типы

Свойства

Общедоступные функции

Реализованные публичные функции

Public Slots

Signals

Protected Functions

Реализованные защищенные функции

Подробное описание

Поле ввода строки позволяет пользователю вводить и редактировать одну строку простого текста с полезным набором функций редактирования, включая отмену и повторение, вырезание и вставку, а также перетаскивание (см. setDragEnabled()).

Изменяя echoMode() поля ввода строки, его также можно использовать в качестве поля «только для записи», например, для ввода паролей.

Длина текста может быть ограничена maxLength(). Текст можно произвольно ограничить с помощью validator() или inputMask(), или и того, и другого. При переключении между валидатором и маской ввода в одном поле ввода строки лучше очистить валидатор или маску ввода, чтобы избежать неопределенного поведения.

Связанный класс — QTextEdit, который позволяет редактировать текст на нескольких строках, форматированный текст.

Вы можете изменить текст с помощью setText() или insert(). Текст извлекается с помощью text(); отображаемый текст (который может отличаться, см. EchoMode) извлекается с помощью displayText(). Текст можно выделить с помощью setSelection() или selectAll(), и выделение можно вырезать, скопировать и вставить. Текст можно выровнять с помощью setAlignment().

При изменении текста генерируется сигнал textChanged; при изменении текста, кроме как с помощью вызова setText(), генерируется сигнал textEdited; при перемещении курсора генерируется сигнал cursorPositionChanged; и при нажатии клавиши Возврат или Ввод генерируется сигнал returnPressed.

Когда редактирование завершается, либо потому, что поле ввода строки потеряло фокус, либо была нажата клавиша Ввод/Возврат, генерируется сигнал editingFinished. Обратите внимание, что если фокус потерян без каких-либо изменений, сигнал editingFinished не будет сгенерирован.

Обратите внимание, что если для поля ввода строки установлен валидатор, сигналы returnPressed/editingFinished будут сгенерированы только в том случае, если валидатор вернет QValidator::Acceptable.

По умолчанию QLineEdits имеют рамку, как указано в руководствах по стилям платформ; вы можете отключить ее, вызвав setFrame(false).

Стандартные сочетания клавиш описаны ниже. Поле ввода также предоставляет контекстное меню (обычно вызываемое щелчком правой кнопкой мыши), которое предоставляет некоторые из этих параметров редактирования.

Любая другая последовательность клавиш, представляющая допустимый символ, вставит этот символ в поле редактирования строки.

См. также QTextEdit, QLabel, QComboBox, Справочник по проектированию графического интерфейса пользователя: Поля, Ввод, и Пример полей редактирования строки.

Документация по типам элементов

[since 5.2] enum QLineEdit::ActionPosition

Этот перечисление тип описывает, как поле редактирования должно отображать виджеты действий, которые нужно добавить.

Это перечисление было введено или изменено в Qt 5.2.

См. также addAction(), removeAction(), и QWidget::layoutDirection.

enum QLineEdit::EchoMode

Этот перечисление тип описывает, как поле редактирования должно отображать свои содержимое.

См. также setEchoMode() и echoMode().

Документация по членам-функциям

QLineEdit::QLineEdit(const QString &contents, QWidget *parent = nullptr)

Конструирует поле редактирования, содержащее текст contents.

Позиция курсора устанавливается в конец строки, а максимальная длина текста — в 32767 символов.

Аргумент parent передаётся конструктору QWidget.

См. также text() и setMaxLength().

QLineEdit::QLineEdit(QWidget *parent = nullptr)

Конструирует поле редактирования без текста.

Максимальная длина текста устанавливается в 32767 символов.

Аргумент parent передаётся конструктору QWidget.

См. также setText() и setMaxLength().

[slot] void QLineEdit::clear()

Очищает содержимое поля редактирования.

См. также setText() и insert().

[slot] void QLineEdit::copy() const

Копирует выделенный текст в буфер обмена, если он есть, и если echoMode() равно Normal.

См. также cut() и paste().

[signal] void QLineEdit::cursorPositionChanged(int oldPos, int newPos)

Этот сигнал подаётся всякий раз, когда перемещается курсор. Предыдущая позиция задаётся oldPos, а новая — newPos.

См. также setCursorPosition() и cursorPosition().

[slot] void QLineEdit::cut()

Копирует выделенный текст в буфер обмена и удаляет его, если он есть, и если echoMode() равно Normal.

Если текущий валидатор запрещает удаление выделенного текста, cut() скопирует текст без удаления.

См. также copy(), paste() и setValidator().

[signal] void QLineEdit::editingFinished()

Этот сигнал подаётся при нажатии клавиш Ввод или Enter или если поле редактирования теряет фокус, а его содержимое изменилось с момента последнего излучения этого сигнала.

Обратите внимание, что если установлены валидатор validator() или маска ввода inputMask() для поля редактирования, сигнал editingFinished() будет подан только в том случае, если ввод соответствует inputMask() и валидатор validator() возвращает QValidator::Acceptable.

[signal, since 5.12] void QLineEdit::inputRejected()

Этот сигнал подаётся, когда пользователь нажимает клавишу, которая не считается допустимым вводом. Например, если нажатие клавиши приводит к тому, что валидатор в методе validate() возвращает Invalid. Другой случай — попытка ввода большего количества символов, чем максимальная длина поля редактирования.

Примечание: Этот сигнал по-прежнему будет подан в случае, если часть текста принята, но не вся. Например, если установлена максимальная длина, и текст из буфера обмена длиннее максимальной длины при вставке.

Эта функция была добавлена в Qt 5.12.

[slot] void QLineEdit::paste()

Вставляет текст из буфера обмена в позицию курсора, удаляя любой выделенный текст, если поле редактирования не является только для чтения.

Если конечный результат некорректен для текущего валидатора validator(), ничего не происходит.

См. также copy() и cut().

[slot] void QLineEdit::redo()

Повторяет последнюю операцию, если повторение доступно redoAvailable.

[signal] void QLineEdit::returnPressed()

Этот сигнал подаётся при нажатии клавиш Ввод или Enter. Обратите внимание, что если установлены валидатор validator() или маска ввода inputMask() для поля редактирования, сигнал returnPressed() будет подан только в том случае, если ввод соответствует inputMask() и валидатор validator() возвращает QValidator::Acceptable.

[slot] void QLineEdit::selectAll()

Выделяет весь текст (т.е. выделяет его) и перемещает курсор в конец. Это полезно, когда был вставлен значение по умолчанию, потому что если пользователь набирает, прежде чем щелкнуть по виджету, выделенный текст будет удалён.

См. также setSelection() и deselect().

[signal] void QLineEdit::selectionChanged()

Этот сигнал подаётся всякий раз, когда изменяется выделение.

См. также hasSelectedText() и selectedText().

[signal] void QLineEdit::textChanged(const QString &text)

Этот сигнал подаётся всякий раз, когда изменяется текст. Аргумент text — новый текст.

В отличие от textEdited(), этот сигнал также подаётся, когда текст изменяется программно, например, при вызове setText().

Примечание: Сигнал-нотификатор для свойства text.

[signal] void QLineEdit::textEdited(const QString &text)

Этот сигнал подаётся всякий раз, когда текст редактируется. Аргумент text — новый текст.

В отличие от textChanged(), этот сигнал не подаётся, когда текст изменяется программно, например, при вызове setText().

[slot] void QLineEdit::undo()

Отменяет последнюю операцию, если отмена доступна. Снимает выделение, если оно есть, и обновляет начальную позицию выделения до текущей позиции курсора.

[virtual] QLineEdit::~QLineEdit()

Уничтожает поле редактирования.

[since 5.2] void QLineEdit::addAction(QAction *action, QLineEdit::ActionPosition position)

Добавляет action в список действий в позиции position.

Эта функция была добавлена в Qt 5.2.

[since 5.2] QAction *QLineEdit::addAction(const QIcon &icon, QLineEdit::ActionPosition position)

Это перегруженная функция.

Создаёт новое действие с заданным icon в позиции position.

Эта функция была добавлена в Qt 5.2.

void QLineEdit::backspace()

Если текст не выделен, удаляет символ слева от курсора и перемещает курсор на одну позицию влево. Если текст выделен, курсор перемещается в начало выделенного текста, и выделенный текст удаляется.

См. также del().

[override virtual protected] void QLineEdit::changeEvent(QEvent *ev)

Переопределяет: QWidget::changeEvent(QEvent *event).

QCompleter *QLineEdit::completer() const

Возвращает текущий QCompleter, предоставляющий предложения.

См. также setCompleter().

[override virtual protected] void QLineEdit::contextMenuEvent(QContextMenuEvent *event)

Переопределяет: QWidget::contextMenuEvent(QContextMenuEvent *event).

Отображает стандартное контекстное меню, созданное с помощью createStandardContextMenu().

Если вы не хотите, чтобы редактирование строки имело контекстное меню, вы можете установить его contextMenuPolicy на Qt::NoContextMenu. Если вы хотите настроить контекстное меню, переопределите эту функцию. Если вы хотите расширить стандартное контекстное меню, переопределите эту функцию, вызовите createStandardContextMenu() и расширьте возвращаемое меню.

void LineEdit::contextMenuEvent(QContextMenuEvent *event)
{
    QMenu *menu = createStandardContextMenu();
    menu->addAction(tr("My Menu Item"));
    //...
    menu->exec(event->globalPos());
    delete menu;
}

Параметр event используется для получения координат положения курсора мыши в момент генерации события.

См. также setContextMenuPolicy().

QMenu *QLineEdit::createStandardContextMenu()

Эта функция создаёт стандартное контекстное меню, которое отображается при щелчке правой кнопкой мыши на поле ввода. Она вызывается обработчиком по умолчанию contextMenuEvent(). Владение созданным меню передаётся вызывающему коду.

void QLineEdit::cursorBackward(bool mark, int steps = 1)

Перемещает курсор назад на steps символов. Если mark равно true, каждый пройденный символ добавляется к выделению; если mark равно false, выделение очищается.

См. также cursorForward().

void QLineEdit::cursorForward(bool mark, int steps = 1)

Перемещает курсор вперёд на steps символов. Если mark равно true, каждый пройденный символ добавляется к выделению; если mark равно false, выделение очищается.

См. также cursorBackward().

int QLineEdit::cursorPositionAt(const QPoint &pos)

Возвращает позицию курсора под точкой pos.

[protected] QRect QLineEdit::cursorRect() const

Возвращает прямоугольник, содержащий курсор поля ввода.

void QLineEdit::cursorWordBackward(bool mark)

Перемещает курсор на одно слово назад. Если mark равно true, слово также выделяется.

См. также cursorWordForward().

void QLineEdit::cursorWordForward(bool mark)

Перемещает курсор на одно слово вперёд. Если mark равно true, слово также выделяется.

См. также cursorWordBackward().

void QLineEdit::del()

Если текст не выделен, удаляет символ справа от курсора. Если текст выделен, курсор перемещается к началу выделенного текста и выделенный текст удаляется.

См. также backspace().

void QLineEdit::deselect()

Отменяет выделение текста.

См. также setSelection() и selectAll().

[override virtual protected] void QLineEdit::dragEnterEvent(QDragEnterEvent *e)

Переопределяет: QWidget::dragEnterEvent(QDragEnterEvent *event).

[override virtual protected] void QLineEdit::dragLeaveEvent(QDragLeaveEvent *e)

Переопределяет: QWidget::dragLeaveEvent(QDragLeaveEvent *event).

[override virtual protected] void QLineEdit::dragMoveEvent(QDragMoveEvent *e)

Переопределяет: QWidget::dragMoveEvent(QDragMoveEvent *event).

[override virtual protected] void QLineEdit::dropEvent(QDropEvent *e)

Переопределяет: QWidget::dropEvent(QDropEvent *event).

void QLineEdit::end(bool mark)

Перемещает курсор в конец строки, если он там ещё не находится. Если mark равно true, текст выделяется до последней позиции; иначе, любое выделение отменяется, если курсор перемещается.

См. также home().

[override virtual] bool QLineEdit::event(QEvent *e)

Переопределяет: QWidget::event(QEvent *event).

[override virtual protected] void QLineEdit::focusInEvent(QFocusEvent *e)

Переопределяет: QWidget::focusInEvent(QFocusEvent *event).

[override virtual protected] void QLineEdit::focusOutEvent(QFocusEvent *e)

Переопределяет: QWidget::focusOutEvent(QFocusEvent *event).

void QLineEdit::home(bool mark)

Перемещает курсор в начало строки, если он там ещё не находится. Если mark равно true, текст выделяется до первой позиции; иначе, любое выделение отменяется, если курсор перемещается.

См. также end().

[virtual protected] void QLineEdit::initStyleOption(QStyleOptionFrame *option) const

Инициализирует option значениями из этого QLineEdit. Этот метод полезен для подклассов, когда им нужен QStyleOptionFrame, но они не хотят заполнять всю информацию самостоятельно.

См. также QStyleOption::initFrom().

[override virtual protected] void QLineEdit::inputMethodEvent(QInputMethodEvent *e)

Переопределяет: QWidget::inputMethodEvent(QInputMethodEvent *event).

[override virtual] QVariant QLineEdit::inputMethodQuery(Qt::InputMethodQuery property) const

Переопределяет: QWidget::inputMethodQuery(Qt::InputMethodQuery query) const.

void QLineEdit::insert(const QString &newText)

Удаляет выделенный текст, вставляет newText и проверяет результат. Если он корректный, устанавливает его в качестве нового содержимого поля ввода.

См. также setText() и clear().

[override virtual protected] void QLineEdit::keyPressEvent(QKeyEvent *event)

Переопределяет: QWidget::keyPressEvent(QKeyEvent *event).

Преобразует нажатие клавиши event в действие поля ввода.

Если нажата клавиша Ввод или Enter и текущий текст корректен (или может быть сделан корректным валидатором), генерируется сигнал returnPressed().

Стандартные сочетания клавиш перечислены в подробном описании класса.

[override virtual protected] void QLineEdit::keyReleaseEvent(QKeyEvent *)

Переопределяет: QWidget::keyReleaseEvent(QKeyEvent *event).

[override virtual] QSize QLineEdit::minimumSizeHint() const

Переопределяет функцию доступа к свойству: QWidget::minimumSizeHint.

Возвращает минимальный размер для поля ввода.

Возвращаемая ширина обычно достаточно для отображения хотя бы одного символа.

[override virtual protected] void QLineEdit::mouseDoubleClickEvent(QMouseEvent *e)

Переопределяет: QWidget::mouseDoubleClickEvent(QMouseEvent *event).

[override virtual protected] void QLineEdit::mouseMoveEvent(QMouseEvent *e)

Переопределяет: QWidget::mouseMoveEvent(QMouseEvent *event).

[override virtual protected] void QLineEdit::mousePressEvent(QMouseEvent *e)

Переопределяет: QWidget::mousePressEvent(QMouseEvent *event).

[override virtual protected] void QLineEdit::mouseReleaseEvent(QMouseEvent *e)

Переопределяет: QWidget::mouseReleaseEvent(QMouseEvent *event).

[override virtual protected] void QLineEdit::paintEvent(QPaintEvent *)

Переопределяет: QWidget::paintEvent(QPaintEvent *event).

[since 5.10] int QLineEdit::selectionEnd() const

Возвращает индекс символа, непосредственно следующего за выделенным фрагментом в поле редактирования, или -1, если текст не выделен.

Эта функция была добавлена в Qt 5.10.

См. также selectedText(), selectionStart(), и selectionLength().

[since 5.10] int QLineEdit::selectionLength() const

Возвращает длину выделенного фрагмента.

Эта функция была добавлена в Qt 5.10.

См. также selectedText(), selectionStart(), и selectionEnd().

int QLineEdit::selectionStart() const

Возвращает индекс первого символа выделенного фрагмента в поле редактирования или -1, если текст не выделен.

См. также selectedText(), selectionEnd(), и selectionLength().

void QLineEdit::setCompleter(QCompleter *c)

Устанавливает это поле редактирования для автозаполнения из списка предложений c. Режим автозаполнения устанавливается с помощью QCompleter::setCompletionMode().

Чтобы использовать QCompleter с QValidator или QLineEdit::inputMask, необходимо убедиться, что модель, предоставленная QCompleter, содержит допустимые записи. Можно использовать QSortFilterProxyModel для обеспечения того, чтобы модель QCompleter содержала только допустимые записи.

Если c == 0, setCompleter() удаляет текущий QCompleter, эффективно отключая автозаполнение.

См. также completer() и QCompleter.

void QLineEdit::setSelection(int start, int length)

Выделяет текст с позиции start и длиной length символов. Разрешаются отрицательные значения length.

См. также deselect(), selectAll(), и selectedText().

void QLineEdit::setTextMargins(int left, int top, int right, int bottom)

Устанавливает отступы вокруг текста внутри рамки размером left, top, right и bottom.

См. также textMargins().

См. также textMargins().

void QLineEdit::setTextMargins(const QMargins &margins)

Устанавливает отступы margins вокруг текста внутри рамки.

См. также textMargins().

void QLineEdit::setValidator(const QValidator *v)

Устанавливает валидатор для значений поля редактирования в v.

Сигналы returnPressed() и editingFinished() поля редактирования будут выпущены только в том случае, если v валидирует содержимое поля редактирования как Acceptable. Пользователь может изменять содержимое на любое значение Intermediate во время редактирования, но будет предотвращено изменение текста на значение, которое v валидирует как Invalid.

Это позволяет ограничить текст, который в конечном итоге будет введён при завершении редактирования, сохраняя при этом достаточную свободу действий для пользователей по изменению текста от одного допустимого состояния к другому.

Если v == 0, setValidator() удаляет текущий валидатор ввода. Начальное значение - отсутствие валидатора (то есть любой ввод принимается до maxLength()).

См. также validator(), hasAcceptableInput(), QIntValidator, QDoubleValidator и QRegularExpressionValidator.

[override virtual] QSize QLineEdit::sizeHint() const

Переопределяет функцию доступа к свойству: QWidget::sizeHint.

Возвращает рекомендуемый размер виджета.

Возвращаемая ширина в пикселях обычно достаточна примерно для 15-20 символов.

QMargins QLineEdit::textMargins() const

Возвращает отступы текста виджета.

См. также setTextMargins().

[override virtual] void QLineEdit::timerEvent(QTimerEvent *e)

Переопределяет: QObject::timerEvent(QTimerEvent *event).

const QValidator *QLineEdit::validator() const

Возвращает указатель на текущий валидатор ввода или nullptr если валидатор не установлен.

См. также setValidator().