Text fields

LineEdit

A single-line text box with Fluent styling and a clear button.

Example

Usage

Units and inline actions

Keep the value easy to read, with its context close at hand.

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

auto* width = new LineEdit(this);
width->setAccessibleName("Canvas width");
width->setText("1280");
width->setTrailingText("px");
width->setClearButtonAccessibleName("Clear canvas width");
width->setClearButtonFocusPolicy(Qt::StrongFocus);

auto* name = new LineEdit(this);
name->setAccessibleName("Export name");
name->setText("gallery-preview-v2");
name->setClearButtonEnabled(false);
auto* reset = new Button("Reset");
reset->setFluentStyle(Button::Subtle);
reset->setFluentSize(Button::Small);
reset->setFontRole(Typography::FontRole::Caption);
auto actionFont = reset->font();
actionFont.setStyleName(QString());
actionFont.setWeight(QFont::DemiBold);
reset->setFont(actionFont);
reset->setTextColorRole(Button::TextColorRole::Accent);
reset->setFixedSize(Spacing::XXLarge, Spacing::ControlHeight::Small);
reset->setFocusVisual(true);
reset->setAccessibleName("Reset export name");
name->setTrailingWidget(reset, WidgetOwnership::Owned);
connect(reset, &Button::clicked, name, [name] {
    name->setText("gallery-preview");
});

import fluentqt

from PySide6.QtCore import Qt
from PySide6.QtGui import QFont

width_column = root.add_column()
name_column = root.add_column()
width = fluentqt.LineEdit(width_column)
width.setAccessibleName('Canvas width')
width.setText('1280')
width.setTrailingText('px')
width.setClearButtonAccessibleName('Clear canvas width')
width.setClearButtonFocusPolicy(Qt.StrongFocus)
name = fluentqt.LineEdit(name_column)
name.setAccessibleName('Export name')
name.setText('gallery-preview-v2')
name.setClearButtonEnabled(False)
reset = fluentqt.Button('Reset')
reset.setFluentStyle(fluentqt.Button.ButtonStyle.Subtle)
reset.setFluentSize(fluentqt.Button.ButtonSize.Small)
reset.setFontRole(fluentqt.FontRole.Caption)
action_font = reset.font()
action_font.setStyleName('')
action_font.setWeight(QFont.DemiBold)
reset.setFont(action_font)
reset.setTextColorRole(fluentqt.Button.TextColorRole.Accent)
reset.setFixedSize(fluentqt.Spacing.XXLarge, fluentqt.Spacing.ControlHeight.Small)
reset.setFocusVisual(True)
reset.setAccessibleName('Reset export name')
name.setTrailingWidget(reset, fluentqt.WidgetOwnership.Owned)
reset.clicked.connect(lambda: name.setText('gallery-preview'))

API

Declaration

`fluent::textfields::LineEdit`

Inherits QLineEdit · FluentElement · QMLPlus

Fluent single-line text input with clear button and focus underline.

Constructors

explicit LineEdit(QWidget* parent = nullptr)

Properties

QMargins contentMargins: Content margins whose horizontal values include Qt's internal text inset.
Read contentMargins()Write setContentMargins()Notify contentMarginsChanged()
Typography::FontRole fontRole: Fluent typography role used for text rendering.
Read fontRole()Write setFontRole()Notify fontRoleChanged()
bool clearButtonEnabled: Whether the trailing clear button is enabled.
Read isClearButtonEnabled()Write setClearButtonEnabled()Notify clearButtonEnabledChanged()
int clearButtonSize: Size of the clear button, defaulting to 24 logical pixels.
Read clearButtonSize()Write setClearButtonSize()Notify clearButtonSizeChanged()
QPoint clearButtonOffset: Pixel offset applied to the clear button.
Read clearButtonOffset()Write setClearButtonOffset()Notify clearButtonOffsetChanged()
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()
bool frameVisible: Whether LineEdit paints its input frame and focus underline.
Read isFrameVisible()Write setFrameVisible()Notify frameVisibleChanged()
QString trailingText: Read trailingText()Write setTrailingText()Notify trailingTextChanged()
QWidget* trailingWidget: Read trailingWidget()Notify trailingWidgetChanged()
fluent::WidgetOwnership trailingWidgetOwnership: Read trailingWidgetOwnership()Notify trailingWidgetOwnershipChanged()
QString clearButtonAccessibleName: Read clearButtonAccessibleName()Write setClearButtonAccessibleName()Notify clearButtonAccessibleNameChanged()
Qt::FocusPolicy clearButtonFocusPolicy: Read clearButtonFocusPolicy()Write setClearButtonFocusPolicy()Notify clearButtonFocusPolicyChanged()

Subclass interfaces

Methods

