t3_widget::text_field_t Class Reference

Inheritance diagram for t3_widget::text_field_t:

Classes
class	drop_down_list_t
	Drop-down list implementation for text_field_t. More...
struct	implementation_t

Public Member Functions
virtual void	bad_draw_recheck (void)
const std::string *	get_text (void) const
	Retrieve the text shown by the text_field_t.
virtual void	hide (void)
virtual bool	is_hotkey (key_t key)
virtual bool	process_key (key_t key)
virtual bool	process_mouse_event (mouse_event_t event)
void	set_autocomplete (string_list_base_t *_completions)
	Set the autocompletion list.
virtual void	set_focus (focus_t _focus)
void	set_key_filter (key_t *keys, size_t nr_of_keys, bool accept)
	Set the list of keys to accept or reject.
void	set_label (smart_label_t *_label)
	Associate a label with this text_field_t.
virtual bool	set_size (optint height, optint width)
void	set_text (const std::string *text)
	Set the text of the text_field_t.
void	set_text (const char *text)
	Set the text of the text_field_t.
void	set_text (const char *text, size_t size)
	Set the text of the text_field_t.
virtual void	show (void)
	T3_WIDGET_SIGNAL (activate, void)
virtual void	update_contents (void)
Public Member Functions inherited from t3_widget::widget_t
virtual bool	accepts_focus (void)
	Query whether this widget accepts focus.
virtual void	force_redraw (void)
virtual void	hide (void)
virtual bool	is_enabled (void)
	Query the enabled status of this widget.
virtual bool	is_hotkey (key_t key)
	Query whether key is a hotkey for this widget.
virtual bool	is_shown (void)
	Query the visibility status of this widget.
virtual bool	process_mouse_event (mouse_event_t event)
	Process a mouse event.
virtual void	set_anchor (window_component_t *anchor, int relation)
	Set this widget's anchor.
virtual void	set_enabled (bool enable)
	Set the enabled status of this widget.
virtual void	set_focus (focus_t focus)
virtual void	set_position (optint top, optint left)
virtual void	show (void)
Public Member Functions inherited from t3_widget::window_component_t
virtual void	force_redraw (void)=0
	Request that this window_component_t be completely redrawn.
virtual t3_window_t *	get_base_window (void)
	Retrieve the t3_window_t for this window_component_t.
virtual void	hide (void)=0
	Hide the window_component_t.
virtual bool	process_key (key_t key)=0
	Handle a key press by the user.
virtual void	set_focus (focus_t focus)=0
	Set whether this window_component_t has the input focus.
virtual void	set_position (optint top, optint left)=0
	Move the window_component_t to a specified position.
virtual bool	set_size (optint height, optint width)=0
	Set the size of this window_component_t.
virtual void	show (void)=0
	Display the window_component_t.
virtual void	update_contents (void)=0
	Update the contents of the window.
	window_component_t (void)
	Base constructor.
virtual	~window_component_t (void)
	Base destructor.
Public Member Functions inherited from t3_widget::mouse_target_t
void	grab_mouse (void)
	Grab all future mouse events.
void	register_mouse_target (t3_window_t *target)
	Register a window to receive mouse events.
void	release_mouse_grab (void)
	Release a previous mouse grab.
void	unregister_mouse_target (t3_window_t *target)
	Unregister a window to receive mouse events.
Public Member Functions inherited from t3_widget::center_component_t
	center_component_t (void)
	Create a new center_component_t.
virtual void	set_center_window (window_component_t *_center_window)
	Set the window_component_t to center over.
Public Member Functions inherited from t3_widget::bad_draw_recheck_t
virtual void	bad_draw_recheck (void)=0
	Function called on reception of the terminal_settings_changed signal.
	bad_draw_recheck_t (void)
	Base constructor.
virtual	~bad_draw_recheck_t (void)
	Base destructor.

Protected Member Functions
bool	has_focus (void) const
Protected Member Functions inherited from t3_widget::widget_t
void	init_unbacked_window (int height, int width, bool register_as_mouse_target=false)
	Initialize the window with an unbacked t3_window_t with height and width.
void	init_window (int height, int width, bool register_as_mouse_target=true)
	Initialize the window with a t3_window_t with height and width.
	widget_t (int height, int width, bool register_as_mouse_target=true)
	Constructor which creates a default t3_window_t with height and width.
	widget_t (void)
	Constructor which does not create a default t3_window_t.
Protected Member Functions inherited from t3_widget::mouse_target_t
	mouse_target_t (bool use_window=true)

Additional Inherited Members
Public Types inherited from t3_widget::window_component_t
enum	focus_t {   FOCUS_OUT, FOCUS_SET, FOCUS_IN_FWD, FOCUS_IN_BCK,   FOCUS_REVERT }
Static Public Member Functions inherited from t3_widget::mouse_target_t
static bool	handle_mouse_event (mouse_event_t event)
Protected Attributes inherited from t3_widget::widget_t
bool	enabled
	Widget is enabled.
bool	redraw
	Widget requires redrawing on next update_contents call.
bool	shown
	Widget is shown.
Protected Attributes inherited from t3_widget::center_component_t
window_component_t *	center_window
	The window_component_t to center over.

Member Function Documentation

const string * t3_widget::text_field_t::get_text

(

void

)

const

Retrieve the text shown by the text_field_t.

void t3_widget::text_field_t::set_autocomplete

(

string_list_base_t *

_completions

)

Set the autocompletion list.

void t3_widget::text_field_t::set_key_filter	(	key_t *	keys,
		size_t	nr_of_keys,
		bool	accept
	)

Set the list of keys to accept or reject.

Parameters

keys	The list of keys to accept or reject.
nr_of_keys	The size of keys.
accept	Boolean indicating whether the keys in keys should be accepted or rejected.

void t3_widget::text_field_t::set_label

(

smart_label_t *

_label

)

Associate a label with this text_field_t.

The reason to associate a smart_label_t with a text_field_t is that it allows the use of a hotkey to jump to the text_field_t. The #is_hotkey function will report the result of smart_label_t::is_hotkey.

void t3_widget::text_field_t::set_text

(

const std::string *

text

)

Set the text of the text_field_t.

void t3_widget::text_field_t::set_text

(

const char *

text

)

Set the text of the text_field_t.

void t3_widget::text_field_t::set_text	(	const char *	text,
		size_t	size
	)

Set the text of the text_field_t.