Struct orbtk_widgets::behaviors::TextBehavior

pub struct TextBehavior { /* fields omitted */ }

The TextBehavior widget shares the same logic of handling text input between tex-related widgets.

Attaching to a widget makes it able to handle text input like:

• input characters by keyboard
• select all text with Ctrl+A key combination
• delete selected text with Backspace or Delete
• move cursor by the left or right arrow keys or clicking with mouse
• delete characters by pressing the Backspace or the Delete key
• run on_activate() callback on pressing the Enter key

TextBehavior needs the following prerequisites to able to work:

• a cursor: the Entity of a Cursor widget

• a target: the Entity of the target widget

• and must inherit the following properties from its target:

  • focused
  • font
  • font_size
  • lost_focus_on_activation
  • request_focus
  • text
  • text_selection

Example

use orbtk::prelude::*

widget!(MyInput {
    // essential properties TextBehavior needs to inherit
    focused: bool,
    font: String,
    font_size: f64,
    lost_focus_on_activation: bool,
    request_focus: bool,
    text_selection: TextSelection
});

impl Template for MyInput {
    fn template(self, id: Entity, ctx: &mut BuildContext) -> Self {
        // Cursor depends on a TextBlock
        let text_block = TextBlock::new()
            .text(id)
            .water_mark(id)
            .font(id)
            .font_size(id)
            .build(ctx);

        let cursor = Cursor::new()
           // use .0 because Entity wraps an u32
           .text_block(text_block.0)
           .focused(id)
           .text_selection(id)
           .build(ctx);

       let text_behavior = TextBehavior::new()
           .cursor(cursor.0)
           .focused(id)
           .font(id)
           .font_size(id)
           .lost_focus_on_activation(id)
           .target(id.0)
           .request_focus(id)
           .text(id)
           .text_selection(id)
           .build(ctx);

       self.child(cursor)
           .child(text_behavior)
}

Implementations

impl TextBehavior

pub fn get<'a>(ctx: WidgetContainer<'a>) -> TextBehaviorCtx<'a>

Gets a widget context that wraps the given widgets an provides access to the its properties.

impl TextBehavior

pub fn id(self, id: impl Into<String>) -> Self

Sets the id selector.

pub fn style(self, style: impl Into<String>) -> Self

Sets the style selector (replaces the old selector property).

pub fn position(self, position: impl IntoPropertySource<Point>) -> Self

Sets or shares the position of the widget. (Be careful the position could be adjusted by layouts).

pub fn constraint(self, constraint: impl IntoPropertySource<Constraint>) -> Self

Sets or shares the constraint property.

pub fn on_changed_filter(self, filter: impl IntoPropertySource<Filter>) -> Self

Sets or shares the filter for the on_changed property callback.

pub fn v_align(self, v_align: impl IntoPropertySource<Alignment>) -> Self

Sets or shares the vertical alignment property.

pub fn h_align(self, h_align: impl IntoPropertySource<Alignment>) -> Self

Sets or shares the horizontal alignment property.

pub fn vertical_alignment(
    self,
    vertical_alignment: impl IntoPropertySource<Alignment>
) -> Self

👎 Deprecated:

Use v_align instead

Sets or shares the vertical alignment property.

pub fn horizontal_alignment(
    self,
    horizontal_alignment: impl IntoPropertySource<Alignment>
) -> Self

👎 Deprecated:

Use h_align instead

Sets or shares the horizontal alignment property.

pub fn visibility(self, visibility: impl IntoPropertySource<Visibility>) -> Self

Sets or shares the visibility property.

pub fn margin(self, margin: impl IntoPropertySource<Thickness>) -> Self

Sets or shares the margin property.

pub fn enabled(self, enabled: impl IntoPropertySource<bool>) -> Self

Sets or shares the enabled property.

pub fn clip(self, clip: impl IntoPropertySource<bool>) -> Self

Sets or shares the clip property.

pub fn opacity(self, opacity: impl IntoPropertySource<f32>) -> Self

Sets or shares the opacity property.

pub fn width(self, width: impl Into<f64>) -> Self

Inserts a new width.

pub fn height(self, height: impl Into<f64>) -> Self

