Struct orbtk_widgets::ToggleButton

pub struct ToggleButton { /* fields omitted */ }

The ToggleButton widget can be clicked by user and could switch between selected / not selected. It's used to perform an action.

style: toggle-button

Implementations

impl ToggleButton

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

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

impl ToggleButton

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 background<P: IntoPropertySource<Brush>>(self, background: P) -> Self

Sets or shares the background property.

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

Sets or shares the border radius property.

pub fn border_width<P: IntoPropertySource<Thickness>>(
    self,
    border_width: P
) -> Self

Sets or shares the border thickness property.

pub fn border_brush<P: IntoPropertySource<Brush>>(self, border_brush: P) -> Self

Sets or shares the border brush property.

pub fn padding<P: IntoPropertySource<Thickness>>(self, padding: P) -> Self

Sets or shares the padding property.

pub fn foreground<P: IntoPropertySource<Brush>>(self, foreground: P) -> Self

Sets or shares the foreground property.

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

Sets or shares the text property.

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

Sets or shares the font size property.

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

Sets or shares the font property.

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

Sets or shares the icon property.

pub fn icon_brush<P: IntoPropertySource<Brush>>(self, icon_brush: P) -> Self

Sets or shares the icon brush property.

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

Sets or shares the icon font size property.

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

Sets or shares the icon font property.

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

Sets or shares the pressed property.

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

Sets or shares the selected property.

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

Sets or shares the spacing between icon and text.

Trait Implementations

impl ChangedHandler for ToggleButton

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 ToggleButton

fn default() -> ToggleButton

Returns the "default value" for a type.

impl MouseHandler for ToggleButton

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

Inserts a click handler.

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

Insert a mouse down handler.

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

Insert a mouse up handler.

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

Insert a mouse handler for global up event.

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

Insert a mouse move handler.

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

Insert a mouse up handler.

impl Template for ToggleButton

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 ToggleButton

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.