Класс QLineEdit

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

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

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

Свойства

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

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

Public Slots

Signals

Protected Functions

Reimplemented Protected Functions

Detailed Description

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

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

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

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

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

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

При завершении редактирования, либо из-за потери фокуса полем ввода, либо при нажатии клавиш ВВОД/ENTER, генерируется сигнал editingFinished.

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

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

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

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

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

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

[since 5.2] перечисление QLineEdit::ActionPosition

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

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

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

перечисление 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, или если поле ввода теряет фокус, а его содержимое изменилось с момента последнего испускания этого сигнала.

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

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

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

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

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

[slot] void QLineEdit::paste()

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

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

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

[slot] void QLineEdit::redo()

Повторяет последнее действие, если повторение доступно.

[signal] void QLineEdit::returnPressed()

Этот сигнал испускается при нажатии клавиши Ввод или Enter. Обратите внимание, что если для поля ввода задан валидатор или маска ввода, сигнал returnPressed() будет испущен только в том случае, если ввод соответствует маске ввода и валидатор возвращает 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 или Return, если текущий текст корректен (или может быть сделан корректным с помощью валидатора), сигнал 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() удаляет текущий completer, фактически отключая автозаполнение.

См. также 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().