Класс 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(), и выделение можно вырезать (cut()), скопировать (copy()), и вставить (paste()). Выравнивание текста можно изменить с помощью setAlignment().

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

Когда завершается редактирование (из-за потери фокуса или нажатия клавиши ВВОД/Enter), генерируется сигнал editingFinished.

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

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

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

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

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

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

перечисление 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, или поле ввода теряет фокус. Обратите внимание, что если для поля ввода установлен валидатор (validator()) или маска ввода (inputMask()), сигнал editingFinished() будет испущен только в том случае, если ввод соответствует маске (inputMask()) и валидатор (validator()) возвращает QValidator::Acceptable.

[signal] void QLineEdit::inputRejected()

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

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

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

[slot] void QLineEdit::paste()

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

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

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

[slot] void QLineEdit::redo()

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

[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()

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

[virtual] QLineEdit::~QLineEdit()

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

void QLineEdit::addAction(QAction *action, QLineEdit::ActionPosition position)

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

Эта функция была добавлена в Qt 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, предоставляющий автодополнение.

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

См. также 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 истинно, каждый пройденный символ добавляется к выделению; если mark ложно, выделение очищается.

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

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

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

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

int QLineEdit::cursorPositionAt(const QPoint &pos)

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

[protected] QRect QLineEdit::cursorRect() const

Возвращает прямоугольник, включающий курсор line edit.

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

void QLineEdit::cursorWordBackward(bool mark)

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

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

void QLineEdit::cursorWordForward(bool mark)

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

См. также 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 истинно, текст выделяется до последней позиции; в противном случае, любой выделенный текст снимается, если курсор перемещается.

См. также 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::getTextMargins(int *left, int *top, int *right, int *bottom) const

Возвращает отступы текста виджета для left, top, right и bottom.

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

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

void QLineEdit::home(bool mark)

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

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

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

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

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

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

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

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

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

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

Переопределяет: QWidget::minimumSizeHint() const.

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

Возвращаемая ширина достаточна для как минимум одного символа.

[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).

int QLineEdit::selectionEnd() const

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

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

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

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() удаляет текущий дополнитель, фактически отключая автозаполнение.

Данная функция была добавлена в Qt 4.2.

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

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

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

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

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

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

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

Данная функция была добавлена в Qt 4.5.

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

void QLineEdit::setTextMargins(const QMargins &margins)

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

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

Данная функция была добавлена в Qt 4.6.

void QLineEdit::setValidator(const QValidator *v)

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

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

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

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

Переопределяет: QWidget::sizeHint() const.

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

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

QMargins QLineEdit::textMargins() const

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

Данная функция была добавлена в Qt 4.6.

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

const QValidator *QLineEdit::validator() const

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

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