Struct rg3d_ui::text_box::TextBox

pub struct TextBox<M: MessageData, C: Control<M, C>> { /* fields omitted */ }

Implementations

impl<M: MessageData, C: Control<M, C>> TextBox<M, C>

pub fn reset_blink(&mut self)

pub fn move_caret_x(
    &mut self,
    offset: usize,
    direction: HorizontalDirection,
    select: bool
)

pub fn move_caret_y(
    &mut self,
    offset: usize,
    direction: VerticalDirection,
    select: bool
)

pub fn get_absolute_position(&self, position: Position) -> Option<usize>

pub fn get_text_len(&self) -> usize

pub fn screen_pos_to_text_pos(
    &self,
    screen_pos: Vector2<f32>
) -> Option<Position>

pub fn text(&self) -> String

pub fn set_wrap(&mut self, wrap: bool) -> &mut Self

pub fn is_wrap(&self) -> bool

pub fn set_font(&mut self, font: SharedFont) -> &mut Self

pub fn font(&self) -> SharedFont

pub fn set_vertical_alignment(&mut self, valign: VerticalAlignment) -> &mut Self

pub fn vertical_alignment(&self) -> VerticalAlignment

pub fn set_horizontal_alignment(
    &mut self,
    halign: HorizontalAlignment
) -> &mut Self

pub fn horizontal_alignment(&self) -> HorizontalAlignment

Methods from Deref<Target = Widget<M, C>>

pub fn handle(&self) -> Handle<UINode<M, C>>

pub fn name(&self) -> &str

pub fn set_name<P: AsRef<str>>(&mut self, name: P) -> &mut Self

pub fn actual_size(&self) -> Vector2<f32>

pub fn set_min_size(&mut self, value: Vector2<f32>) -> &mut Self

pub fn min_size(&self) -> Vector2<f32>

pub fn min_width(&self) -> f32

pub fn min_height(&self) -> f32

pub fn is_drag_allowed(&self) -> bool

pub fn is_drop_allowed(&self) -> bool

pub fn invalidate_layout(&self)

pub fn invalidate_measure(&self)

pub fn invalidate_arrange(&self)

pub fn is_hit_test_visible(&self) -> bool

pub fn set_max_size(&mut self, value: Vector2<f32>) -> &mut Self

pub fn max_size(&self) -> Vector2<f32>

pub fn max_width(&self) -> f32

pub fn max_height(&self) -> f32

pub fn set_z_index(&mut self, z_index: usize) -> &mut Self

pub fn z_index(&self) -> usize

pub fn set_background(&mut self, brush: Brush) -> &mut Self

pub fn background(&self) -> Brush

pub fn set_foreground(&mut self, brush: Brush) -> &mut Self

pub fn foreground(&self) -> Brush

pub fn set_width(&mut self, width: f32) -> &mut Self

pub fn width(&self) -> f32

pub fn is_draw_on_top(&self) -> bool

pub fn set_height(&mut self, height: f32) -> &mut Self

pub fn height(&self) -> f32

pub fn set_desired_local_position(&mut self, pos: Vector2<f32>) -> &mut Self

pub fn screen_position(&self) -> Vector2<f32>

pub fn children(&self) -> &[Handle<UINode<M, C>>]

pub fn parent(&self) -> Handle<UINode<M, C>>

pub fn set_parent(&mut self, parent: Handle<UINode<M, C>>)

pub fn column(&self) -> usize

pub fn set_row(&mut self, row: usize) -> &mut Self

pub fn row(&self) -> usize

pub fn desired_size(&self) -> Vector2<f32>

pub fn desired_local_position(&self) -> Vector2<f32>

pub fn set_visibility(&mut self, visibility: bool) -> &mut Self

pub fn screen_bounds(&self) -> Rect<f32>

pub fn has_descendant(
    &self,
    node_handle: Handle<UINode<M, C>>,
    ui: &UserInterface<M, C>
) -> bool

pub fn find_by_criteria_up<Func: Fn(&UINode<M, C>) -> bool>(
    &self,
    ui: &UserInterface<M, C>,
    func: Func
) -> Handle<UINode<M, C>>

Searches a node up on tree starting from given root that matches a criteria defined by a given func.

pub fn is_measure_valid_with_descendants(
    &self,
    ui: &UserInterface<M, C>
) -> bool

pub fn is_arrange_valid_with_descendants(
    &self,
    ui: &UserInterface<M, C>
) -> bool

pub fn handle_routed_message(
    &mut self,
    _ui: &mut UserInterface<M, C>,
    msg: &mut UiMessage<M, C>
)

