This interactor subclass represents a text field for entering short text strings. More...

#include "gtextfield.h"

Inheritance diagram for GTextField:

Public Types
enum	InputType { INPUT_TYPE_TEXT, INPUT_TYPE_INTEGER, INPUT_TYPE_REAL }
	Constants for the valid types of text field input. More...

enum	TextPosition { TEXT_BESIDE_ICON, TEXT_UNDER_ICON, TEXT_ONLY }
	The places where an interactor can place its text relative to its icon. More...

Public Member Functions
	GTextField(string text="", int charsWide=0, QWidget* parent=nullptr)
	Creates a text field with the given initial text. More...

	GTextField(int charsWide, QWidget* parent=nullptr)
	Creates a text field wide enough to display the given number of characters. More...

	GTextField(int value, int min, int max, int step=1, QWidget* parent=nullptr)
	Creates a text field for entering integer values, with the given initial value. More...

	GTextField(double value, double min, double max, double step, QWidget* parent=nullptr)
	Creates a text field for entering real number values, with the given initial value. More...

	~GTextField() override
	Frees memory allocated internally by the text field. More...

void	addActionListener() (deprecated)
	Adds an event listener to be notified when this interactor is clicked or generally interacted with. More...

bool	eventsEnabled() const override
	Returns true if this interactor is currently accepting events. More...

string	getAccelerator() const
	Returns a string representing a hotkey for this interactor, or an empty string if no accelerator has been set. More...

string	getActionCommand() const
	Returns an action command for this interactor, which is a semi-unique string you can use to identify it when events occur. More...

string	getBackground() const
	Returns the background color of the interactor as a string. More...

int	getBackgroundInt() const
	Returns the background color of the interactor as an RGB integer. More...

GRectangle	getBounds() const
	Returns a rectangle representing the x/y position and size of this interactor. More...

int	getCharsWide() const
	Returns the number of characters that can fit in the visible area of this text field. More...

string	getColor() const
	Returns the foreground/text color of the interactor as a string. More...

int	getColorInt() const
	Returns the foreground/text color of the interactor as an RGB integer. More...

GContainer *	getContainer() const
	Returns a pointer to the onscreen container holding this interactor. More...

string	getFont() const
	Returns the font of this interactor's text as a font string such as "Helvetica-12-Bold". More...

string	getForeground() const
	Returns the foreground/text color of the interactor as a string. More...

int	getForegroundInt() const
	Returns the foreground/text color of the interactor as an RGB integer. More...

double	getHeight() const
	Returns the current onscreen height of this interactor in pixels. More...

string	getIcon() const
	Returns the file name of the icon associated with this interactor, or an empty string if no icon has been set. More...

int	getID() const
	Returns a globally unique identifier for this interactor, which is set when the interactor is constructed. More...

InputType	getInputType() const
	Returns the type of input accepted by this text field. More...

_Internal_QWidget*	getInternalWidget() const override
	Returns a direct pointer to the internal Qt widget being wrapped by this interactor. More...

GPoint	getLocation() const
	Returns an (x, y) point representing the onscreen location of the top-left corner of this interactor within its containing window. More...

int	getMaxLength() const
	Returns the maximum length of string allowed in the text field. More...

double	getMinimumHeight() const
	Returns the minimum height in pixels that this interactor will permit itself to be resized to. More...

GDimension	getMinimumSize() const
	Returns a GDimension structure representing the minimum size in pixels that this interactor will permit itself to be resized to. More...

double	getMinimumWidth() const
	Returns the minimum width in pixels that this interactor will permit itself to be resized to. More...

string	getName() const
	Returns a string representing a unique name for this interactor. More...

string	getPlaceholder() const
	Returns the text field's placeholder text, which is usually displayed as a light gray text in the field when the field is empty. More...

double	getPreferredHeight() const
	Returns the height in pixels that this interactor would prefer to be, which would exactly fit its contents with no stretching or scrollbars. More...

