Класс QLineEdit

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

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

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

Свойства

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

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

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

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

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

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

Сигналы

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

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

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

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

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

• 1 общедоступная переменная унаследована от QObject
• 5 статические общедоступные члены унаследованы от QWidget
• 10 статических общедоступных членов унаследованы от QObject
• 1 защищённый слот унаследован от QWidget
• 2 защищённые переменные унаследованы от QObject
• 1 защищённый тип унаследован от QPaintDevice

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

Виджет QLineEdit — это редактор текста в одну строку.

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

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

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

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

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

При изменении текста генерируется сигнал textChanged; при изменении текста, кроме вызова setText(), генерируется сигнал textEdited; при перемещении курсора генерируется сигнал cursorPositionChanged; при нажатии клавиши Ввод или Enter генерируется сигнал 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(QWidget *parent = nullptr)

Создаёт поле ввода без текста.

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

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

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

QLineEdit::QLineEdit(const QString &содержимое, QWidget *parent = nullptr)

Создаёт поле ввода, содержащее текст содержимое.

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

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

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

[virtual] QLineEdit::~QLineEdit()

Удаляет поле ввода.

void QLineEdit::addAction(QAction *действие, QLineEdit::ActionPosition позиция)

Это перегруженный метод.

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

Этот метод был добавлен в Qt 5.2.

QAction *QLineEdit::addAction(const QIcon &иконка, QLineEdit::ActionPosition позиция)

Это перегруженный метод.

Создаёт новое действие с заданной иконкой по позиции.

Этот метод был добавлен в Qt 5.2.

void QLineEdit::backspace()

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

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

[override virtual protected] void QLineEdit::changeEvent(QEvent *событие)

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

[slot] void QLineEdit::clear()

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

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

QCompleter *QLineEdit::completer() const

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

Этот метод был добавлен в Qt 4.2.

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

[override virtual protected] void QLineEdit::contextMenuEvent(QContextMenuEvent *событие)

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

Отображает стандартное контекстное меню, созданное с помощью 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;
}

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

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

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

void QLineEdit::insert(const QString &newText)

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

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

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

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

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

Если нажаты Return или 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()

Этот сигнал испускается при нажатии клавиш Return или 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().