Struct Button

pub struct Button {
    pub enable_long_press: bool,
    pub text: ArcStringMut,
    /* private fields */
}

A clickable button widget that emits actions when pressed, and when either released or clicked.

Fields

enable_long_press: bool

Set the long-press handling behavior of this button.

• If false (default), the button will ignore long-press events and will never emit ButtonAction::LongPressed.
  • Also, the button logic will not call FingerUpEvent::was_tap() to check if the button press was a short tap. This means that this button will consider itself to be clicked (and thus emit a ButtonAction::Clicked event) if the finger-up/release event occurs within the button area, regardless of how long the button was pressed down before it was released.
• If true, the button will respond to a long-press event by emitting ButtonAction::LongPressed, which can only occur on mobile platforms that support a native long press event.
  • Also, the button will only consider itself to be clicked (and thus emit ButtonAction::Clicked) if FingerUpEvent::was_tap() returns true, meaning that a long press did not occur and that the button was released over the button area within a short time frame (~0.5 seconds) after the initial down press.

text: ArcStringMut

Implementations

impl Button

pub fn draw_button(&mut self, cx: &mut Cx2d<'_, '_>, label: &str)

pub fn clicked(&self, actions: &Actions) -> bool

Returns true if this button was clicked.

See ButtonAction for more details.

pub fn pressed(&self, actions: &Actions) -> bool

Returns true if this button was pressed down.

See ButtonAction for more details.

pub fn long_pressed(&self, actions: &Actions) -> bool

Returns true if this button was long-pressed on.

Note that this does not mean the button has been released yet. See ButtonAction for more details.

pub fn released(&self, actions: &Actions) -> bool

Returns true if this button was released, which is not considered to be clicked.

See ButtonAction for more details.

pub fn clicked_modifiers(&self, actions: &Actions) -> Option<KeyModifiers>

Returns Some (with active keyboard modifiers) if this button was clicked.

See ButtonAction for more details.

pub fn pressed_modifiers(&self, actions: &Actions) -> Option<KeyModifiers>

Returns Some (with active keyboard modifiers) if this button was pressed down.

See ButtonAction for more details.

pub fn released_modifiers(&self, actions: &Actions) -> Option<KeyModifiers>

Returns Some (with active keyboard modifiers) if this button was released, which is not considered to be clicked.

See ButtonAction for more details.

Trait Implementations

impl AnimatorImpl for Button

fn animator_play_with_scope( &mut self, cx: &mut Cx, state: &[LiveId; 2], scope: &mut Scope<'_, '_>, )

fn animator_in_state(&self, cx: &Cx, check_state_pair: &[LiveId; 2]) -> bool

fn animator_cut_with_scope( &mut self, cx: &mut Cx, state: &[LiveId; 2], scope: &mut Scope<'_, '_>, )

fn animator_after_apply( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], )

fn animator_apply_state(&mut self, cx: &mut Cx, scope: &mut Scope<'_, '_>)

fn animator_handle_event_with_scope( &mut self, cx: &mut Cx, event: &Event, scope: &mut Scope<'_, '_>, ) -> AnimatorAction

fn animator_cut(&mut self, cx: &mut Cx, state: &[LiveId; 2])

fn animator_play(&mut self, cx: &mut Cx, state: &[LiveId; 2])

fn animator_toggle_with_scope( &mut self, cx: &mut Cx, is_state_1: bool, animate: Animate, state1: &[LiveId; 2], state2: &[LiveId; 2], scope: &mut Scope<'_, '_>, )

fn animator_toggle( &mut self, cx: &mut Cx, is_state_1: bool, animate: Animate, state1: &[LiveId; 2], state2: &[LiveId; 2], )

fn animator_handle_event( &mut self, cx: &mut Cx, event: &Event, ) -> AnimatorAction

impl LiveApply for Button

fn apply( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, start_index: usize, nodes: &[LiveNode], ) -> usize

fn apply_over(&mut self, cx: &mut Cx, nodes: &[LiveNode])

impl LiveApplyReset for Button

fn apply_reset( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, start_index: usize, nodes: &[LiveNode], )

impl LiveApplyValue for Button

fn apply_value( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> usize

impl LiveHook for Button

fn apply_value_unknown( &mut self, cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> usize

fn skip_apply_animator( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], ) -> bool

fn apply_value_instance( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> usize

fn skip_apply( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], ) -> Option<usize>

fn before_apply( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], )

fn after_apply( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], )

fn after_apply_from(&mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>)

fn after_new_from_doc(&mut self, _cx: &mut Cx)

fn after_update_from_doc(&mut self, _cx: &mut Cx)

fn after_apply_from_doc(&mut self, _cx: &mut Cx)

fn after_new_before_apply(&mut self, _cx: &mut Cx)

impl LiveHookDeref for Button

