Struct winsafe::gui::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 new(parent: &impl GuiParent, 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, 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 check_state(&self) -> CheckState

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

pub fn emulate_click(&self)

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

pub fn is_checked(&self) -> bool

Calls check_state and compares the result with CheckState::Checked.

pub fn set_check_state(&self, state: CheckState)

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

pub fn set_check_state_and_trigger(&self, state: CheckState)

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)

Calls set_text and resizes the control to exactly fit the new text.

Trait Implementations

impl Clone for CheckBox

fn clone(&self) -> CheckBox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl GuiChild for CheckBox

fn ctrl_id(&self) -> u16

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

impl GuiChildFocus for CheckBox

fn focus(&self)

In a raw, ordinary window, simply calls HWND:SetFocus.

impl GuiNativeControl for CheckBox

fn on_subclass(&self) -> &WindowEvents

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

impl GuiNativeControlEvents<ButtonEvents> for CheckBox

fn on(&self) -> &ButtonEvents

Exposes the specific control events.

impl GuiWindow for CheckBox

fn hwnd(&self) -> &HWND

Returns the underlying handle for this control.

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 GuiWindowText for CheckBox

fn set_text(&self, text: &str)

Sets the text by calling HWND::SetWindowText.

fn text(&self) -> String

Retrieves the text by calling HWND::GetWindowText.

impl Send for CheckBox