GDimension	getPreferredSize() const
	Returns a GDimension structure storing the width and height in pixels that this interactor would prefer to be, which would exactly fit its contents with no stretching or scrollbars. More...

double	getPreferredWidth() const
	Returns the height in pixels that this interactor would prefer to be, which would exactly fit its contents with no stretching or scrollbars. More...

GDimension	getSize() const
	Returns a GDimension structure storing the current onscreen width and height of this interactor in pixels. More...

string	getText() const
	Returns the text field's current text. More...

string	getType() const override
	Returns a string representing the class name of this interactor, such as "GButton" or "GCheckBox". More...

string	getValue() const
	Returns the text field's current text. More...

bool	getValueAsBool() const
	Returns the currently typed value in the text field, interpreted as a bool value of true or false. More...

char	getValueAsChar() const
	Returns the currently typed value in the text field as a char value. More...

double	getValueAsDouble() const
	Returns the currently typed value in the text field, interpreted as a real number value. More...

int	getValueAsInt() const
	Returns the currently typed value in the text field, interpreted as an integer value. More...

int	getValueAsInteger() const
	Returns the currently typed value in the text field, interpreted as an integer value. More...

QWidget*	getWidget() const override
	Returns a direct pointer to the internal Qt widget being wrapped by this interactor. More...

double	getWidth() const
	Returns the current onscreen width of this interactor in pixels. More...

double	getX() const
	Returns the x-coordinate of the top-left pixel of this interactor within its onscreen window. More...

double	getY() const
	Returns the y-coordinate of the top-left pixel of this interactor within its onscreen window. More...

bool	inBounds(double x, double y) const
	Returns true if the given x/y pixel is within the bounds of this interactor. More...

bool	inBounds(int x, int y) const
	Returns true if the given x/y pixel is within the bounds of this interactor. More...

bool	isAutocompleteEnabled() const
	Returns true if this text field has an autocompletion list of options that will pop up as the user begins typing. More...

bool	isEditable() const
	Returns true if the text field's value can be edited. More...

bool	isEnabled() const
	Returns true if this interactor is currently enabled. More...

bool	isVisible() const
	Returns true if the interactor is visible on the screen. More...

void	removeActionListener()
	Removes the action listener from this interactor so that it will no longer call it when events occur. More...

void	removeClickListener()
	Removes the click listener from this interactor so that it will no longer call it when events occur. More...

void	removeDoubleClickListener()
	Removes the double-click listener from this interactor so that it will no longer call it when events occur. More...

void	removeKeyListener()
	Removes the key listener from this interactor so that it will no longer call it when key events occur. More...

void	removeMouseListener()
	Removes the mouse listener from this interactor so that it will no longer call it when events occur. More...

void	removeTextChangeListener()
	Removes the text change listener from this text field so that it will no longer call it when the user types characters. More...

void	requestFocus()
	Transfers keyboard focus to this interactor. More...

void	setAccelerator(string accelerator)
	Sets an accelerator hotkey for this interactor, such as "Ctrl-S". More...

void	setActionCommand(string actionCommand)
	Sets the action command for this interactor. More...

void	setActionListener(GEventListener func)
	Sets an action listener on this interactor so that it will be called when it is interacted with in its primary way. More...

void	setActionListener(GEventListenerVoid func)
	Sets an action listener on this interactor so that it will be called when it is interacted with in its primary way. More...

void	setAutocompleteEnabled(bool enabled)
	Sets whether the autocompletion feature is enabled for this text field. More...

void	setAutocompleteList(std::initializer_list< string > strings)
	Sets the given list of strings to be used as an autocompletion list for this text field. More...

void	setAutocompleteList(const std::vector< string > &strings)
	Sets the given list of strings to be used as an autocompletion list for this text field. More...

void	setBackground(int rgb)
	Sets the background color of the interactor to the color represented by the given RGB integer. More...

void	setBackground(string color)
	Sets the background color of the interactor to the color represented by the given string. More...

