Inheritance diagram for t3_widget::text_field_t:

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

Public Member Functions
virtual void	bad_draw_recheck (void)
	Function called on reception of the `terminal_settings_changed` signal. More...

const std::string *	get_text (void) const
	Retrieve the text shown by the text_field_t. More...

virtual void	hide (void)
	Hide the window_component_t. More...

virtual bool	is_hotkey (key_t key)
	Query whether key is a hotkey for this widget. More...

virtual bool	process_key (key_t key)
	Handle a key press by the user. More...

virtual bool	process_mouse_event (mouse_event_t event)
	Process a mouse event. More...

void	set_autocomplete (string_list_base_t *_completions)
	Set the autocompletion list. More...

virtual void	set_focus (focus_t _focus)
	Set whether this window_component_t has the input focus. More...

void	set_key_filter (key_t *keys, size_t nr_of_keys, bool accept)
	Set the list of keys to accept or reject. More...

void	set_label (smart_label_t *_label)
	Associate a label with this text_field_t. More...

virtual bool	set_size (optint height, optint width)
	Set the size of this window_component_t. More...

void	set_text (const std::string *text)
	Set the text of the text_field_t. More...

void	set_text (const char *text)
	Set the text of the text_field_t. More...

void	set_text (const char *text, size_t size)
	Set the text of the text_field_t. More...

virtual void	show (void)
	Display the window_component_t. More...

	T3_WIDGET_SIGNAL (activate, void)

virtual void	update_contents (void)
	Update the contents of the window. More...

Public Member Functions inherited from t3_widget::widget_t
virtual bool	accepts_focus (void)
	Query whether this widget accepts focus. More...

virtual void	force_redraw (void)
	Request that this window_component_t be completely redrawn. More...

virtual bool	is_enabled (void)
	Query the enabled status of this widget. More...

virtual bool	is_shown (void)
	Query the visibility status of this widget. More...

virtual void	set_anchor (window_component_t *anchor, int relation)
	Set this widget's anchor. More...

virtual void	set_enabled (bool enable)
	Set the enabled status of this widget. More...

virtual void	set_position (optint top, optint left)
	Move the window_component_t to a specified position. More...

Public Member Functions inherited from t3_widget::window_component_t
virtual t3_window_t *	get_base_window (void)
	Retrieve the t3_window_t for this window_component_t. More...

	window_component_t (void)
	Base constructor. More...

virtual	~window_component_t (void)
	Base destructor. More...

Public Member Functions inherited from t3_widget::mouse_target_t
void	grab_mouse (void)
	Grab all future mouse events. More...

void	register_mouse_target (t3_window_t *target)
	Register a window to receive mouse events. More...

void	release_mouse_grab (void)
	Release a previous mouse grab. More...

void	unregister_mouse_target (t3_window_t *target)
	Unregister a window to receive mouse events. More...

Public Member Functions inherited from t3_widget::center_component_t
	center_component_t (void)
	Create a new center_component_t. More...

virtual void	set_center_window (window_component_t *_center_window)
	Set the window_component_t to center over. More...

Public Member Functions inherited from t3_widget::bad_draw_recheck_t
	bad_draw_recheck_t (void)
	Base constructor. More...

virtual	~bad_draw_recheck_t (void)
	Base destructor. More...

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`. More...

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`. More...

	widget_t (int height, int width, bool register_as_mouse_target=true)
	Constructor which creates a default `t3_window_t` with `height` and `width`. More...

	widget_t (void)
	Constructor which does not create a default t3_window_t. More...

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. More...

bool	redraw
	Widget requires redrawing on next update_contents call. More...

bool	shown
	Widget is shown. More...

Protected Attributes inherited from t3_widget::window_component_t
cleanup_t3_window_ptr	window
	The t3_window_t used for presenting this item on screen (see libt3window). More...

Protected Attributes inherited from t3_widget::center_component_t
window_component_t *	center_window
	The window_component_t to center over. More...

Member Function Documentation

void t3_widget::text_field_t::bad_draw_recheck ( void )

virtual

Function called on reception of the terminal_settings_changed signal.

Implements t3_widget::bad_draw_recheck_t.

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::hide ( void )

virtual

Hide the window_component_t.

Reimplemented from t3_widget::widget_t.

bool t3_widget::text_field_t::is_hotkey ( key_t key )

virtual

Query whether key is a hotkey for this widget.

Reimplemented from t3_widget::widget_t.

bool t3_widget::text_field_t::process_key ( key_t key )

virtual

Handle a key press by the user.

Returns: A boolean indicating whether this window_component_t handled the key press.

Implements t3_widget::window_component_t.

bool t3_widget::text_field_t::process_mouse_event ( mouse_event_t event )

virtual

Process a mouse event.

Returns: A boolean indicating whether this mouse_target_t handled the mouse event.

Reimplemented from t3_widget::widget_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_focus ( focus_t focus )

virtual

Set whether this window_component_t has the input focus.

Note that this merely notifies the window_component_t that it should change it's appearance to indicate the user that this window_component_t has the input focus. Which window_component_t actually receives the input events is handled outside of the window_component_t.

Reimplemented from t3_widget::widget_t.

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.

bool t3_widget::text_field_t::set_size	(	optint	height,
		optint	width
	)

virtual

Set the size of this window_component_t.

Parameters

height	The new height of the window_component_t in cells, or None if it should remain unchanged.
width	The new width of the window_component_t in cells, or None if it should remain unchanged.