Struct ProgressBar

pub struct ProgressBar(/* private fields */);

Available on crate feature gui only.

Native progress bar control.

Implementations

impl ProgressBar

pub fn on_subclass(&self) -> &WindowEvents

Exposes the subclass events. If at least one event exists, the control will be subclassed.

Note: Subclassing may impact performance, use with care.

Panics

Panics if the control or the parent window are already created. Events must be set before control and parent window creation.

impl ProgressBar

pub fn new(parent: &(impl GuiParent + 'static), opts: ProgressBarOpts) -> Self

Instantiates a new ProgressBar object, to be created on the parent window with HWND::CreateWindowEx.

Panics

Panics if the parent window was already created – that is, you cannot dynamically create a ProgressBar in an event closure.

pub fn new_dlg( parent: &(impl GuiParent + 'static), ctrl_id: u16, resize_behavior: (Horz, Vert), ) -> Self

Instantiates a new ProgressBar object, to be loaded from a dialog resource with HWND::GetDlgItem.

Panics

Panics if the parent dialog was already created – that is, you cannot dynamically create a ProgressBar in an event closure.

pub fn position(&self) -> u32

Retrieves the current position by sending a pbm::GetPos message.

pub fn range(&self) -> (u32, u32)

Retrieves the current minimum and maximum values by sending a pbm::GetRange message. Default values are 0 and 100.

pub fn set_marquee(&self, marquee: bool)

Sets or unsets the marquee mode by sending a pbm::SetMarquee message combined with a SetWindowLongPtr call for a style change.

pub fn set_position(&self, position: u32) -> u32

Sets the current position by sending a pbm::SetPos message, returning the previous position.

pub fn set_range(&self, min: u32, max: u32)

Sets the minimum and maximum values by sending a pbm::SetRange32 message. Default values are 0 and 100.

pub fn set_state(&self, state: PBST) -> PBST

Sets the current state by sending a pbm::SetState message, retuning the previous state.

pub fn state(&self) -> PBST

Retrieves the current state by sending a pbm::GetState message.

Trait Implementations

impl Clone for ProgressBar

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl GuiControl for ProgressBar

fn ctrl_id(&self) -> u16

Returns the control ID, which is defined at control creation.

fn focus(&self) -> SysResult<()>

If the control belongs to an ordinary window, simply calls HWND:SetFocus.

impl GuiWindow for ProgressBar

fn hwnd(&self) -> &HWND

Returns the underlying handle for this window.

fn as_any(&self) -> &dyn Any

Converts a reference to the Any trait. This is useful when storing a collection of polymorphic controls, because Any allows downcasting.

impl Send for ProgressBar