Inserts a new height.

pub fn size(self, width: impl Into<f64>, height: impl Into<f64>) -> Self

Inserts a new size.

pub fn min_width(self, min_width: impl Into<f64>) -> Self

Inserts a new min_width.

pub fn min_height(self, min_height: impl Into<f64>) -> Self

Inserts a new min_height.

pub fn min_size(
    self,
    min_width: impl Into<f64>,
    min_height: impl Into<f64>
) -> Self

Inserts a new min_size.

pub fn max_width(self, max_width: impl Into<f64>) -> Self

Inserts a new max_width.

pub fn max_height(self, max_height: impl Into<f64>) -> Self

Inserts a new max_height.

pub fn max_size(
    self,
    max_width: impl Into<f64>,
    max_height: impl Into<f64>
) -> Self

Inserts a new min_size.

pub fn name<P: Into<String>>(self, name: P) -> Self

Sets the debug name of the widget.

pub fn cursor<P: IntoPropertySource<u32>>(self, cursor: P) -> Self

Sets or shares the entity of the Cursor widget property.

pub fn focused<P: IntoPropertySource<bool>>(self, focused: P) -> Self

Sets or shares the focused property.

pub fn font<P: IntoPropertySource<String>>(self, font: P) -> Self

Sets or shares the font property.

pub fn font_size<P: IntoPropertySource<f64>>(self, font_size: P) -> Self

Sets or shares the font size property.

pub fn lost_focus_on_activation<P: IntoPropertySource<bool>>(
    self,
    lost_focus_on_activation: P
) -> Self

Sets or shares ta value that describes if the widget should lost focus on activation (when Enter pressed).

pub fn target<P: IntoPropertySource<u32>>(self, target: P) -> Self

Sets or shares the entity of the target widget.

pub fn request_focus<P: IntoPropertySource<bool>>(
    self,
    request_focus: P
) -> Self

Sets or shares the request_focus property. Used to request focus from outside.Set to true to request focus.

pub fn text<P: IntoPropertySource<String16>>(self, text: P) -> Self

Sets or shares the text property.

pub fn text_selection<P: IntoPropertySource<TextSelection>>(
    self,
    text_selection: P
) -> Self

Sets or shares the text selection property.

Trait Implementations

impl ActivateHandler for TextBehavior

fn on_activate<H>(self, handler: H) -> Self where
    H: 'static + Fn(&mut StatesContext<'_>, Entity), 

impl ChangedHandler for TextBehavior

fn on_changed<H>(self, handler: H) -> Self where
    H: 'static + Fn(&mut StatesContext<'_>, Entity, &str), 

Register a on property changed handler.

impl Default for TextBehavior

fn default() -> TextBehavior

Returns the "default value" for a type.

impl KeyDownHandler for TextBehavior

fn on_key_down<H>(self, handler: H) -> Self where
    H: 'static + Fn(&mut StatesContext<'_>, KeyEvent) -> bool, 

Inserts a handler.

fn on_key_down_key<H>(self, key: Key, handler: H) -> Self where
    H: 'static + Fn() -> bool, 

Handles events triggered by a specific key.

impl Template for TextBehavior

fn template(self, id: Entity, ctx: &mut BuildContext<'_>) -> Self

Builds the template of the widget and returns it.

fn render_object(&self) -> Box<dyn RenderObject + 'static>

Returns a pointer to a heap allocated object which specifies how the widget should be drawn on the canvas. For the list of available render objects, see the [render_object] module.

fn layout(&self) -> Box<dyn Layout + 'static>

Returns a pointer to a heap allocated object which specifies the way in which the widget are arranged or laid out on the canvas. For the list of available layout objects, see the [layout] module.

impl Widget for TextBehavior

fn new() -> Self

Creates a new widget.

fn attach<P: Component + Debug>(self, property: AttachedProperty<P>) -> Self

fn insert_handler(self, handler: impl Into<Rc<dyn EventHandler>>) -> Self

Inerts a new event handler.

fn child(self, child: Entity) -> Self

Appends a child to the widget.

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

Builds the widget and returns the template of the widget.

fn create() -> Self

👎 Deprecated:

Use new instead

Creates a new widget.