Struct winsafe::gui::Edit

pub struct Edit(_);

Native edit control.

Implements Child trait.

Implementations

impl Edit

pub fn new(parent: &dyn Parent, opts: EditOpts) -> Edit

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

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

Instantiates a new Edit 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 focus(&self) -> WinResult<()>

Focuses the control by sending a wm::NextDlgCtl message.

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) -> &EditEvents

Exposes the control events.

These event methods are just proxies to the WindowEvents of the parent window, who is the real responsible for the child event handling.

Panics

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

pub fn set_selection(&self, start: Option<u32>, end: Option<u32>)

Sets the selection range of the text by sending an em::SetSel message.

Examples

Selecting all text in the control:

use winsafe::gui;

let my_edit: gui::Edit; // initialized somewhere

my_edit.set_selection(Some(0), None);

Clearing the selection:

use winsafe::gui;

let my_edit: gui::Edit; // initialized somewhere

my_edit.set_selection(None, None);

pub fn set_text(&self, text: &str) -> WinResult<()>

Sets the text in the control by calling SetWindowText.

Examples

use winsafe::gui;

let my_edit: gui::Edit; // initialized somewhere

my_edit.set_text("This my text")?;

pub fn text(&self) -> WinResult<String>

Retrieves the text in the control by calling HWND::GetWindowText.

use winsafe::gui;

let my_edit: gui::Edit; // initialized somewhere

println!("The text is: {}", my_edit.text()?);

Trait Implementations

impl Child for Edit

fn hwnd_ref(&self) -> &HWND

Returns a reference to the HWND of the child control.

impl Clone for Edit

fn clone(&self) -> Edit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Edit

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

Formats the value using the given formatter.

impl Send for Edit

impl Sync for Edit