Класс QLineEdit

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

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

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

Свойства

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

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

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

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

Публичные слоты

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

Сигналы

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

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

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

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

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

• 5 статических общедоступных членов, унаследованных от QWidget
• 11 статических общедоступных членов, унаследованных от QObject
• 1 защищённый слот, унаследованный от QWidget

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

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

Поле ввода позволяет пользователю вводить и редактировать одну строку простого текста с полезным набором функций редактирования, включая отмену и повторение, вырезку и вставку, а также перетаскивание (см. 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).

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

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

	Строка редактирования, отображаемая в стиле виджета Macintosh.
	Строка редактирования, отображаемая в стиле виджета Windows Vista.
	Строка редактирования, отображаемая в стиле виджета Fusion.

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

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

перечисление QLineEdit::ActionPosition

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

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

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

перечисление QLineEdit::EchoMode

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

См. также setEchoMode() и echoMode().

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

QLineEdit::QLineEdit(QWidget *parent = Q_NULLPTR)

Создаёт поле редактирования без текста.

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

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

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

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

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

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

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

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

QLineEdit::~QLineEdit()

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

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

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

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

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

QAction *QLineEdit::addAction(const QIcon &icon, ActionPosition position)

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

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

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

void QLineEdit::backspace()

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

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

[virtual protected] void QLineEdit::changeEvent(QEvent *ev)

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

[slot] void QLineEdit::clear()

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

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

QCompleter *QLineEdit::completer() const

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

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

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

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

Переопределено из 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;
}

Параметр 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 old, int new)

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

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

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

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

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

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

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

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

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

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

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

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

Реализовано повторно из QWidget::focusInEvent().

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

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

Реализовано повторно из QWidget::inputMethodEvent().

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

Реализовано повторно из QWidget::inputMethodQuery().

void QLineEdit::insert(const QString &newText)

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

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

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

Реализовано повторно из QWidget::keyPressEvent().

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

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

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

[virtual] QSize QLineEdit::minimumSizeHint() const

Реализовано повторно из QWidget::minimumSizeHint().

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

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

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

Реализовано повторно из QWidget::mouseDoubleClickEvent().

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

Реализовано повторно из QWidget::mouseMoveEvent().

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

Реализовано повторно из QWidget::mousePressEvent().

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

Реализовано повторно из QWidget::mouseReleaseEvent().

[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::selectionStart() const

selectionStart() возвращает индекс первого выделенного символа в поле редактирования или -1, если текст не выделен.

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

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.

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