Класс QLineEdit

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

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

Открытые типы

Свойства

• 59 свойств, унаследованных от QWidget
• 1 свойство, унаследованное от QObject

Открытые функции

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

• 214 общедоступных функций, унаследованных от QWidget
• 31 общедоступных функций, унаследованных от QObject
• 14 общедоступных функций, унаследованных от QPaintDevice

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

• 19 общедоступных слотов, унаследованных от QWidget
• 1 общедоступный слот, унаследованный от QObject

Сигналы

• 3 сигнала, унаследованные от QWidget
• 2 сигнала, унаследованные от QObject

Статические общедоступные члены

• 5 статических общедоступных членов, унаследованных от QWidget
• 9 статических общедоступных членов, унаследованных от QObject

Защищенные функции

Переопределённые защищенные функции

• 35 защищенных функций, унаследованных от QWidget
• 9 защищенных функций, унаследованных от QObject
• 1 защищенная функция, унаследованная от QPaintDevice

Дополнительные унаследованные члены

• 1 защищенный слот, унаследованный от QWidget

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

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

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

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

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

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

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

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

При завершении редактирования, либо из-за потери фокуса полем ввода, либо при нажатии Return/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(QWidget *parent = nullptr)

Создаёт редактор строки без текста.

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

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

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

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

Создаёт редактор строки, содержащий текст contents.

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

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

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

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

[slot] void QLineEdit::clear()

Очищает содержимое редактора строки.

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

QCompleter *QLineEdit::completer() const

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

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

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

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

Переопределено из QWidget::contextMenuEvent().

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

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

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

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

[slot] void QLineEdit::copy() const

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

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

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.

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

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

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

[protected] QRect QLineEdit::cursorRect() const

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

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

void QLineEdit::cursorWordBackward(bool mark)

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

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

void QLineEdit::cursorWordForward(bool mark)

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

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

[slot] void QLineEdit::cut()

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

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

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

void QLineEdit::del()

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

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

void QLineEdit::deselect()

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

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

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

Переопределено из QWidget::dragEnterEvent().

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

Переопределено из QWidget::dragLeaveEvent().

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

Переопределено из QWidget::dragMoveEvent().

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

Переопределено из QWidget::dropEvent().

[signal] void QLineEdit::editingFinished()

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

void QLineEdit::end(bool mark)

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

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

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

Переопределено из QWidget::event().

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

Переопределено из QWidget::focusInEvent().

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

Переопределено из QWidget::focusOutEvent().

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

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

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

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

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

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

Переопределено из QWidget::inputMethodEvent().

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

Переопределено из QWidget::inputMethodQuery().

[signal] void QLineEdit::inputRejected()

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

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

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

void QLineEdit::insert(const QString &newText)

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

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

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

Переопределено из QWidget::keyPressEvent().

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

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

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

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

Переопределено из QWidget::minimumSizeHint().

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

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

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

Переопределено из QWidget::mouseDoubleClickEvent().

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

Переопределено из QWidget::mouseMoveEvent().

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

Переопределено из QWidget::mousePressEvent().

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

Переопределено из QWidget::mouseReleaseEvent().

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

Переопределено из QWidget::paintEvent().

[slot] void QLineEdit::paste()

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

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

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

[slot] void QLineEdit::redo()

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

[signal] void QLineEdit::returnPressed()

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

[slot] void QLineEdit::selectAll()

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

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

[signal] void QLineEdit::selectionChanged()

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

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

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

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

Устанавливает отступы 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().

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

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

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

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

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

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

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

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

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

QMargins QLineEdit::textMargins() const

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

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

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

[slot] void QLineEdit::undo()

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

const QValidator *QLineEdit::validator() const

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

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