Struct TxtBuilder 

pub struct TxtBuilder { /* private fields */ }

Builder for a Txt node: set the initial values, then pass it to add.

Implementations

impl TxtBuilder

pub fn text(self, v: impl Into<String>) -> Self

The text to show.

pub fn rich(self, spans: impl IntoIterator<Item = RichSpan>) -> Self

Styled runs instead of plain text: [span("Hello "), span("world").bold()].

pub fn font_size(self, v: f64) -> Self

Font size in pixels. Default: 48.

pub fn weight(self, v: f64) -> Self

100..=900.

pub fn family(self, v: impl Into<String>) -> Self

SANS, MONO or a family registered with oxframe_text::register_font.

pub fn italic(self, v: bool) -> Self

Italic style.

pub fn line_height(self, v: f64) -> Self

Multiple of the font size.

pub fn letter_spacing(self, v: f64) -> Self

Extra space between letters, in pixels.

pub fn align(self, v: TextAlign) -> Self

Alignment of lines within the text block.

pub fn max_width(self, v: f64) -> Self

Wrap width.

pub fn display(self) -> Self

Largest title from the theme.

pub fn h1(self) -> Self

Page title from the theme.

pub fn h2(self) -> Self

Section title from the theme.

pub fn body(self) -> Self

Running text from the theme.

pub fn caption(self) -> Self

Secondary text from the theme.

pub fn code(self) -> Self

Monospace text from the theme.

Trait Implementations

impl Debug for TxtBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TxtBuilder

fn default() -> Self

Returns the “default value” for a type.

impl NodeBuilder for TxtBuilder

type Handle = Txt

Handle returned by Node::add.

fn name(self, v: impl Into<String>) -> Self

Name shown in the editor and in oxframe check / oxframe inspect. Without it, the node is labeled by the add call site (src/main.rs:42).

fn x(self, v: f64) -> Self

Horizontal position; 0 is the parent’s center, positive is right.

fn y(self, v: f64) -> Self

Vertical position; 0 is the parent’s center, positive is down.

fn position(self, v: impl Into<Vec2>) -> Self

Sets x and y together, e.g. .position((100.0, -50.0)).

fn rotation(self, v: f64) -> Self

Degrees, clockwise.

fn scale(self, v: f64) -> Self

Uniform scale; 1 is the natural size.

fn scale_xy(self, v: impl Into<Vec2>) -> Self

Separate horizontal and vertical scale.

fn opacity(self, v: f64) -> Self

Opacity of the node and its children, 0 (invisible) to 1.

fn fill(self, v: impl IntoPaint) -> Self

Fill color: a Color or a theme role such as Accent. Default: transparent, except text, which uses the theme’s text color.

fn stroke(self, v: impl IntoPaint) -> Self

Outline color; also set line_width. A theme role works the same as a color. Default: transparent.

fn line_width(self, v: f64) -> Self

Outline width in pixels. Default: 0 (no outline).

fn start(self, v: f64) -> Self

Start of the drawn part of the outline, fraction of its length.

fn end(self, v: f64) -> Self

End of the drawn part of the outline; animate 0 → 1 to draw it on.

fn fill_gradient(self, g: Gradient) -> Self

Gradient fill (local coordinates, origin at the node center); overrides fill.

fn stroke_gradient(self, g: Gradient) -> Self

Gradient outline; overrides stroke.

fn dash(self, pattern: impl Into<Vec<f64>>) -> Self

Dash pattern: on, off, on, … lengths. Animate dash_offset for marching ants.

fn dash_offset(self, v: f64) -> Self

Shifts the dash pattern along the outline.

fn line_cap(self, v: LineCap) -> Self

Shape of outline ends. Default: round.

fn line_join(self, v: LineJoin) -> Self

Shape of outline corners. Default: round.

fn blur(self, v: f64) -> Self

Gaussian blur of the node and its children (standard deviation, in the node’s units).

fn shadow( self, color: impl IntoPaint, blur: f64, offset: impl Into<Vec2>, ) -> Self

Drop shadow under the node and its children.

fn elevation(self, step: Step) -> Self

The theme’s shadow for this step (Xs and Sm are the small one, Xl the large).

fn glow(self, color: impl IntoPaint, blur: f64) -> Self

A shadow without offset.

fn clip(self, v: bool) -> Self

Clip children to this node’s outline (or box).

fn blend(self, v: BlendMode) -> Self

How the node is composited onto what is below it.

fn z_index(self, v: f64) -> Self

Paint order among siblings; higher is on top.

fn anchor(self, v: impl Into<Vec2>) -> Self

Pivot and placement point: (-1, -1) top-left … (1, 1) bottom-right.

fn grow(self, v: f64) -> Self

Inside a Layout: share of the free space this node takes.

fn shrink(self, v: f64) -> Self

Inside a Layout: how much this node gives up when space is short.

fn basis(self, v: f64) -> Self

Inside a Layout: main-axis size before growing/shrinking.

fn margin(self, v: impl Len) -> Self

Inside a Layout: space around this node, in pixels or a theme step (.margin(Md)).

fn align_self(self, v: LayoutAlign) -> Self

Inside a Layout: overrides the layout’s cross-axis alignment.

fn next_to(self, other: impl Into<Node>, side: Side) -> Self

Sits just outside other, on side. The gap is the theme’s Md step. Recomputed every frame, so this node follows other.

fn align_to(self, other: impl Into<Node>, edge: Edge) -> Self

Lines this node’s edge up with the same edge of other.

fn to_edge(self, edge: Edge) -> Self

Pins one edge to the safe area (not the raw frame edge). The other axis stays at x or y.

fn center_in(self, other: impl Into<Node>) -> Self

Same center as other. Pass the view to center in the frame.

fn child<C: NodeBuilder>(self, child: C) -> Self

Adds a child created together with this node. Use Node::add when you need the child’s handle.