Struct roblox::instance::TextBox[−][src]

pub struct TextBox<'a> {Show 94 fields
    pub clear_text_on_focus: bool,
    pub cursor_position: i32,
    pub enable_realtime_filtering_hints: bool,
    pub font: Font,
    pub line_height: f32,
    pub manual_focus_release: bool,
    pub max_visible_graphemes: i32,
    pub multi_line: bool,
    pub overlay_native_input: bool,
    pub placeholder_color3: Color3,
    pub placeholder_text: &'a str,
    pub return_key_type: ReturnKeyType,
    pub rich_text: bool,
    pub selection_start: i32,
    pub show_native_input: bool,
    pub text: &'a str,
    pub text_bounds: Vector2,
    pub text_color3: Color3,
    pub text_editable: bool,
    pub text_fits: bool,
    pub text_input_type: TextInputType,
    pub text_scaled: bool,
    pub text_size: f32,
    pub text_stroke_color3: Color3,
    pub text_stroke_transparency: f32,
    pub text_transparency: f32,
    pub text_truncate: TextTruncate,
    pub text_wrapped: bool,
    pub text_x_alignment: TextXAlignment,
    pub text_y_alignment: TextYAlignment,
    pub active: bool,
    pub anchor_point: Vector2,
    pub automatic_size: AutomaticSize,
    pub background_color3: Color3,
    pub background_transparency: f32,
    pub border_color3: Color3,
    pub border_mode: BorderMode,
    pub border_size_pixel: i32,
    pub clips_descendants: bool,
    pub layout_order: i32,
    pub next_selection_down: Option<InstanceRef>,
    pub next_selection_left: Option<InstanceRef>,
    pub next_selection_right: Option<InstanceRef>,
    pub next_selection_up: Option<InstanceRef>,
    pub position: UDim2,
    pub rotation: f32,
    pub selectable: bool,
    pub selection_image_object: Option<InstanceRef>,
    pub size: UDim2,
    pub size_constraint: SizeConstraint,
    pub transparency: f32,
    pub visible: bool,
    pub z_index: i32,
    pub absolute_position: Vector2,
    pub absolute_rotation: f32,
    pub absolute_size: Vector2,
    pub auto_localize: bool,
    pub clipped_rect: Rect,
    pub is_not_occluded: bool,
    pub raw_rect2_d: Rect,
    pub root_localization_table: Option<InstanceRef>,
    pub total_group_scale: f32,
    pub archivable: bool,
    pub class_name: &'a str,
    pub name: &'a str,
    pub parent: Option<InstanceRef>,
    pub roblox_locked: bool,
    pub source_asset_id: i64,
    pub focus_lost: RBXScriptSignal<(bool, Option<InstanceRef>)>,
    pub focused: RBXScriptSignal<()>,
    pub return_pressed_from_on_screen_keyboard: RBXScriptSignal<()>,
    pub input_began: RBXScriptSignal<Option<InstanceRef>>,
    pub input_changed: RBXScriptSignal<Option<InstanceRef>>,
    pub input_ended: RBXScriptSignal<Option<InstanceRef>>,
    pub mouse_enter: RBXScriptSignal<(i32, i32)>,
    pub mouse_leave: RBXScriptSignal<(i32, i32)>,
    pub mouse_moved: RBXScriptSignal<(i32, i32)>,
    pub mouse_wheel_backward: RBXScriptSignal<(i32, i32)>,
    pub mouse_wheel_forward: RBXScriptSignal<(i32, i32)>,
    pub selection_gained: RBXScriptSignal<()>,
    pub selection_lost: RBXScriptSignal<()>,
    pub touch_long_press: RBXScriptSignal<(Array<Variant<'a, ()>>, UserInputState)>,
    pub touch_pan: RBXScriptSignal<(Array<Variant<'a, ()>>, Vector2, Vector2, UserInputState)>,
    pub touch_pinch: RBXScriptSignal<(Array<Variant<'a, ()>>, f32, f32, UserInputState)>,
    pub touch_rotate: RBXScriptSignal<(Array<Variant<'a, ()>>, f32, f32, UserInputState)>,
    pub touch_swipe: RBXScriptSignal<(SwipeDirection, i32)>,
    pub touch_tap: RBXScriptSignal<Array<Variant<'a, ()>>>,
    pub ancestry_changed: RBXScriptSignal<(Option<InstanceRef>, Option<InstanceRef>)>,
    pub attribute_changed: RBXScriptSignal<&'a str>,
    pub changed: RBXScriptSignal<&'a str>,
    pub child_added: RBXScriptSignal<Option<InstanceRef>>,
    pub child_removed: RBXScriptSignal<Option<InstanceRef>>,
    pub descendant_added: RBXScriptSignal<Option<InstanceRef>>,
    pub descendant_removing: RBXScriptSignal<Option<InstanceRef>>,
}

Expand description

The TextBox Instance Class

View Roblox documentation

Fields

clear_text_on_focus: boolcursor_position: i32enable_realtime_filtering_hints: boolfont: Fontline_height: f32manual_focus_release: boolmax_visible_graphemes: i32multi_line: booloverlay_native_input: boolplaceholder_color3: Color3placeholder_text: &'a strreturn_key_type: ReturnKeyTyperich_text: boolselection_start: i32show_native_input: booltext: &'a strtext_bounds: Vector2text_color3: Color3text_editable: booltext_fits: booltext_input_type: TextInputTypetext_scaled: booltext_size: f32text_stroke_color3: Color3text_stroke_transparency: f32text_transparency: f32text_truncate: TextTruncatetext_wrapped: booltext_x_alignment: TextXAlignmenttext_y_alignment: TextYAlignmentactive: bool

Inherited from GuiObject

anchor_point: Vector2

Inherited from GuiObject

automatic_size: AutomaticSize

Inherited from GuiObject

background_color3: Color3

Inherited from GuiObject

background_transparency: f32

Inherited from GuiObject

border_color3: Color3

Inherited from GuiObject

border_mode: BorderMode

Inherited from GuiObject

border_size_pixel: i32

Inherited from GuiObject

clips_descendants: bool

Inherited from GuiObject

layout_order: i32

Inherited from GuiObject

next_selection_down: Option<InstanceRef>

Inherited from GuiObject

next_selection_left: Option<InstanceRef>

Inherited from GuiObject

next_selection_right: Option<InstanceRef>

Inherited from GuiObject

next_selection_up: Option<InstanceRef>

Inherited from GuiObject

position: UDim2

Inherited from GuiObject

rotation: f32

Inherited from GuiObject

selectable: bool

Inherited from GuiObject

selection_image_object: Option<InstanceRef>

Inherited from GuiObject

size: UDim2

Inherited from GuiObject

size_constraint: SizeConstraint

Inherited from GuiObject

transparency: f32

Inherited from GuiObject

visible: bool

Inherited from GuiObject

z_index: i32

Inherited from GuiObject

absolute_position: Vector2

Inherited from GuiBase2d

absolute_rotation: f32

Inherited from GuiBase2d

absolute_size: Vector2

Inherited from GuiBase2d

auto_localize: bool

Inherited from GuiBase2d

clipped_rect: Rect

Inherited from GuiBase2d

is_not_occluded: bool

Inherited from GuiBase2d

raw_rect2_d: Rect

Inherited from GuiBase2d

root_localization_table: Option<InstanceRef>

Inherited from GuiBase2d

total_group_scale: f32

Inherited from GuiBase2d

archivable: bool

Inherited from Instance

class_name: &'a str

Inherited from Instance

name: &'a str

Inherited from Instance

parent: Option<InstanceRef>

Inherited from Instance

roblox_locked: bool

Inherited from Instance

source_asset_id: i64

Inherited from Instance

focus_lost: RBXScriptSignal<(bool, Option<InstanceRef>)>focused: RBXScriptSignal<()>return_pressed_from_on_screen_keyboard: RBXScriptSignal<()>input_began: RBXScriptSignal<Option<InstanceRef>>

Inherited from GuiObject

input_changed: RBXScriptSignal<Option<InstanceRef>>

Inherited from GuiObject

input_ended: RBXScriptSignal<Option<InstanceRef>>

Inherited from GuiObject

mouse_enter: RBXScriptSignal<(i32, i32)>

Inherited from GuiObject

mouse_leave: RBXScriptSignal<(i32, i32)>

Inherited from GuiObject

mouse_moved: RBXScriptSignal<(i32, i32)>

Inherited from GuiObject

mouse_wheel_backward: RBXScriptSignal<(i32, i32)>

Inherited from GuiObject

mouse_wheel_forward: RBXScriptSignal<(i32, i32)>

Inherited from GuiObject

selection_gained: RBXScriptSignal<()>

Inherited from GuiObject

selection_lost: RBXScriptSignal<()>

Inherited from GuiObject

touch_long_press: RBXScriptSignal<(Array<Variant<'a, ()>>, UserInputState)>

Inherited from GuiObject

touch_pan: RBXScriptSignal<(Array<Variant<'a, ()>>, Vector2, Vector2, UserInputState)>

Inherited from GuiObject

touch_pinch: RBXScriptSignal<(Array<Variant<'a, ()>>, f32, f32, UserInputState)>

Inherited from GuiObject

touch_rotate: RBXScriptSignal<(Array<Variant<'a, ()>>, f32, f32, UserInputState)>

Inherited from GuiObject

touch_swipe: RBXScriptSignal<(SwipeDirection, i32)>

Inherited from GuiObject

touch_tap: RBXScriptSignal<Array<Variant<'a, ()>>>

Inherited from GuiObject

ancestry_changed: RBXScriptSignal<(Option<InstanceRef>, Option<InstanceRef>)>

Inherited from Instance

attribute_changed: RBXScriptSignal<&'a str>

Inherited from Instance

changed: RBXScriptSignal<&'a str>

Inherited from Instance

child_added: RBXScriptSignal<Option<InstanceRef>>

Inherited from Instance

child_removed: RBXScriptSignal<Option<InstanceRef>>

Inherited from Instance

descendant_added: RBXScriptSignal<Option<InstanceRef>>

Inherited from Instance

descendant_removing: RBXScriptSignal<Option<InstanceRef>>

Inherited from Instance

Struct roblox::instance::TextBox[−][src]

Fields

Implementations

impl<'a> TextBox<'a>

pub fn new() -> Self

pub fn capture_focus(&self)

pub fn is_focused(&self) -> bool

pub fn release_focus(&self, submitted: bool)

pub fn reset_keyboard_mode(&self)

pub fn set_text_from_input(&self, text: &'a str)

pub fn tween_position( &self, end_position: UDim2, easing_direction: EasingDirection, easing_style: EasingStyle, time: f32, override: bool, callback: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>) -> bool

pub fn tween_size( &self, end_size: UDim2, easing_direction: EasingDirection, easing_style: EasingStyle, time: f32, override: bool, callback: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>) -> bool

pub fn tween_size_and_position( &self, end_size: UDim2, end_position: UDim2, easing_direction: EasingDirection, easing_style: EasingStyle, time: f32, override: bool, callback: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>) -> bool

pub fn clear_all_children(&self)

pub fn destroy(&self)

pub fn find_first_ancestor(&self, name: &'a str) -> Option<InstanceRef>

pub fn find_first_ancestor_of_class( &self, class_name: &'a str) -> Option<InstanceRef>

pub fn find_first_ancestor_which_is_a( &self, class_name: &'a str) -> Option<InstanceRef>

pub fn find_first_child( &self, name: &'a str, recursive: bool) -> Option<InstanceRef>

pub fn find_first_child_of_class( &self, class_name: &'a str) -> Option<InstanceRef>

pub fn find_first_child_which_is_a( &self, class_name: &'a str, recursive: bool) -> Option<InstanceRef>

pub fn find_first_descendant(&self, name: &'a str) -> Option<InstanceRef>

pub fn get_actor(&self) -> Option<InstanceRef>

pub fn get_attribute(&self, attribute: &'a str) -> Variant<'a, ()>

pub fn get_attribute_changed_signal( &self, attribute: &'a str) -> RBXScriptSignal<()>

pub fn get_attributes(&self) -> Dictionary

pub fn get_children(&self) -> Array<Instance<'a>>

pub fn get_debug_id(&self, scope_length: i32) -> &'a str

pub fn get_descendants(&self) -> Array<Variant<'a, ()>>

pub fn get_full_name(&self) -> &'a str

pub fn get_property_changed_signal( &self, property: &'a str) -> RBXScriptSignal<()>

pub fn is_a(&self, class_name: &'a str) -> bool

pub fn is_ancestor_of(&self, descendant: Option<InstanceRef>) -> bool

pub fn is_descendant_of(&self, ancestor: Option<InstanceRef>) -> bool

pub fn set_attribute(&self, attribute: &'a str, value: Variant<'a, ()>)

pub fn wait_for_child( &self, child_name: &'a str, time_out: f64) -> Option<InstanceRef>

Trait Implementations

impl<'a> Clone for TextBox<'a>

fn clone(&self) -> TextBox<'a>

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

impl<'a> Debug for TextBox<'a>

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

impl<'a> PartialEq<TextBox<'a>> for TextBox<'a>

fn eq(&self, other: &TextBox<'a>) -> bool

fn ne(&self, other: &TextBox<'a>) -> bool

impl<'a> Copy for TextBox<'a>

impl<'a> StructuralPartialEq for TextBox<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for TextBox<'a>

impl<'a> Send for TextBox<'a>

impl<'a> Sync for TextBox<'a>

impl<'a> Unpin for TextBox<'a>

impl<'a> UnwindSafe for TextBox<'a>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn tween_position(
&self,
end_position: UDim2,
easing_direction: EasingDirection,
easing_style: EasingStyle,
time: f32,
override: bool,
callback: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>
) -> bool

pub fn tween_size(
&self,
end_size: UDim2,
easing_direction: EasingDirection,
easing_style: EasingStyle,
time: f32,
override: bool,
callback: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>
) -> bool

pub fn tween_size_and_position(
&self,
end_size: UDim2,
end_position: UDim2,
easing_direction: EasingDirection,
easing_style: EasingStyle,
time: f32,
override: bool,
callback: &'a dyn Fn(&'static [Variant<'a, ()>]) -> Array<Variant<'a, ()>>
) -> bool

pub fn find_first_ancestor_of_class(
&self,
class_name: &'a str
) -> Option<InstanceRef>

pub fn find_first_ancestor_which_is_a(
&self,
class_name: &'a str
) -> Option<InstanceRef>

pub fn find_first_child(
&self,
name: &'a str,
recursive: bool
) -> Option<InstanceRef>

pub fn find_first_child_of_class(
&self,
class_name: &'a str
) -> Option<InstanceRef>

pub fn find_first_child_which_is_a(
&self,
class_name: &'a str,
recursive: bool
) -> Option<InstanceRef>

pub fn get_attribute_changed_signal(
&self,
attribute: &'a str
) -> RBXScriptSignal<()>

pub fn get_property_changed_signal(
&self,
property: &'a str
) -> RBXScriptSignal<()>

pub fn wait_for_child(
&self,
child_name: &'a str,
time_out: f64
) -> Option<InstanceRef>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,