wxsearchctrl

a search control is a composite control with a search button, a text control, and a cancel button.

derived from

wxtextctrl
streambuf
wxcontrol
wxwindow
wxevthandler
wxobject

include files

window styles

wxte_process_enter	the control will generate the event wxevt_command_text_enter (otherwise pressing enter key is either processed internally by the control or used for navigation between dialog controls).
wxte_process_tab	the control will receive wxevt_char events for tab pressed - normally, tab is used for passing to the next control in a dialog instead. for the control created with this style, you can still use ctrl-enter to pass to the next control from the keyboard.
wxte_nohidesel	by default, the windows text control doesn't show the selection when it doesn't have focus - use this style to force it to always show it. it doesn't do anything under other platforms.
wxte_left	the text in the control will be left-justified (default).
wxte_centre	the text in the control will be centered (currently wxmsw and wxgtk2 only).
wxte_right	the text in the control will be right-justified (currently wxmsw and wxgtk2 only).
wxte_capitalize	on pocketpc and smartphone, causes the first letter to be capitalized.

event handling

to process input from a search control, use these event handler macros to direct input to member functions that take a wxcommandevent argument. to retrieve actual search queries, use evt_text and evt_text_enter events, just as you would with wxtextctrl.

evt_searchctrl_search_btn(id, func)	respond to a wxevt_searchctrl_search_btn event, generated when the search button is clicked. note that this does not initiate a search.
evt_searchctrl_cancel_btn(id, func)	respond to a wxevt_searchctrl_cancel_btn event, generated when the cancel button is clicked.

members

wxsearchctrl::wxsearchctrl
wxsearchctrl::~wxsearchctrl
wxsearchctrl::setmenu
wxsearchctrl::getmenu
wxsearchctrl::showsearchbutton
wxsearchctrl::issearchbuttonvisible
wxsearchctrl::showcancelbutton
wxsearchctrl::iscancelbuttonvisible

wxsearchctrl::wxsearchctrl

wxsearchctrl()

default constructor.

wxsearchctrl(wxwindow* parent, wxwindowid id, const wxstring& value = "", const wxpoint& pos = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = 0, const wxvalidator& validator = wxdefaultvalidator, const wxstring& name = wxsearchctrlnamestr)

constructor, creating and showing a text control.

parameters

parent

parent window. should not be null.

control identifier. a value of -1 denotes a default value.

value

default text value.

pos

text control position.

size

text control size.

style

wxsearchctrl

validator

window validator.

name

window name.

see also

wxtextctrl::create, wxvalidator

wxsearchctrl::~wxsearchctrl

~wxsearchctrl()

destructor, destroying the search control.

wxsearchctrl::setmenu

virtual void setmenu(wxmenu* menu)

sets the search control's menu object. if there is already a menu associated with the search control it is deleted.

parameters

menu

menu to attach to the search control.

wxsearchctrl::getmenu

virtual wxmenu* getmenu()

returns a pointer to the search control's menu object or null if there is no menu attached.

wxsearchctrl::showsearchbutton

virtual void showsearchbutton(bool show)

sets the search button visibility value on the search control. if there is a menu attached, the search button will be visible regardless of the search button visibility value.

this has no effect in mac os x v10.3

wxsearchctrl::issearchbuttonvisible

virtual bool issearchbuttonvisible()

returns the search button visibility value. if there is a menu attached, the search button will be visible regardless of the search button visibility value.

this always returns false in mac os x v10.3

wxsearchctrl::showcancelbutton

virtual void showcancelbutton(bool show)

shows or hides the cancel button.

wxsearchctrl::iscancelbuttonvisible

virtual bool iscancelbuttonvisible()

indicates whether the cancel button is visible.