Struct Edit

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

Available on crate feature gui only.

Native edit (text box) control.

Implementations

impl Edit

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 specific control events.

Panics

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

impl Edit

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

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

Examples

use winsafe::{self as w, prelude::*, gui};

let wnd: gui::WindowMain; // initialized somewhere

let txt = gui::Edit::new(
    &wnd,
    gui::EditOpts {
        position: gui::dpi(10, 10),
        width: gui::dpi_x(120),
        ..Default::default()
    },
);

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

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

pub fn hide_balloon_tip(&self) -> SysResult<()>

Hides any balloon tip by sending an em::HideBalloonTip message.

pub fn limit_text(&self, max_chars: Option<u32>)

Limits the number of characters that can be type by sending an em::SetLimitText message.

pub fn set_selection(&self, start: i32, end: i32)

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

Examples

Selecting all text in the control:

use winsafe::{self as w, prelude::*, gui};

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

my_edit.set_selection(0, -1);

Clearing the selection:

use winsafe::gui;

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

my_edit.set_selection(-1, -1);

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

Sets the text by calling HWND::SetWindowText.

pub fn show_ballon_tip( &self, title: &str, text: &str, icon: TTI, ) -> SysResult<()>

Displays a balloon tip by sending an em::ShowBalloonTip message.

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

Retrieves the text by calling HWND::GetWindowText.

Trait Implementations

impl Clone for Edit

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 Edit

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 Edit

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 Edit