bool event(QEvent* event) override
void changeEvent(QEvent* event) override
void paintEvent(QPaintEvent* event) override
void resizeEvent(QResizeEvent* event) override
void contextMenuEvent(QContextMenuEvent* event) override
void enterEvent(FluentEnterEvent* event) override
void leaveEvent(QEvent* event) override
void focusInEvent(QFocusEvent* event) override
void focusOutEvent(QFocusEvent* event) override
virtual void paintFrame(QPainter& painter): Paints the input surface when frameVisible is enabled.
virtual QRect trailingContentBounds() const
virtual void trailingContentGeometryChanged()
int trailingContentWidth() const
QSize trailingContentSizeHint() const
void updateTrailingContentGeometry()
virtual ::fluent::basicinput::Button* clearActionButton() const

Inherited from fluent::FluentElement

Methods

static void setTheme(Theme theme): Updates the global theme and notifies active FluentElement instances.
static void setThemeDeferred(Theme theme): Schedules a visible-first batched theme refresh without blocking the current interaction.
static Theme currentTheme(): Returns the currently active global theme.
static bool themeUsesDarkAppearance(Theme theme): Returns whether a theme uses dark-backed chrome and material tokens.
static void refreshTheme(): Re-broadcasts the current theme to repaint after a design-token change.
static int themeGeneration(): Monotonic counter bumped on every theme change, for staleness checks.
Theme effectiveTheme() const: Resolves the theme used by this element, honoring an inherited QWidget override.
bool effectiveThemeUsesDarkAppearance() const: Returns whether this element's effective theme uses dark-backed chrome.
bool setThemeOverrides(const QJsonObject& overrides): Component-facing token accessors.
QJsonObject themeOverrides() const: Returns this element's authored overrides.
void clearThemeOverrides(): Restores all token fields to global theme defaults.
Colors themeColors() const
const Colors& themeColorsRef() const: Non-copying access to the active color set (for hot paint paths).
FontStyle themeFont(Typography::FontRole role = Typography::FontRole::Body) const
Radius themeRadius() const
Spacing themeSpacing() const
Animation themeAnimation() const
Material::AcrylicToken themeAcrylic() const: Material, elevation, and adaptive layout tokens.
Material::MicaToken themeMica() const
Material::SmokeToken themeSmoke() const
Elevation::ShadowParams themeShadow(Elevation::Level level) const
int themeBreakpoint(Breakpoints::Breakpoint breakpoint = Breakpoints::Breakpoint::Medium) const
QColor themeBackdrop(bool active) const: Window-chrome backdrop color for the given activation state.
virtual void onThemeUpdated(): Called after the global theme changes.

Enumerations

enum Theme: Global visual theme used when resolving design tokens.
Light = 0
Dark = 1
HighContrast = 2

Types and aliases

struct Colors: Design token snapshots returned to components.
struct FontStyle
struct Radius
struct Spacing
struct Animation

Inherited from fluent::QMLPlus

Methods

AnchorLayout::Anchors* anchors(): Returns mutable anchors for the QWidget host.
void setState(const QString& name): Applies a named state, or clears state when name is empty.
QString state() const
void addState(const QMLState& state): Registers or replaces a named state definition.
void evaluateStates(): Reevaluates conditions; the first registered true condition wins.
QMLPlusRuntime* runtime(): Returns the lazy host-owned state observation object.
void setAnchors(const AnchorLayout::Anchors& anchors): Replaces all host anchors and invalidates the parent layout.
void resetAnchors(): Clears all host anchors and invalidates the parent layout.
void bind(const char* targetProp, QObject* source, const char* sourceProp, PropertyBinder::Direction dir = PropertyBinder::OneWay): Binds a source property to a property on the QWidget host.
BindingHandle bindManaged(const char* targetProp, QObject* source, const char* sourceProp, PropertyBinder::Direction direction = PropertyBinder::OneWay, BindingOptions options = {}): Installs a managed direct binding on this QWidget host.
BindingHandle bindComputed(const char* targetProp, const QVector<BindingDependency>& dependencies, std::function<QVariant()> evaluate, BindingOptions options = {}): Installs an explicit-dependency C++ expression on this QWidget host.
void addTransition(const StateTransition& transition): Registers a state transition in precedence order.
void setBehavior(const char* propertyName, const PropertyAnimation& animation): Sets the default animation for this host's managed property writes.
void clearBehavior(const char* propertyName): Removes the default animation for future managed writes.
bool writeProperty(const char* propertyName, const QVariant& value): Writes a host property through Behavior without removing its binding.

All inherited Qt members：QLineEdit

Example

Usage

Units and inline actions

API

fluent::textfields::LineEdit

Constructors

Properties

Methods

Signals

Destructors

Methods

Methods

Enumerations

Types and aliases

Methods

`fluent::textfields::LineEdit`