Struct fyrox_ui::text_box::TextBoxBuilder

pub struct TextBoxBuilder { /* private fields */ }

Text box builder creates new TextBox instances and adds them to the user interface.

Implementations

impl TextBoxBuilder

pub fn new(widget_builder: WidgetBuilder) -> Self

Creates new text box widget builder with the base widget builder specified.

pub fn with_font(self, font: SharedFont) -> Self

Sets the desired font of the text box.

pub fn with_text<P: AsRef<str>>(self, text: P) -> Self

Sets the desired text of the text box.

pub fn with_caret_brush(self, brush: Brush) -> Self

Sets the desired caret brush of the text box.

pub fn with_selection_brush(self, brush: Brush) -> Self

Sets the desired selection brush of the text box.

pub fn with_filter(self, filter: Rc<RefCell<FilterCallback>>) -> Self

Sets the desired character filter of the text box. See FilterCallback for more info.

pub fn with_vertical_text_alignment(self, alignment: VerticalAlignment) -> Self

Sets the desired vertical text alignment of the text box.

pub fn with_horizontal_text_alignment( self, alignment: HorizontalAlignment ) -> Self

Sets the desired horizontal text alignment of the text box.

pub fn with_wrap(self, wrap: WrapMode) -> Self

Sets the desired word wrapping of the text box.

pub fn with_text_commit_mode(self, mode: TextCommitMode) -> Self

Sets the desired text commit mode of the text box.

pub fn with_multiline(self, multiline: bool) -> Self

Enables or disables multiline mode of the text box.

pub fn with_editable(self, editable: bool) -> Self

Enables or disables editing of the text box.

pub fn with_mask_char(self, mask_char: Option<char>) -> Self

Sets the desired masking character of the text box.

pub fn with_shadow(self, shadow: bool) -> Self

Whether the shadow enabled or not.

pub fn with_shadow_brush(self, brush: Brush) -> Self

Sets desired shadow brush. It will be used to render the shadow.

pub fn with_shadow_dilation(self, thickness: f32) -> Self

Sets desired shadow dilation in units. Keep in mind that the dilation is absolute, not percentage-based.

pub fn with_shadow_offset(self, offset: Vector2<f32>) -> Self

Sets desired shadow offset in units.

pub fn with_skip_chars(self, chars: Vec<char>) -> Self

Sets desired set of characters that will be treated like whitespace during Ctrl+Arrow navigation (Ctrl+Left Arrow and Ctrl+Right Arrow). This could be useful to treat underscores like whitespaces, which in its turn could be useful for in-game consoles where commands usually separated using underscores (like_this_one).

pub fn build(self, ctx: &mut BuildContext<'_>) -> Handle<UiNode>

Creates a new TextBox instance and adds it to the user interface.