Struct winsafe::gui::ProgressBar

pub struct ProgressBar(_);

Native progress bar control.

Implements Child trait.

Implementations

impl ProgressBar

pub fn new(parent: &dyn Parent, opts: ProgressBarOpts) -> ProgressBar

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

pub fn new_dlg(parent: &dyn Parent, ctrl_id: u16) -> ProgressBar

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

pub fn hwnd(&self) -> HWND

Returns the underlying handle for this control.

Note: the handle is initially null, receiving an actual value only after the control is physically created, what usually happens right before WM_CREATE or WM_INITDIALOG events.

pub fn ctrl_id(&self) -> u16

Returns the control ID.

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.

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 Child for ProgressBar

fn hwnd_ref(&self) -> &HWND

Returns a reference to the HWND of the child control.

impl Clone for ProgressBar

fn clone(&self) -> ProgressBar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressBar

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

Formats the value using the given formatter.

impl Send for ProgressBar

impl Sync for ProgressBar