Struct CheckBox

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

Available on crate feature gui only.

Native check box control, actually a variation of the ordinary Button: just a button with a specific style.

Implementations

impl CheckBox

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 on(&self) -> &ButtonEvents

Exposes the specific control events.

Panics

Panics if the control is already created. Events must be set before control creation.

impl CheckBox

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

Instantiates a new CheckBox 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 CheckBox in an event closure.

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

Instantiates a new CheckBox 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 CheckBox in an event closure.

pub fn is_checked(&self) -> bool

Sends a bm::GetCheck message and returns true if current state is co::BST::CHECKED.

pub fn set_check(&self, check: bool)

Sets or unsets the check mark by sending a bm::SetCheck message.

pub fn set_check_and_trigger(&self, check: bool) -> SysResult<()>

Sets the current check state by sending a bm::SetCheck message, then sends a wm::Command message to the parent, so it can handle the event.

pub fn set_state(&self, state: BST)

Sets the current check state by sending a bm::SetCheck message.

pub fn set_state_and_trigger(&self, state: BST) -> SysResult<()>

Sets the current check state by sending a bm::SetCheck message, then sends a wm::Command message to the parent, so it can handle the event.

pub fn set_text_and_resize(&self, text: &str) -> SysResult<()>

Calls HWND::SetWindowText to set the text and resizes the control to exactly fit it.

pub fn state(&self) -> BST

Retrieves the current check state by sending a bm::GetCheck message.

pub fn trigger_click(&self)

Fires the click event for the check box by sending a bm::Click message.

Trait Implementations

impl Clone for CheckBox

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 CheckBox

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 CheckBox

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 CheckBox