Struct ButtonBuilder

pub struct ButtonBuilder { /* private fields */ }

Button builder is used to create Button widget instances.

Implementations

impl ButtonBuilder

pub fn new(widget_builder: WidgetBuilder) -> ButtonBuilder

Creates a new button builder with a widget builder instance.

pub fn with_text(self, text: &str) -> ButtonBuilder

Sets the content of the button to be ButtonContent::Text (text with the default font).

pub fn with_text_and_font( self, text: &str, font: Resource<Font>, ) -> ButtonBuilder

Sets the content of the button to be ButtonContent::Text (text with a custom font).

pub fn with_text_and_font_size( self, text: &str, font: Resource<Font>, size: StyledProperty<f32>, ) -> ButtonBuilder

Sets the content of the button to be ButtonContent::Text (text with a custom font and size).

pub fn with_content(self, node: Handle<UiNode>) -> ButtonBuilder

Sets the content of the button to be ButtonContent::Node (arbitrary widget handle).

pub fn with_back(self, decorator: Handle<UiNode>) -> ButtonBuilder

Specifies the widget that will be used as a content holder of the button. By default it is an instance of crate::decorator::Decorator widget. Usually, this widget should respond to mouse events to highlight button state (hovered, pressed, etc.)

pub fn with_repeat_clicks_on_hold(self, repeat: bool) -> ButtonBuilder

Set the flag, that defines whether the button should repeat click message when being hold or not. Default is false (disabled).

pub fn with_repeat_interval(self, interval: f32) -> ButtonBuilder

Sets the desired click repetition interval (in seconds) of the button. Default is 0.1s

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

Finishes building a button.

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

Finishes button build and adds to the user interface and returns its handle.