Класс QLineEdit

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

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

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

Свойства

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

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

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

• 214 общедоступных функций, унаследованных от QWidget
• 32 общедоступных функций, унаследованных от 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(), и выделение можно вырезать cut(), скопировать copy() и вставить paste(). Выравнивание текста можно изменить с помощью setAlignment().

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

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

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

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

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

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

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

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

enum QLineEdit::ActionPosition

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

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

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

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

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

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

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