void	setBounds(double x, double y, double width, double height)
	Sets the size and location of the widget. More...

void	setBounds(const GRectangle &size)
	Sets the size and location of the widget. More...

void	setCharsWide(int charsWide)
	Sets the width of this text field to be exactly wide enough to display the given number of characters. More...

void	setClickListener(GEventListener func)
	Sets a mouse listener on this interactor so that it will be called when the mouse is clicked on it. More...

void	setClickListener(GEventListenerVoid func)
	Sets a mouse listener on this interactor so that it will be called when the mouse is clicked on it. More...

void	setColor(int rgb)
	Sets the foreground/text color of the interactor to the color represented by the given RGB integer. More...

void	setColor(string color)
	Sets the foreground/text color of the interactor to the color represented by the given string. More...

void	setDoubleClickListener(GEventListener func)
	Sets a mouse listener on this interactor so that it will be called when the mouse is double-clicked on it. More...

void	setDoubleClickListener(GEventListenerVoid func)
	Sets a mouse listener on this interactor so that it will be called when the mouse is double-clicked on it. More...

void	setEditable(bool value)
	Sets whether the value in the text box can be edited. More...

void	setEnabled(bool value)
	Sets whether this interactor is currently enabled. More...

void	setEventsEnabled(bool eventsEnabled)
	Sets whether the object is currently allowing itself to fire events. More...

void	setFont(const QFont &font)
	Sets the font used by this widget to the given Qt font. More...

void	setFont(string font)
	Sets the font used by this widget to the font represented by the given font string, such as "Helvetica-16-Bold". More...

void	setForeground(int rgb)
	Sets the foreground/text color of the interactor to the color represented by the given RGB integer. More...

void	setForeground(string color)
	Sets the foreground/text color of the interactor to the color represented by the given string. More...

void	setHeight(double height)
	Sets the onscreen height of the interactor in pixels. More...

void	setIcon(const QIcon &icon)
	Sets the icon associated with this interactor. More...

void	setIcon(const QPixmap &icon)
	Sets the icon associated with this interactor. More...

void	setIcon(string filename, bool retainIconSize=true)
	Sets the file name of the icon associated with this interactor, or an empty string if no icon has been set. More...

void	setKeyListener(GEventListener func)
	Sets a key listener on this interactor so that it will be called when the user presses any key. More...

void	setKeyListener(GEventListenerVoid func)
	Sets a key listener on this interactor so that it will be called when the user presses any key. More...

void	setLocation(double x, double y)
	Sets the onscreen x/y-coordinate of the top-left corner of the interactor relative to its window. More...

void	setMaxLength(int maxLength)
	Sets the maximum number of characters that can be typed into the field. More...

void	setMinimumSize(double width, double height)
	Sets the minimum size in pixels that this interactor will permit itself to be resized to. More...

void	setMinimumSize(const GDimension &size)
	Sets the minimum size in pixels that this interactor will permit itself to be resized to. More...

void	setMouseListener(GEventListener func)
	Sets a mouse listener on this interactor so that it will be called when the mouse is moved or clicked on it. More...

void	setMouseListener(GEventListenerVoid func)
	Sets a mouse listener on this interactor so that it will be called when the mouse is moved or clicked on it. More...

void	setName(string name)
	Sets a string representing a unique name for this interactor. More...

void	setPlaceholder(string text)
	Sets a gray message that is displayed in the background of the text field before the user has typed any value. More...

void	setPreferredHeight(double height)
	Sets the height in pixels that this interactor would prefer to be. More...

void	setPreferredSize(double width, double height)
	Sets the width and height in pixels that this interactor would prefer to be. More...

void	setPreferredSize(const GDimension &size)
	Sets the size in pixels that this interactor would prefer to be. More...

void	setPreferredWidth(double width)
	Sets the width in pixels that this interactor would prefer to be. More...

