Struct fyrox_ui::widget::WidgetBuilder

pub struct WidgetBuilder {

    pub name: String,
    pub width: f32,
    pub height: f32,
    pub desired_position: Vector2<f32>,
    pub vertical_alignment: VerticalAlignment,
    pub horizontal_alignment: HorizontalAlignment,
    pub max_size: Option<Vector2<f32>>,
    pub min_size: Option<Vector2<f32>>,
    pub background: Option<Brush>,
    pub foreground: Option<Brush>,
    pub row: usize,
    pub column: usize,
    pub margin: Thickness,
    pub children: Vec<Handle<UiNode>>,
    pub is_hit_test_visible: bool,
    pub visibility: bool,
    pub z_index: usize,
    pub allow_drag: bool,
    pub allow_drop: bool,
    pub user_data: Option<Rc<dyn Any>>,
    pub draw_on_top: bool,
    pub enabled: bool,
    pub cursor: Option<CursorIcon>,
    pub opacity: Option<f32>,
    pub tooltip: Rc<Handle<UiNode>>,
    pub tooltip_time: f32,
    pub context_menu: Handle<UiNode>,
    pub preview_messages: bool,
    pub handle_os_events: bool,
    pub layout_transform: Matrix3<f32>,
    pub render_transform: Matrix3<f32>,
    pub clip_to_bounds: bool,
}

Fields

name: String

width: f32

height: f32

desired_position: Vector2<f32>

vertical_alignment: VerticalAlignment

horizontal_alignment: HorizontalAlignment

max_size: Option<Vector2<f32>>

min_size: Option<Vector2<f32>>

background: Option<Brush>

foreground: Option<Brush>

row: usize

column: usize

margin: Thickness

children: Vec<Handle<UiNode>>

is_hit_test_visible: bool

visibility: bool

z_index: usize

allow_drag: bool

allow_drop: bool

user_data: Option<Rc<dyn Any>>

draw_on_top: bool

enabled: bool

cursor: Option<CursorIcon>

opacity: Option<f32>

tooltip: Rc<Handle<UiNode>>

tooltip_time: f32

context_menu: Handle<UiNode>

preview_messages: bool

handle_os_events: bool

layout_transform: Matrix3<f32>

render_transform: Matrix3<f32>

clip_to_bounds: bool

Implementations

impl WidgetBuilder

pub fn new() -> Self

pub fn with_preview_messages(self, state: bool) -> Self

pub fn with_handle_os_events(self, state: bool) -> Self

pub fn with_width(self, width: f32) -> Self

pub fn with_height(self, height: f32) -> Self

pub fn with_clip_to_bounds(self, clip_to_bounds: bool) -> Self

pub fn with_enabled(self, enabled: bool) -> Self

pub fn with_vertical_alignment(self, valign: VerticalAlignment) -> Self

pub fn with_horizontal_alignment(self, halign: HorizontalAlignment) -> Self

pub fn with_max_size(self, max_size: Vector2<f32>) -> Self

pub fn with_min_size(self, min_size: Vector2<f32>) -> Self

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

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

pub fn on_row(self, row: usize) -> Self

pub fn on_column(self, column: usize) -> Self

pub fn with_margin(self, margin: Thickness) -> Self

pub fn with_desired_position(self, desired_position: Vector2<f32>) -> Self

pub fn with_layout_transform(self, layout_transform: Matrix3<f32>) -> Self

pub fn with_render_transform(self, render_transform: Matrix3<f32>) -> Self

pub fn with_z_index(self, z_index: usize) -> Self

pub fn with_child(self, handle: Handle<UiNode>) -> Self

pub fn with_draw_on_top(self, draw_on_top: bool) -> Self

pub fn with_children<I: IntoIterator<Item = Handle<UiNode>>>(
    self,
    children: I
) -> Self

pub fn with_name(self, name: &str) -> Self

pub fn with_hit_test_visibility(self, state: bool) -> Self

pub fn with_visibility(self, visibility: bool) -> Self

pub fn with_allow_drop(self, allow_drop: bool) -> Self

pub fn with_allow_drag(self, allow_drag: bool) -> Self

pub fn with_user_data(self, user_data: Rc<dyn Any>) -> Self

pub fn with_cursor(self, cursor: Option<CursorIcon>) -> Self

pub fn with_opacity(self, opacity: Option<f32>) -> Self

pub fn with_tooltip(self, tooltip: Rc<Handle<UiNode>>) -> Self

Sets the desired tooltip for the node.

Important

The widget will share the tooltip, which means that when widget will be deleted, the tooltip will be deleted only if there’s no one use the tooltip anymore.

pub fn with_tooltip_time(self, tooltip_time: f32) -> Self

pub fn with_context_menu(self, context_menu: Handle<UiNode>) -> Self

The context menu receives PopupMessages for being displayed, and so should support those.

pub fn build(self) -> Widget

Trait Implementations

impl Default for WidgetBuilder

fn default() -> Self

Returns the “default value” for a type.