git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: srchctrl.h
	3	// Purpose: documentation for wxSearchCtrl class
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows license
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10	@class wxSearchCtrl
	11	@wxheader{srchctrl.h}
	12
	13	A search control is a composite control with a search button, a text
	14	control, and a cancel button.
	15
	16	@beginStyleTable
	17	@style{wxTE_PROCESS_ENTER}:
	18	The control will generate the event wxEVT_COMMAND_TEXT_ENTER
	19	(otherwise pressing Enter key is either processed internally by the
	20	control or used for navigation between dialog controls).
	21	@style{wxTE_PROCESS_TAB}:
	22	The control will receive wxEVT_CHAR events for TAB pressed -
	23	normally, TAB is used for passing to the next control in a dialog
	24	instead. For the control created with this style, you can still use
	25	Ctrl-Enter to pass to the next control from the keyboard.
	26	@style{wxTE_NOHIDESEL}:
	27	By default, the Windows text control doesn't show the selection
	28	when it doesn't have focus - use this style to force it to always
	29	show it. It doesn't do anything under other platforms.
	30	@style{wxTE_LEFT}:
	31	The text in the control will be left-justified (default).
	32	@style{wxTE_CENTRE}:
	33	The text in the control will be centered (currently wxMSW and
	34	wxGTK2 only).
	35	@style{wxTE_RIGHT}:
	36	The text in the control will be right-justified (currently wxMSW
	37	and wxGTK2 only).
	38	@style{wxTE_CAPITALIZE}:
	39	On PocketPC and Smartphone, causes the first letter to be
	40	capitalized.
	41	@endStyleTable
	42
	43	@library{wxcore}
	44	@category{FIXME}
	45
	46	@seealso
	47	wxTextCtrl::Create, wxValidator
	48	*/
	49	class wxSearchCtrl : public wxTextCtrl
	50	{
	51	public:
	52	//@{
	53	/**
	54	Constructor, creating and showing a text control.
	55
	56	@param parent
	57	Parent window. Should not be @NULL.
	58
	59	@param id
	60	Control identifier. A value of -1 denotes a default value.
	61
	62	@param value
	63	Default text value.
	64
	65	@param pos
	66	Text control position.
	67
	68	@param size
	69	Text control size.
	70
	71	@param style
	72	Window style. See wxSearchCtrl.
	73
	74	@param validator
	75	Window validator.
	76
	77	@param name
	78	Window name.
	79
	80	@sa wxTextCtrl::Create, wxValidator
	81	*/
	82	wxSearchCtrl();
	83	wxSearchCtrl(wxWindow* parent, wxWindowID id,
	84	const wxString& value = "",
	85	const wxPoint& pos = wxDefaultPosition,
	86	const wxSize& size = wxDefaultSize,
	87	long style = 0,
	88	const wxValidator& validator = wxDefaultValidator,
	89	const wxString& name = wxSearchCtrlNameStr);
	90	//@}
	91
	92	/**
	93	Destructor, destroying the search control.
	94	*/
	95	~wxSearchCtrl();
	96
	97	/**
	98	Returns a pointer to the search control's menu object or @NULL if there is no
	99	menu attached.
	100	*/
	101	virtual wxMenu* GetMenu();
	102
	103	/**
	104	Returns the search button visibility value.
	105	If there is a menu attached, the search button will be visible regardless of
	106	the search
	107	button visibility value.
	108
	109	This always returns @false in Mac OS X v10.3
	110	*/
	111	virtual bool IsSearchButtonVisible();
	112
	113	/**
	114	Sets the search control's menu object. If there is already a menu associated
	115	with
	116	the search control it is deleted.
	117
	118	@param menu
	119	Menu to attach to the search control.
	120	*/
	121	virtual void SetMenu(wxMenu* menu);
	122
	123	/**
	124	Shows or hides the cancel button.
	125	*/
	126	virtual void ShowCancelButton(bool show);
	127
	128	/**
	129	Sets the search button visibility value on the search control.
	130	If there is a menu attached, the search button will be visible regardless of
	131	the search
	132	button visibility value.
	133
	134	This has no effect in Mac OS X v10.3
	135	*/
	136	virtual void ShowSearchButton(bool show);
	137	};