A GTextArea is a multi-line editable text box. More...

#include "gtextarea.h"

Inheritance diagram for GTextArea:

Public Types
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
	GTextArea(int rows, int columns, QWidget* parent=nullptr)
	Creates a new text area large enough to display the given number of rows and columns of text. More...

	GTextArea(string text="", QWidget* parent=nullptr)
	Creates a new text area with the given initial text. More...

	~GTextArea() override
	Frees memory allocated internally by the text area. More...

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

void	appendFormattedText(string text, string color="", string font="")
	Adds formatted text to the end of the text area. More...

void	appendHtml(string html)
	Adds HTML-formatted text to the end of the text area. More...

void	appendText(string text)
	Adds the given plain text to the end of the text area. More...

void	clearSelection()
	Deselects any text that is currently selected in the text area. More...

void	clearText()
	Sets the text in the text area to be empty. 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...

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

int	getColumns() const
	Returns the number of visible columns (characters wide) in the text area. More...

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

int	getCursorPosition() const
	Returns the keyboard cursor's current position in the text area as a 0-based character index within the overall text string. 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	getHtml() const
	Returns the text area's current text as HTML. 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...

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

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 area's placeholder text, which is usually displayed as a light gray text in the text area when the area 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...

int	getRows() const
	Returns the number of visible rows (lines tall) in the text area. More...

string	getSelectedText() const
	Returns the text that is currently selected in the text area. More...

int	getSelectionEnd() const
	Returns the index just past the end of the current selection of text as a 0-based character index within the overall text string. More...

int	getSelectionLength() const
	Returns the number of characters that are currently selected. More...

int	getSelectionStart() const
	Returns the index of the start of the current selection of text as a 0-based character index within the overall text string. 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 area's current text. More...

string	getType() const override
	Returns a string representing the class name of this interactor, such as "GButton" or "GCheckBox". 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	isContextMenuEnabled() const
	Returns true if a context menu will pop up when the user right-clicks the text area. More...

bool	isEditable() const
	Returns whether the text area allows the user to modify its text. More...

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

bool	isLineWrap() const
	Returns whether the text area wraps its text when a line becomes too long. More...

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

void	moveCursorToEnd()
	Sets the text area's keyboard cursor position to the end of the current text. More...

void	moveCursorToStart()
	Sets the text area's keyboard cursor position to the start of the current text. 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 area so that it will no longer call it when the user modifies the text. More...

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

void	scrollToBottom()
	Moves the visible scroll region of the text area so that the bottom part of the text is visible. More...

void	scrollToTop()
	Moves the visible scroll region of the text area so that the top part of the text is visible. More...

void	select(int startIndex, int length)
	Sets the given range of text to be selected, beginning with the given start index as a 0-based character index within the overall text string, and extending for the given length of characters. More...

void	selectAll()
	Selects the entire text of the text area. 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	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	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	setColumns(int columns)
	Sets the width of the text area to be wide enough to fit the given number of characters (columns) of text. More...

void	setContextMenuEnabled(bool enabled)
	Sets whether a context menu will pop up when the user right-clicks the text area. More...

void	setCursorPosition(int index, bool keepAnchor=false)
	Moves the keyboard cursor to the given 0-based character index within the text. 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 text area allows the user to modify its text. 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	setHtml(string html)
	Sets the text area's current text to the given HTML string. 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	setLineWrap(bool wrap)
	Sets whether the text area wraps its text when a line becomes too long. 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	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) override
	Sets a mouse listener on this text area so that it will be called when the user moves or clicks the mouse. More...

void	setMouseListener(GEventListenerVoid func) override
	Sets a mouse listener on this text area so that it will be called when the user moves or clicks the mouse. More...

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

void	setPlaceholder(string text)
	Sets the text area's placeholder text, which is usually displayed as a light gray text in the text area when the area is empty. 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	setRows(int rows)
	Sets the height of the text area to be wide enough to fit the given number of lines (rows) of text. More...

void	setRowsColumns(int rows, int columns)
	Sets the size of the text area to be wide enough to fit the given number of lines (rows) and characters (columns) of text. 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 text area's current text to the given string, replacing any existing text. More...

void	setTextChangeListener(GEventListener func)
	Sets a text change listener on this text area so that it will be called when the user modifies the current text. More...

void	setTextChangeListener(GEventListenerVoid func)
	Sets a text change listener on this text area so that it will be called when the user modifies the current text. More...

void	setTooltip(string tooltipText)
	Sets a "tooltip" that will appear if the user hovers their mouse over the interactor. 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...

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

A GTextArea is a multi-line editable text box.

The box allows the user to type arbitrarily long documents. Scroll bars will appear if the text becomes too long to fit in the visible area of the box.

Member Enumeration Documentation

◆ 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

◆ GTextArea() [1/2]

GTextArea	(	int	rows,
		int	columns,
		QWidget*	parent = `nullptr`
	)

Creates a new text area large enough to display the given number of rows and columns of text.

Exceptions

ErrorException if rows or columns value is negative

◆ GTextArea() [2/2]

GTextArea	(	string	text = `""`,
		QWidget*	parent = `nullptr`
	)

Creates a new text area with the given initial text.

◆ ~GTextArea()

~GTextArea ( )

override

Frees memory allocated internally by the text area.

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

◆ appendFormattedText()

void appendFormattedText	(	string	text,
		string	color = `""`,
		string	font = `""`
	)

virtual

Adds formatted text to the end of the text area.

The text will be formatted with the given color and font.

◆ appendHtml()

void appendHtml ( string html )

virtual

Adds HTML-formatted text to the end of the text area.

◆ appendText()

void appendText ( string text )

virtual

Adds the given plain text to the end of the text area.

◆ clearEventListeners()

void clearEventListeners ( )

protectedvirtualinherited

Removes all event listeners from this object.

◆ clearSelection()

void clearSelection ( )

virtual

Deselects any text that is currently selected in the text area.

◆ clearText()

void clearText ( )

virtual

Sets the text in the text area to be empty.

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