Struct winsafe::gui::Edit

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

Available on crate feature gui only.

Native edit control.

Implementations

impl Edit

pub fn new(parent: &impl GuiParent, 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: (10, 10),
        width: 120,
        ..Default::default()
    },
);

pub fn new_dlg( parent: &impl GuiParent, 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)

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

pub fn iter_lines<'a>(&'a self) -> impl Iterator<Item = String> + 'a

Returns an iterator over the lines in the Edit.

Examples

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

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

for line in my_edit.iter_lines() {
    println!("{}", line);
}

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 line_count(&self) -> u32

Returns the number of lines by sending an em::GetLineCount message.

pub fn set_font(&self, font: &HFONT)

Sets the font to the Edit by sending an wm::SetFont message.

Note that the font must remain alive while being used in the control.

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 show_ballon_tip(&self, title: &str, text: &str, icon: TTI)

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

Trait Implementations

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 GuiChild for Edit

fn ctrl_id(&self) -> u16

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

impl GuiChildFocus for Edit

fn focus(&self)

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

impl GuiNativeControl for Edit

fn on_subclass(&self) -> &WindowEvents

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

impl GuiNativeControlEvents<EditEvents> for Edit

fn on(&self) -> &EditEvents

Exposes the specific control events.

impl GuiWindow for Edit

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 Edit

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 Edit