pub fn set_vertical_alignment(
    &mut self,
    vertical_alignment: VerticalAlignment
) -> &mut Self

pub fn vertical_alignment(&self) -> VerticalAlignment

pub fn set_horizontal_alignment(
    &mut self,
    horizontal_alignment: HorizontalAlignment
) -> &mut Self

pub fn horizontal_alignment(&self) -> HorizontalAlignment

pub fn set_column(&mut self, column: usize) -> &mut Self

pub fn set_margin(&mut self, margin: Thickness) -> &mut Self

pub fn margin(&self) -> Thickness

pub fn measure_override(
    &self,
    ui: &UserInterface<M, C>,
    available_size: Vector2<f32>
) -> Vector2<f32>

pub fn arrange_override(
    &self,
    ui: &UserInterface<M, C>,
    final_size: Vector2<f32>
) -> Vector2<f32>

pub fn is_arrange_valid(&self) -> bool

pub fn is_measure_valid(&self) -> bool

pub fn actual_local_position(&self) -> Vector2<f32>

pub fn is_globally_visible(&self) -> bool

pub fn visibility(&self) -> bool

pub fn enabled(&self) -> bool

pub fn set_cursor(&mut self, cursor: Option<CursorIcon>)

pub fn cursor(&self) -> Option<CursorIcon>

pub fn user_data_ref<T: 'static>(&self) -> Option<&T>

pub fn clip_bounds(&self) -> Rect<f32>

pub fn opacity(&self) -> f32

pub fn tooltip(&self) -> Handle<UINode<M, C>>

pub fn set_tooltip(&mut self, tooltip: Handle<UINode<M, C>>)

pub fn tooltip_time(&self) -> f32

pub fn set_tooltip_time(&mut self, tooltip_time: f32)

pub fn context_menu(&self) -> Handle<UINode<M, C>>

pub fn set_context_menu(&mut self, context_menu: Handle<UINode<M, C>>)

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

Trait Implementations

impl<M: Clone + MessageData, C: Clone + Control<M, C>> Clone for TextBox<M, C>

fn clone(&self) -> TextBox<M, C>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<M: MessageData, C: Control<M, C>> Control<M, C> for TextBox<M, C>

fn measure_override(
    &self,
    _: &UserInterface<M, C>,
    available_size: Vector2<f32>
) -> Vector2<f32>

fn draw(&self, drawing_context: &mut DrawingContext)

fn update(&mut self, dt: f32)

fn handle_routed_message(
    &mut self,
    ui: &mut UserInterface<M, C>,
    message: &mut UiMessage<M, C>
)

Performs event-specific actions. Must call widget.handle_message()!

fn resolve(&mut self, _node_map: &NodeHandleMapping<M, C>)

fn arrange_override(
    &self,
    ui: &UserInterface<M, C>,
    final_size: Vector2<f32>
) -> Vector2<f32>

fn preview_message(
    &self,
    _ui: &UserInterface<M, C>,
    _message: &mut UiMessage<M, C>
)

Used to react to a message (by producing another message) that was posted outside of current hierarchy. In other words this method is used when you need to “peek” a message before it’ll be passed into bubbling router. Most common use case is to catch messages from popups: popup in 99.9% cases is a child of root canvas and it won’t receive a message from a its logical parent during bubbling message routing. For example preview_message used in a dropdown list: dropdown list has two separate parts - a field with selected value and a popup for all possible options. Visual parent of the popup in this case is the root canvas, but logical parent is the dropdown list. Because of this fact, the field won’t receive any messages from popup, to solve this we use preview_message. This method is much more restrictive - it does not allow you to modify a node and ui, you can either request changes by sending a message or use internal mutability (Cell, RefCell, etc).

fn handle_os_event(
    &mut self,
    _self_handle: Handle<UINode<M, C>>,
    _ui: &mut UserInterface<M, C>,
    _event: &OsEvent
)

Provides a way to respond to OS specific events. Can be useful to detect if a key or mouse button was pressed. This method significantly differs from handle_message because os events are not dispatched - they’ll be passed to this method in any case.

fn remove_ref(&mut self, _handle: Handle<UINode<M, C>>)

Called when a node is deleted from container thus giving a chance to remove dangling handles which may cause panic.

impl<M: MessageData, C: Control<M, C>> Debug for TextBox<M, C>

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

Formats the value using the given formatter.

impl<M: MessageData, C: Control<M, C>> Deref for TextBox<M, C>

type Target = Widget<M, C>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<M: MessageData, C: Control<M, C>> DerefMut for TextBox<M, C>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.