fn deref_before_apply( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], )

fn deref_after_apply( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], )

impl LiveNew for Button

fn live_type_info(cx: &mut Cx) -> LiveTypeInfo

fn live_design_with(cx: &mut Cx)

fn new(cx: &mut Cx) -> Self

fn new_apply( cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> Self

where Self: Sized,

fn new_apply_over(cx: &mut Cx, nodes: &[LiveNode]) -> Self

where Self: Sized,

fn new_apply_mut_index( cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: &mut usize, nodes: &[LiveNode], ) -> Self

where Self: Sized,

fn new_from_ptr(cx: &mut Cx, live_ptr: Option<LivePtr>) -> Self

where Self: Sized,

fn update_from_ptr(&mut self, cx: &mut Cx, live_ptr: Option<LivePtr>)

fn update_from_ptr_with_scope( &mut self, cx: &mut Cx, live_ptr: Option<LivePtr>, scope: &mut Scope<'_, '_>, )

fn new_from_ptr_with_scope( cx: &mut Cx, live_ptr: Option<LivePtr>, scope: &mut Scope<'_, '_>, ) -> Self

where Self: Sized,

fn new_main(cx: &mut Cx) -> Option<Self>

where Self: Sized,

fn register_main_module(cx: &mut Cx)

fn update_main(&mut self, cx: &mut Cx)

fn new_local(cx: &mut Cx) -> Self

where Self: Sized,

fn new_from_module( cx: &mut Cx, module_id: LiveModuleId, id: LiveId, ) -> Option<Self>

where Self: Sized,

fn update_from_module( &mut self, cx: &mut Cx, module_id: LiveModuleId, id: LiveId, )

impl LiveRegister for Button

fn live_register(cx: &mut Cx)

impl Widget for Button

fn set_disabled(&mut self, cx: &mut Cx, disabled: bool)

fn disabled(&self, cx: &Cx) -> bool

fn handle_event( &mut self, cx: &mut Cx, event: &Event, scope: &mut Scope<'_, '_>, )

fn draw_walk( &mut self, cx: &mut Cx2d<'_, '_>, _scope: &mut Scope<'_, '_>, walk: Walk, ) -> DrawStep

fn text(&self) -> String

fn set_text(&mut self, cx: &mut Cx, v: &str)

fn handle_event_with( &mut self, cx: &mut Cx, event: &Event, scope: &mut Scope<'_, '_>, _sweep_area: Area, )

fn widget(&self, path: &[LiveId]) -> WidgetRef

fn widgets(&self, paths: &[&[LiveId]]) -> WidgetSet

fn widget_uid(&self) -> WidgetUid

fn widget_to_data( &self, _cx: &mut Cx, _actions: &Actions, _nodes: &mut LiveNodeVec, _path: &[LiveId], ) -> bool

fn data_to_widget( &mut self, _cx: &mut Cx, _nodes: &[LiveNode], _path: &[LiveId], )

fn draw_3d( &mut self, _cx: &mut Cx3d<'_, '_>, _scope: &mut Scope<'_, '_>, ) -> DrawStep

fn draw_3d_all(&mut self, cx: &mut Cx3d<'_, '_>, scope: &mut Scope<'_, '_>)

fn draw(&mut self, cx: &mut Cx2d<'_, '_>, scope: &mut Scope<'_, '_>) -> DrawStep

fn draw_walk_all( &mut self, cx: &mut Cx2d<'_, '_>, scope: &mut Scope<'_, '_>, walk: Walk, )

fn draw_all(&mut self, cx: &mut Cx2d<'_, '_>, scope: &mut Scope<'_, '_>)

fn draw_unscoped(&mut self, cx: &mut Cx2d<'_, '_>) -> DrawStep

fn draw_all_unscoped(&mut self, cx: &mut Cx2d<'_, '_>)

fn set_key_focus(&self, cx: &mut Cx)

fn key_focus(&self, cx: &Cx) -> bool

fn ref_cast_type_id(&self) -> LiveType

where Self: 'static,

fn ui_runner(&self) -> UiRunner<Self>

where Self: Sized + 'static,

impl WidgetNode for Button

fn set_action_data(&mut self, action_data: Arc<dyn ActionTrait>)

fn action_data(&self) -> Option<Arc<dyn ActionTrait>>

fn visible(&self) -> bool

fn set_visible(&mut self, cx: &mut Cx, visible: bool)

fn area(&self) -> Area

fn walk(&mut self, _cx: &mut Cx) -> Walk

fn redraw(&mut self, cx: &mut Cx)

fn find_widgets( &self, path: &[LiveId], cached: WidgetCache, results: &mut WidgetSet, )

fn uid_to_widget(&self, uid: WidgetUid) -> WidgetRef

fn widget_design(&mut self) -> Option<&mut dyn WidgetDesign>