Класс 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, Справочник по проектированию пользовательского интерфейса: Поле, Ввод, и Пример полей ввода.

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

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

[slot] void QLineEdit::selectAll()

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

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

[signal] void QLineEdit::selectionChanged()

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

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

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

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

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

Примечание: Сигнал Notifier для свойства 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 равно 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

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

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

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

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

int QLineEdit::selectionEnd() const

Возвращает индекс символа непосредственно после выделенного в поле редактирования строки или -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 символов. Допускаются отрицательные значения length.

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

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

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

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

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

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

void QLineEdit::setTextMargins(const QMargins &margins)

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

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

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

void QLineEdit::setValidator(const QValidator *v)

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

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

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

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

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

QSize QLineEdit::sizeHint() const

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

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

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

QMargins QLineEdit::textMargins() const

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

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

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

const QValidator *QLineEdit::validator() const

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

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