void	setSize(double width, double height)
	Sets the onscreen width and height of the interactor in pixels. More...

void	setSize(const GDimension &size)
	Sets the onscreen width and height of the interactor in pixels. More...

void	setText(string text)
	Sets the current text value in the text field. More...

void	setTextChangeListener(GEventListener func)
	Sets a text-change listener on this text field so that it will be called when the value in the field changes, which will occur on every key press. More...

void	setTextChangeListener(GEventListenerVoid func)
	Sets a text-change listener on this text field so that it will be called when the value in the field changes, which will occur on every key press. More...

void	setTooltip(string tooltipText)
	Sets a "tooltip" that will appear if the user hovers their mouse over the interactor. More...

void	setValue(bool value)
	Sets the current text value in the text field to the string representation of the given value. More...

void	setValue(char value)
	Sets the current text value in the text field to the string representation of the given value. More...

void	setValue(double value)
	Sets the current text value in the text field to the string representation of the given value. More...

void	setValue(int value)
	Sets the current text value in the text field to the string representation of the given value. More...

void	setValue(string value)
	Sets the current text value in the text field to the string representation of the given value. More...

void	setVisible(bool visible)
	Returns true if the interactor is visible on the screen. More...

void	setWidth(double width)
	Sets the onscreen width of the interactor in pixels. More...

void	setX(double x)
	Sets the onscreen x-coordinate of the top-left corner of the interactor relative to its window. More...

void	setY(double y)
	Sets the onscreen y-coordinate of the top-left corner of the interactor relative to its window. More...

string	toString() const
	Returns a string representation of this observable object's state. More...

bool	valueIsBool() const
	Returns true if the currently typed value in the text field can be interpreted as a bool value of true or false. More...

bool	valueIsChar() const
	Returns true if the currently typed value in the text field can be interpreted as a char value. More...

bool	valueIsDouble() const
	Returns true if the currently typed value in the text field can be interpreted as a real number. More...

bool	valueIsInt() const
	Returns true if the currently typed value in the text field can be interpreted as an integer. More...

bool	valueIsInteger() const
	Returns true if the currently typed value in the text field can be interpreted as an integer. More...

bool	valueIsReal() const
	Returns true if the currently typed value in the text field can be interpreted as a real number. More...

Protected Member Functions
void	clearEventListeners()
	Removes all event listeners from this object. More...

void	ensureThreadSafety(string memberName="")
	Ensures that we are currently in the Qt GUI thread. More...

void	fireEvent(GEvent &event)
	Sends out the given event to any attached listeners. More...

void	fireGEvent(QEvent *event, EventType eventType, string eventName)
	Creates an event of the given type, then sends it out to any attached listeners. More...

void	fireGEvent(QCloseEvent *event, EventType eventType, string eventName)
	Creates an event of the given type, then sends it out to any attached listeners. More...

void	fireGEvent(QKeyEvent *event, EventType eventType, string eventName)
	Creates an event of the given type, then sends it out to any attached listeners. More...

void	fireGEvent(QMouseEvent *event, EventType eventType, string eventName, string actionCommand="")
	Creates an event of the given type, then sends it out to any attached listeners. More...

void	fireGEvent(QResizeEvent *event, EventType eventType, string eventName)
	Creates an event of the given type, then sends it out to any attached listeners. More...

void	fireGEvent(QTimerEvent *event, EventType eventType, string eventName)
	Creates an event of the given type, then sends it out to any attached listeners. More...

void	fireGEvent(QWheelEvent *event, EventType eventType, string eventName)
	Creates an event of the given type, then sends it out to any attached listeners. More...

void	fireGEvent(QWindowStateChangeEvent *event, EventType eventType, string eventName)
	Creates an event of the given type, then sends it out to any attached listeners. More...

bool	hasEventListener(string eventName) const
	Returns true if the observable object has a listener for the given type of event. More...

bool	isAcceptingEvent(int eventMask) const
	Returns true if the observable object has a listener for the given type of event. More...

