Text fields

CodeBlock

Read-only code with syntax colors, exact copying, folding and bounded scrolling.

Example

Usage

Read and copy code

Select a passage to copy, or use the header to copy everything and fold the block.

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

auto* code = new CodeBlock(this);
code->setLanguage("cpp");
code->setCode("// A small FluentQt window\n"
              "auto* button = new Button(\"Continue\");\n"
              "button->setFluentStyle(Button::Accent);");

import fluentqt

code = fluentqt.CodeBlock()
code.setObjectName("sampleCodeBlock")
code.setLanguage("cpp")
code.setCode(
    '// A small FluentQt window\n'
    'auto* button = new Button("Continue");\n'
    'button->setFluentStyle(Button::Accent);'
)

API

Declaration

`fluent::textfields::CodeBlock`

Inherits layout::Expander

namespace detail

Constructors

explicit CodeBlock(QWidget* parent = nullptr)
explicit CodeBlock(const QString& code, QWidget* parent = nullptr)

Properties

QString code: Read code()Write setCode()Notify codeChanged()
QString language: Read language()Write setLanguage()Notify languageChanged()
bool wordWrap: Read isWordWrapEnabled()Write setWordWrap()Notify wordWrapChanged()
int maxVisibleLines: Maximum visible rows; zero fits all content. Default: 16.
Read maxVisibleLines()Write setMaxVisibleLines()Notify maxVisibleLinesChanged()

Methods

QString code() const
void setCode(const QString& code)
QString language() const
void setLanguage(const QString& language)
bool isWordWrapEnabled() const
void setWordWrap(bool enabled)
int maxVisibleLines() const: Maximum visible rows; zero fits all content. Default: 16.
void setMaxVisibleLines(int lines): Maximum visible rows; zero fits all content. Default: 16.
void onThemeUpdated() override
void copy(): Copies the exact source and reports host clipboard completion.

Signals

void codeChanged(const QString& code)
void languageChanged(const QString& language)
void wordWrapChanged(bool enabled)
void maxVisibleLinesChanged(int lines): Maximum visible rows; zero fits all content. Default: 16.
void copyFinished(bool success)

Inherited from fluent::layout::Expander

Properties

QString headerText: Read headerText()Write setHeaderText()Notify headerTextChanged()
QWidget* contentWidget: Read contentWidget()Write setContentWidget()Notify contentWidgetChanged()
bool expanded: Read isExpanded()Write setExpanded()Notify expandedChanged()
bool animationEnabled: Read isAnimationEnabled()Write setAnimationEnabled()Notify animationEnabledChanged()

Methods

QString headerText() const
void setHeaderText(const QString& text)
QWidget* contentWidget() const
void setContentWidget(QWidget* widget)
bool setContentWidget(QWidget* widget, WidgetOwnership ownership)
QWidget* takeContentWidget()
WidgetOwnership contentOwnership() const
bool isExpanded() const
void setExpanded(bool expanded)
void setExpandedAnimated(bool expanded, bool animated)
void toggleExpanded()
bool isAnimationEnabled() const
void setAnimationEnabled(bool enabled)
basicinput::Button* headerButton() const
QSize sizeHint() const override
QSize minimumSizeHint() const override
void onThemeUpdated() override

Signals

void headerTextChanged(const QString& text)
void contentWidgetChanged(QWidget* widget)
void contentOwnershipChanged(WidgetOwnership ownership)
void expandedChanged(bool expanded)
void animationEnabledChanged(bool enabled)
void expansionTransitionStarted(bool expanding)
void expansionTransitionFinished(bool expanded)
void layoutHeightChanged(int height)

Inherited from fluent::layout::Card

Properties

Appearance appearance: Read appearance()Write setAppearance()Notify appearanceChanged()
bool borderVisible: Read isBorderVisible()Write setBorderVisible()Notify borderVisibleChanged()

Methods

Appearance appearance() const
void setAppearance(Appearance appearance)
bool isBorderVisible() const
void setBorderVisible(bool visible)
void onThemeUpdated() override

Signals

void appearanceChanged(Appearance appearance)
void borderVisibleChanged(bool visible)

Enumerations

enum Appearance: Token surface used to fill the card.
Layer
LayerAlt
Canvas

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：QFrame