Text fields

TextEdit

A multi-line text surface for longer-form input.

Example

Usage

Auto height from visible lines

TextEdit grows between min and max visible lines before scrolling is needed.

#include <FluentQt/TextFields.h>
using namespace fluent::textfields;

auto* textEdit = new TextEdit(this);
textEdit->setAccessibleName("Notes");
textEdit->setPlaceholderText("Type your notes here");
textEdit->setMinVisibleLines(2);
textEdit->setMaxVisibleLines(4);
textEdit->setPlainText("First line\nSecond line");

connect(textEdit, &TextEdit::textChanged,
        statusLabel, [textEdit, statusLabel] {
            statusLabel->setText(lineCountText(textEdit));
        });

import fluentqt

text_edit = fluentqt.TextEdit()
text_edit.setAccessibleName('Notes')
text_edit.setPlaceholderText('Type your notes here')
text_edit.setMinVisibleLines(2)
text_edit.setMaxVisibleLines(4)
text_edit.setPlainText('First line\nSecond line')
def line_count_text():
    count = max(1, text_edit.toPlainText().count("\n") + 1)
    return (
        f"Lines: {count}, visible range: "
        f"{text_edit.minVisibleLines()}-{text_edit.maxVisibleLines()}"
    )
text_edit.textChanged.connect(lambda: status.setText(line_count_text()))

API

Declaration

`fluent::textfields::TextEdit`

Inherits QWidget · FluentElement · QMLPlus

Fluent multi-line text input with line-count based sizing.

Constructors

explicit TextEdit(QWidget* parent = nullptr)

Properties

QMargins contentMargins: Minimum insets around the editable text; vertical values share the line slot and expand the control only when they overflow it.
Read contentMargins()Write setContentMargins()Notify contentMarginsChanged()
Typography::FontRole fontRole: Fluent typography role used for text rendering.
Read fontRole()Write setFontRole()Notify fontRoleChanged()
int focusedBorderWidth: Bottom border width while focused.
Read focusedBorderWidth()Write setFocusedBorderWidth()Notify focusedBorderWidthChanged()
int unfocusedBorderWidth: Bottom border width while not focused.
Read unfocusedBorderWidth()Write setUnfocusedBorderWidth()Notify unfocusedBorderWidthChanged()
int lineHeight: Visual line slot height used by the text editor.
Read lineHeight()Write setLineHeight()Notify layoutMetricsChanged()
int minVisibleLines: Minimum visible lines; raising it above the maximum raises both.
Read minVisibleLines()Write setMinVisibleLines()Notify layoutMetricsChanged()
int maxVisibleLines: Maximum visible lines; lowering it below the minimum lowers both.
Read maxVisibleLines()Write setMaxVisibleLines()Notify layoutMetricsChanged()
bool tabChangesFocus: Whether Tab advances focus instead of inserting a tab character.
Read tabChangesFocus()Write setTabChangesFocus()Notify tabChangesFocusChanged()
bool scrollChainingEnabled: Whether boundary wheel input may continue to an enclosing scroller.
Read isScrollChainingEnabled()Write setScrollChainingEnabled()Notify scrollChainingEnabledChanged()
bool autoResizeEnabled: Whether content controls the height; disable to fill a parent layout.
Read isAutoResizeEnabled()Write setAutoResizeEnabled()Notify autoResizeEnabledChanged()
bool frameVisible: Whether the editor paints an input frame and background.
Read isFrameVisible()Write setFrameVisible()Notify frameVisibleChanged()
QRect cursorRect: Current caret rectangle in this widget's coordinates, including scroll offsets.
Read cursorRect()Notify cursorRectChanged()

Methods

bool isAutoResizeEnabled() const: Whether content controls the height; disable to fill a parent layout.
void setAutoResizeEnabled(bool enabled): Whether content controls the height; disable to fill a parent layout.
bool isFrameVisible() const: Whether the editor paints an input frame and background.
void setFrameVisible(bool visible): Whether the editor paints an input frame and background.
QTextCursor textCursor() const: Returns the current editing cursor, including its selection.
QRect cursorRect() const: Current caret rectangle in this widget's coordinates, including scroll offsets.
void setTextCursor(const QTextCursor& cursor): Sets a cursor belonging to this editor's document.
void setPlainText(const QString& text): Text APIs.
void appendPlainText(const QString& text): Appends a plain-text paragraph, including when the editor is read-only.
QString toPlainText() const
void clear()
void setPlaceholderText(const QString& text)
QString placeholderText() const
void setReadOnly(bool readOnly)
bool isReadOnly() const
::fluent::scrolling::ScrollBar* verticalScrollBar() const
void setFocus()
void setFocus(Qt::FocusReason reason)
void onThemeUpdated() override
QMargins contentMargins() const: Minimum insets around the editable text; vertical values share the line slot and expand the control only when they overflow it.
void setContentMargins(const QMargins& margins): Minimum insets around the editable text; vertical values share the line slot and expand the control only when they overflow it.
Typography::FontRole fontRole() const: Fluent typography role used for text rendering.
void setFontRole(Typography::FontRole role): Fluent typography role used for text rendering.
int focusedBorderWidth() const: Bottom border width while focused.
void setFocusedBorderWidth(int width): Bottom border width while focused.
int unfocusedBorderWidth() const: Bottom border width while not focused.
void setUnfocusedBorderWidth(int width): Bottom border width while not focused.
int lineHeight() const: Visual line slot height used by the text editor.
void setLineHeight(int height): Visual line slot height used by the text editor.
int minVisibleLines() const: Minimum visible lines; raising it above the maximum raises both.
void setMinVisibleLines(int lines): Minimum visible lines; raising it above the maximum raises both.
int maxVisibleLines() const: Maximum visible lines; lowering it below the minimum lowers both.
void setMaxVisibleLines(int lines): Maximum visible lines; lowering it below the minimum lowers both.
bool tabChangesFocus() const: Whether Tab advances focus instead of inserting a tab character.
void setTabChangesFocus(bool enabled): Whether Tab advances focus instead of inserting a tab character.
bool isScrollChainingEnabled() const: Whether boundary wheel input may continue to an enclosing scroller.
void setScrollChainingEnabled(bool enabled): Whether boundary wheel input may continue to an enclosing scroller.

Signals

void autoResizeEnabledChanged(): Whether content controls the height; disable to fill a parent layout.
void frameVisibleChanged(): Whether the editor paints an input frame and background.
void textChanged()
void cursorPositionChanged()
void cursorRectChanged(): Emitted after the caret's effective geometry changes; updates are coalesced.
void selectionChanged()
void contentMarginsChanged(): Minimum insets around the editable text; vertical values share the line slot and expand the control only when they overflow it.
void fontRoleChanged(): Fluent typography role used for text rendering.
void focusedBorderWidthChanged(): Bottom border width while focused.
void unfocusedBorderWidthChanged(): Bottom border width while not focused.
void layoutMetricsChanged(): Visual line slot height used by the text editor.
void tabChangesFocusChanged(): Whether Tab advances focus instead of inserting a tab character.
void scrollChainingEnabledChanged(): Whether boundary wheel input may continue to an enclosing scroller.