Struct kas::widget::ProgressBar

pub struct ProgressBar<D: Directional> { /* fields omitted */ }

A progress bar

The “progress” value may range from 0.0 to 1.0.

Implementations

impl<D: Directional + Default> ProgressBar<D>

pub fn new() -> Self

Construct a progress bar

The initial value is 0.0; use ProgressBar::with_value to override.

impl<D: Directional> ProgressBar<D>

pub fn new_with_direction(direction: D) -> Self

Construct a slider with the given direction

The initial value is 0.0; use ProgressBar::with_value to override.

pub fn with_value(self, value: f32) -> Self

Set the initial value

pub fn value(&self) -> f32

Get the current value

pub fn set_value(&mut self, value: f32) -> TkAction

Set the value

Returns TkAction::REDRAW if a redraw is required.

Trait Implementations

impl<D: Clone + Directional> Clone for ProgressBar<D>

fn clone(&self) -> ProgressBar<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Debug + Directional> Debug for ProgressBar<D>

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

Formats the value using the given formatter.

impl<D: Default + Directional> Default for ProgressBar<D>

fn default() -> ProgressBar<D>

Returns the “default value” for a type.

impl<D: Directional> Handler for ProgressBar<D>

type Msg = VoidMsg

Type of message returned by this widget

fn activation_via_press(&self) -> bool

Generic handler: translate presses to activations

fn handle(&mut self, mgr: &mut Manager<'_>, event: Event) -> Response<Self::Msg>

Handle an event and return a user-defined message

impl<D: Directional> Layout for ProgressBar<D>

fn size_rules(
    &mut self,
    size_handle: &mut dyn SizeHandle,
    axis: AxisInfo
) -> SizeRules

Get size rules for the given axis

fn draw(
    &self,
    draw_handle: &mut dyn DrawHandle,
    mgr: &ManagerState,
    disabled: bool
)

Draw a widget and its children

fn set_rect(&mut self, mgr: &mut Manager<'_>, rect: Rect, align: AlignHints)

Apply a given rect to self

fn translation(&self, _child_index: usize) -> Offset

Get translation of a child

fn spatial_nav(&self, reverse: bool, from: Option<usize>) -> Option<usize>

Navigation in spatial order

fn find_id(&self, coord: Coord) -> Option<WidgetId>

Find a widget by coordinate

impl<D: Directional> SendEvent for ProgressBar<D>

fn send(
    &mut self,
    mgr: &mut Manager<'_>,
    id: WidgetId,
    event: Event
) -> Response<Self::Msg>

Send an event

impl<D: Directional> WidgetChildren for ProgressBar<D>

fn first_id(&self) -> WidgetId

Get the first identifier of self or any children

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, _index: usize) -> Option<&dyn WidgetConfig>

Get a reference to a child widget by index, or None if the index is out of bounds.

fn get_child_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

Mutable variant of get

fn record_first_id(&mut self, _id: WidgetId)

Record first identifier

fn is_ancestor_of(&self, id: WidgetId) -> bool

Check whether id is a descendant

fn find_child(&self, id: WidgetId) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn find_leaf(&self, id: WidgetId) -> Option<&dyn WidgetConfig>

Find the leaf (lowest descendant) with this id, if any

fn find_leaf_mut(&mut self, id: WidgetId) -> Option<&mut dyn WidgetConfig>

Find the leaf (lowest descendant) with this id, if any

fn walk_children<F: FnMut(&dyn WidgetConfig)>(&self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

fn walk_children_mut<F: FnMut(&mut dyn WidgetConfig)>(&mut self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

impl<D: Directional> WidgetConfig for ProgressBar<D>

fn key_nav(&self) -> bool

Is this widget navigable via Tab key?

fn hover_highlight(&self) -> bool

Does this widget have hover-state highlighting?

fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

fn configure(&mut self, _: &mut Manager<'_>)

Configure widget

fn configure_recurse(&mut self, cmgr: ConfigureManager<'_, '_>)

Configure self and children

impl<D: Directional> WidgetCore for ProgressBar<D>

fn as_any(&self) -> &dyn Any

Get self as type Any

fn as_any_mut(&mut self) -> &mut dyn Any

Get self as type Any (mutable)

fn core_data(&self) -> &CoreData

Get direct access to the CoreData providing property storage.

fn core_data_mut(&mut self) -> &mut CoreData

fn widget_name(&self) -> &'static str

Get the name of the widget struct

fn as_widget(&self) -> &dyn WidgetConfig

Erase type

fn as_widget_mut(&mut self) -> &mut dyn WidgetConfig

Erase type

fn id(&self) -> WidgetId

Get the widget’s numeric identifier

fn is_disabled(&self) -> bool

Get whether the widget is disabled

fn set_disabled(&mut self, disabled: bool) -> TkAction

Set the disabled state of a widget

fn with_disabled(self, disabled: bool) -> Self where
    Self: Sized, 

Set disabled state (chaining)

fn rect(&self) -> Rect

Get the widget’s region, relative to its parent.

fn input_state(&self, mgr: &ManagerState, disabled: bool) -> InputState

Construct InputState

impl<D: Directional> Widget for ProgressBar<D>