bool	isAcceptingEvent(const GEvent &event) const
	Returns true if the observable object has a listener for the given type of event. More...

bool	isAcceptingEvent(string eventType) const
	Returns true if the observable object has a listener for the given type of event. More...

void	removeEventListener(string eventName)
	Removes any event listener from this observable object that would respond to the given type of event, such as "click" or "keydown". More...

void	removeEventListeners(std::initializer_list< string > eventNames)
	Removes any event listener from this observable object that would respond to the given types of events, such as "click" or "keydown". More...

void	setEventListener(string eventName, GEventListener func)
	Adds an event listener from this observable object to respond to the given type of event, such as "click" or "keydown". More...

void	setEventListener(string eventName, GEventListenerVoid func)
	Adds an event listener from this observable object to respond to the given type of event, such as "click" or "keydown". More...

void	setEventListeners(std::initializer_list< string > eventNames, GEventListener func)
	Adds an event listener from this observable object to respond to the given types of events, such as "click" or "keydown". More...

void	setEventListeners(std::initializer_list< string > eventNames, GEventListenerVoid func)
	Adds an event listener from this observable object to respond to the given types of events, such as "click" or "keydown". More...

Detailed Description

This interactor subclass represents a text field for entering short text strings.

Pressing Enter in a text field generates an action event.

Member Enumeration Documentation

◆ InputType

enum InputType

Constants for the valid types of text field input.

Enumerator
INPUT_TYPE_TEXT
INPUT_TYPE_INTEGER
INPUT_TYPE_REAL

◆ TextPosition

enum TextPosition

inherited

The places where an interactor can place its text relative to its icon.

Enumerator
TEXT_BESIDE_ICON
TEXT_UNDER_ICON
TEXT_ONLY

Constructor & Destructor Documentation

◆ GTextField() [1/4]

GTextField	(	string	text = `""`,
		int	charsWide = `0`,
		QWidget*	parent = `nullptr`
	)

Creates a text field with the given initial text.

If the optional charsWide parameter is passed, sizes the text field wide enough to display the given number of characters.

◆ GTextField() [2/4]

GTextField	(	int	charsWide,
		QWidget*	parent = `nullptr`
	)

Creates a text field wide enough to display the given number of characters.

◆ GTextField() [3/4]

GTextField	(	int	value,
		int	min,
		int	max,
		int	step = `1`,
		QWidget*	parent = `nullptr`
	)

Creates a text field for entering integer values, with the given initial value.

The value is constrained to the given minimum and maximum, incrementing by the given step amount.

Exceptions

ErrorException if min > max or value is not between min and max

◆ GTextField() [4/4]

GTextField	(	double	value,
		double	min,
		double	max,
		double	step,
		QWidget*	parent = `nullptr`
	)

Creates a text field for entering real number values, with the given initial value.

The value is constrained to the given minimum and maximum, incrementing by the given step amount.

Exceptions

ErrorException if min > max or value is not between min and max

◆ ~GTextField()

~GTextField ( )

override

Frees memory allocated internally by the text field.

Member Function Documentation

◆ addActionListener()

void addActionListener ( )

virtualinherited

Adds an event listener to be notified when this interactor is clicked or generally interacted with.

Deprecated:: does nothing; use setActionListener instead

◆ clearEventListeners()

void clearEventListeners ( )

protectedvirtualinherited

Removes all event listeners from this object.

◆ ensureThreadSafety()

void ensureThreadSafety ( string memberName = "" )

protectedvirtualinherited

Ensures that we are currently in the Qt GUI thread.

◆ eventsEnabled()

bool eventsEnabled ( ) const

overridevirtualinherited

Returns true if this interactor is currently accepting events.

Initially true. An interactor must be visible and added to an onscreen window to receive events.

Reimplemented from GObservable.

◆ fireEvent()

void fireEvent ( GEvent & event )

protectedvirtualinherited

Sends out the given event to any attached listeners.