Struct SearchCtrl 

pub struct SearchCtrl { /* private fields */ }

Represents a wxSearchCtrl widget.

SearchCtrl uses WindowHandle internally for safe memory management. When the underlying window is destroyed (by calling destroy() or when its parent is destroyed), the handle becomes invalid and all operations become safe no-ops.

Example

let search = SearchCtrl::builder(&frame).value("Search...").build();

// SearchCtrl is Copy - no clone needed for closures!
search.bind_search_button_clicked(move |_| {
    // Safe: if search was destroyed, this is a no-op
    let query = search.get_value();
    println!("Searching for: {}", query);
});

// After parent destruction, search operations are safe no-ops
frame.destroy();
assert!(!search.is_valid());

Implementations

impl SearchCtrl

pub fn builder(parent: &dyn WxWidget) -> SearchCtrlBuilder<'_>

Creates a new SearchCtrl builder.

pub fn show_search_button(&self, show: bool)

Shows or hides the search button. No-op if the control has been destroyed.

pub fn is_search_button_visible(&self) -> bool

Returns whether the search button is visible. Returns false if the control has been destroyed.

pub fn show_cancel_button(&self, show: bool)

Shows or hides the cancel button. No-op if the control has been destroyed.

pub fn is_cancel_button_visible(&self) -> bool

Returns whether the cancel button is visible. Returns false if the control has been destroyed.

pub fn set_value(&self, value: &str)

Sets the text value of the control. No-op if the control has been destroyed.

pub fn get_value(&self) -> String

Gets the current text value of the control. Returns empty string if the control has been destroyed.

pub fn window_handle(&self) -> WindowHandle

Returns the underlying WindowHandle for this searchctrl.

impl SearchCtrl

pub fn on_search_button_clicked<F>(&self, callback: F) -> EventToken

where F: FnMut(SearchCtrlEventData) + 'static,

Binds a handler to a widget-specific event. Returns an EventToken that can be used to unbind the handler later.

pub fn on_cancel_button_clicked<F>(&self, callback: F) -> EventToken

where F: FnMut(SearchCtrlEventData) + 'static,

Binds a handler to a widget-specific event. Returns an EventToken that can be used to unbind the handler later.

Trait Implementations

impl Clone for SearchCtrl

fn clone(&self) -> SearchCtrl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SearchCtrl

impl FromWindowWithClassName for SearchCtrl

fn class_name() -> &'static str

Returns the expected wxWidgets class name for this widget type

unsafe fn from_ptr(ptr: *mut wxd_Window_t) -> Self

Safely construct this widget from a raw window pointer This should only be called after verifying the class name matches

impl TextEvents for SearchCtrl

fn on_text_updated<F>(&self, callback: F) -> EventToken

