Struct cacao::progress::ProgressIndicator

pub struct ProgressIndicator {
    pub objc: ObjcProperty,
    pub top: LayoutAnchorY,
    pub leading: LayoutAnchorX,
    pub left: LayoutAnchorX,
    pub trailing: LayoutAnchorX,
    pub right: LayoutAnchorX,
    pub bottom: LayoutAnchorY,
    pub width: LayoutAnchorDimension,
    pub height: LayoutAnchorDimension,
    pub center_x: LayoutAnchorX,
    pub center_y: LayoutAnchorY,
}

A control used for reporting progress to a user visually.

Fields

objc: ObjcProperty

A pointer to the Objective-C Object.

top: LayoutAnchorY

A pointer to the Objective-C runtime top layout constraint.

leading: LayoutAnchorX

A pointer to the Objective-C runtime leading layout constraint.

left: LayoutAnchorX

A pointer to the Objective-C runtime left layout constraint.

trailing: LayoutAnchorX

A pointer to the Objective-C runtime trailing layout constraint.

right: LayoutAnchorX

A pointer to the Objective-C runtime right layout constraint.

bottom: LayoutAnchorY

A pointer to the Objective-C runtime bottom layout constraint.

width: LayoutAnchorDimension

A pointer to the Objective-C runtime width layout constraint.

height: LayoutAnchorDimension

A pointer to the Objective-C runtime height layout constraint.

center_x: LayoutAnchorX

A pointer to the Objective-C runtime center X layout constraint.

center_y: LayoutAnchorY

A pointer to the Objective-C runtime center Y layout constraint.

Implementations

impl ProgressIndicator

pub fn new() -> Self

Returns a default ProgressIndicator. You should retain this yourself for as long as you need it to stay around.

impl ProgressIndicator

pub fn start_animation(&self)

Starts the animation for an indeterminate indicator.

pub fn stop_animation(&self)

Stops any animations that are currently happening on this indicator (e.g, if it’s an indeterminate looping animation).

pub fn increment(&self, amount: f64)

Increment the progress indicator by the amount specified.

pub fn set_style(&self, style: ProgressIndicatorStyle)

Set the style for the progress indicator.

pub fn set_indeterminate(&self, is_indeterminate: bool)

Set whether this is an indeterminate indicator or not. Indeterminate indicators are “infinite” and their appearance is that of a circular spinner.

Invert this to go back to a bar appearance.

pub fn set_value(&self, value: f64)

Sets the value of this progress indicator.

If this progress indicator is indeterminate, this will have no effect.

pub fn set_hidden(&self, hidden: bool)

Set whether this control is hidden or not.

Trait Implementations

impl Debug for ProgressIndicator

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

Formats the value using the given formatter.

impl Default for ProgressIndicator

fn default() -> Self

Returns the “default value” for a type.

impl Drop for ProgressIndicator

fn drop(&mut self)

A bit of extra cleanup for delegate callback pointers. If the originating ProgressIndicator is being dropped, we do some logic to clean it all up (e.g, we go ahead and check to see if this has a superview (i.e, it’s in the heirarchy) on the Objective-C side. If it does, we go ahead and remove it - this is intended to match the semantics of how Rust handles things).

There are, thankfully, no delegates we need to break here.

impl Layout for ProgressIndicator

fn set_needs_display(&self, needs_display: bool)

Sets whether this needs to be redrawn before being displayed.

fn add_subview<V: Layout>(&self, view: &V)

Adds another Layout-backed control or view as a subview of this view.

fn remove_from_superview(&self)

Removes a control or view from the superview.

fn set_frame<R: Into<CGRect>>(&self, rect: R)

Sets the frame for the view this trait is applied to.

fn set_translates_autoresizing_mask_into_constraints(&self, translates: bool)

Sets whether the view for this trait should translate autoresizing masks into layout constraints.

fn set_hidden(&self, hide: bool)

Sets whether the view for this is hidden or not.

fn is_hidden(&self) -> bool

Returns whether this is hidden or not.

fn is_hidden_or_ancestor_is_hidden(&self) -> bool

Returns whether this is hidden, or whether an ancestor view is hidden.

fn register_for_dragged_types(&self, types: &[PasteboardType])

Register this view for drag and drop operations.

fn unregister_dragged_types(&self)

Unregisters this as a target for drag and drop operations.

fn set_posts_frame_change_notifications(&self, posts: bool)

Sets whether this posts notifications when the frame rectangle changes.

fn set_posts_bounds_change_notifications(&self, posts: bool)

Sets whether this posts notifications when the bounds rectangle changes.

fn set_alpha(&self, value: f64)

Theoretically this belongs elsewhere, but we want to enable this on all view layers, since it’s common enough anyway.