where F: FnMut(TextEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_enter_pressed<F>(&self, callback: F) -> EventToken

where F: FnMut(TextEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

impl WindowEvents for SearchCtrl

fn on_mouse_left_down<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_mouse_left_up<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_mouse_right_down<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_mouse_right_up<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_mouse_middle_down<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_mouse_middle_up<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_mouse_motion<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_mouse_wheel<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_mouse_enter<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_mouse_leave<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_key_down<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_key_up<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_char<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_size<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_move_event<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_paint<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_erase_background<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_set_focus<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_kill_focus<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_activate<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_idle<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_close<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

fn on_destroy<F>(&self, callback: F) -> EventToken

where F: FnMut(WindowEventData) + 'static,

Binds a handler to a category-specific event. Returns an EventToken that can be used to unbind the handler later.

impl WxEvtHandler for SearchCtrl

unsafe fn get_event_handler_ptr(&self) -> *mut wxd_EvtHandler_t

Returns the raw event handler pointer for this widget.

fn unbind(&self, token: EventToken) -> bool

Unbind a specific event handler by token.

fn unbind_all(&self) -> usize

Unbind all event handlers currently attached to this handler.

impl WxWidget for SearchCtrl

fn handle_ptr(&self) -> *mut wxd_Window_t

Returns the raw underlying window pointer. Unsafe because the lifetime is not tied to self. Primarily for internal use or passing back to FFI.

fn is_valid(&self) -> bool

Check if this widget is still valid (not destroyed).

fn get_id(&self) -> i32

Returns the window ID for this widget.

fn fit(&self)

Adjusts the window size to fit its contents or its sizer.

fn layout(&self)

Forces the window to recalculate its layout using its sizer. This is called when the window size changes to update the positions and sizes of child widgets according to the sizer constraints.

fn get_best_size(&self) -> Size

Gets the window’s sizer-calculated best size.

fn show(&self, show: bool)

Shows or hides the widget.

fn set_background_color(&self, color: Colour)

Sets the window’s background color.

fn set_background_style(&self, style: BackgroundStyle)

Sets the background style for the window.

fn get_background_style(&self) -> BackgroundStyle

Gets the background style for the window.

fn set_min_size(&self, size: Size)

Sets the window’s minimum size.

fn refresh(&self, erase_background: bool, rect: Option<&Rect>)

Refreshes the window, optionally erasing the background and specifying a rectangle.

fn update(&self)

Repaints all invalid areas of the window immediately.

fn set_tooltip(&self, tip: &str)

Sets the tooltip string for this widget.

fn destroy(&self)

Explicitly destroys the underlying wxWidgets object. After calling this, the widget wrapper should not be used further. This is useful for dynamically creating and destroying widgets.

fn set_font(&self, font: &Font)

fn get_font(&self) -> Option<Font>

Gets the font currently used for this widget.

fn get_sizer(&self) -> Option<Sizer>

Gets the sizer currently assigned to this widget.

fn set_sizer(&self, sizer: impl WxSizer, delete_old_sizer: bool)

where Self: Sized,

Sets the window’s sizer.

fn set_sizer_and_fit(&self, sizer: impl WxSizer, delete_old_sizer: bool)

where Self: Sized,

Sets the window’s sizer and calls Fit() on the window.

fn enable(&self, enable: bool)

Enables or disables the widget.

fn is_enabled(&self) -> bool

Returns true if the widget is enabled, false otherwise.

fn get_position(&self) -> Point

Gets the window’s position relative to its parent.

fn get_size(&self) -> Size

Gets the window’s size.

fn set_size(&self, size: Size)

Sets the window’s size.

fn set_size_with_pos(&self, x: i32, y: i32, width: i32, height: i32)

Sets the window’s position and size.

fn set_client_size(&self, size: Size)

Sets the window’s client area size (the area inside borders, scrollbars, etc).

fn get_client_size(&self) -> Size

Gets the client area size.

fn get_min_size(&self) -> Size

Gets the window’s minimum size.

fn move_window(&self, x: i32, y: i32)

Moves the window to the specified position.

fn center(&self)

Centers the window relative to its parent.

fn centre(&self)

UK spelling alias for center()

fn client_to_screen(&self, pt: Point) -> Point

Converts client coordinates to screen coordinates.

fn screen_to_client(&self, pt: Point) -> Point

Converts screen coordinates to client coordinates.

fn get_label(&self) -> Option<String>

Gets the window label (title or text). Returns None if the label is not set, cannot be converted to UTF-8, or an error occurs.

fn set_label(&self, label: &str)

Sets the window label (title or text).

fn set_extra_style(&self, extra_style: ExtraWindowStyle)

Sets the extra window style flags.

fn set_extra_style_raw(&self, extra_style: i64)

Sets extra window style flags using raw i64 value.

fn get_extra_style_raw(&self) -> i64

Gets the current extra window style flags as raw value.

fn has_extra_style(&self, style: ExtraWindowStyle) -> bool

Checks if a specific extra window style flag is set.

fn add_extra_style(&self, style: ExtraWindowStyle)

Adds extra window style flags to the current set.

fn remove_extra_style(&self, style: ExtraWindowStyle)

Removes extra window style flags from the current set.

fn get_parent(&self) -> Option<Window>

Gets the parent window of this widget.

fn set_foreground_color(&self, color: Colour)

Sets the foreground color of the window.

fn get_foreground_color(&self) -> Colour

Gets the foreground color of the window.

fn get_background_color(&self) -> Colour

Gets the background color of the window.

fn set_focus(&self)

Sets the focus to this window.

fn has_focus(&self) -> bool

Returns true if this window currently has focus.

fn can_accept_focus(&self) -> bool

Returns true if this window can accept focus.

fn accepts_focus_from_keyboard(&self) -> bool

Returns true if this window accepts focus from keyboard navigation.

fn set_can_focus(&self, can_focus: bool)

Sets whether this window can accept focus.

fn is_shown(&self) -> bool

Returns true if the window is currently shown.

fn hide(&self)

Hides the window.

fn set_max_size(&self, size: Size)

Sets the maximum size for the window.

fn get_max_size(&self) -> Size

Gets the maximum size for the window.

fn set_name(&self, name: &str)

Sets the window name.

fn get_name(&self) -> String

Gets the window name.

fn close(&self, force: bool) -> bool

Attempts to close the window.

fn find_window_by_name(&self, name: &str) -> Option<Window>

Finds a child window by name.

fn find_window_by_id(&self, id: i32) -> Option<Window>

Finds a child window by ID.

fn set_cursor(&self, cursor: Option<&Cursor>)

Sets the cursor for this window.

fn get_cursor(&self) -> Option<Cursor>

Gets the cursor currently associated with this window.

fn raise(&self)

Raises the window to the top of the window hierarchy (Z-order).

fn lower(&self)

Lowers the window to the bottom of the window hierarchy (Z-order).

fn capture_mouse(&self)

Directs all mouse input to this window.

fn release_mouse(&self)

Releases mouse capture.

fn has_capture(&self) -> bool

Returns true if this window currently has mouse capture.

fn get_capture() -> Option<Window>

where Self: Sized,

Returns the window that currently has mouse capture.

fn freeze(&self)

Freeze the window: don’t redraw it until it is thawed

fn thaw(&self)

Thaw the window: redraw it after it had been frozen

fn is_frozen(&self) -> bool

Return true if window had been frozen and not unthawed yet

fn get_text_extent(&self, text: &str) -> Size

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

fn get_full_text_extent( &self, text: &str, font: Option<&Font>, ) -> (Size, i32, i32)

Gets the full dimensions of the string as it would be drawn on the window.

fn get_char_height(&self) -> i32

Returns the character height for this window using the current font.

fn get_char_width(&self) -> i32

Returns the average character width for this window using the current font.

fn set_style(&self, style: WindowStyle)

Sets the window style flags.

fn set_style_raw(&self, style: i64)

Sets window style flags using raw i64 value.

fn get_style_raw(&self) -> i64

Gets the current window style flags as raw value.

fn has_style(&self, style: WindowStyle) -> bool

Checks if a specific window style flag is set.

fn add_style(&self, style: WindowStyle)

Adds window style flags to the current set.

fn remove_style(&self, style: WindowStyle)

Removes window style flags from the current set.

fn get_handle(&self) -> *mut c_void

Gets the native handle of the window (platform-specific).

fn move_after_in_tab_order(&self, win: &dyn WxWidget)

Moves this window to appear after the specified window in the tab order.

fn move_before_in_tab_order(&self, win: &dyn WxWidget)

Moves this window to appear before the specified window in the tab order.

fn get_next_sibling(&self) -> Option<Window>

Gets the next sibling window in the parent’s child list.

fn get_prev_sibling(&self) -> Option<Window>

Gets the previous sibling window in the parent’s child list.

fn navigate(&self, forward: bool) -> bool

Navigates to the next or previous control.

fn popup_menu(&self, menu: &mut Menu, screen_pos: Option<Point>) -> bool

Shows a popup menu at the specified position or at the current mouse position.

fn process_menu_command(&self, id: i32) -> bool

Synchronously dispatch a wxEVT_MENU with the given command ID to this window. Returns true if any handler processed the event.

fn post_menu_command(&self, id: i32)

Asynchronously post a wxEVT_MENU with the given command ID to this window. The event will be queued and delivered later by the main loop.

fn set_accessible(&self, accessible: Accessible)

Sets the accessible object for this window.

fn get_accessible(&self) -> Option<Accessible>

Gets the accessible object for this window.

impl XrcSupport for SearchCtrl

Available on crate feature xrc only.

unsafe fn from_xrc_ptr(ptr: *mut wxd_Window_t) -> Self

Creates a widget wrapper for an XRC-managed object. This widget will not be destroyed when dropped as it’s managed by XRC. Each widget implements this with their specific field structure.