StanfordCPPLib
Public Types | Public Member Functions | Protected Member Functions | List of all members
GBrowserPane Class Reference

A GBrowserPane is a graphical interactor that displays a web page. More...

#include "gbrowserpane.h"

Inheritance diagram for GBrowserPane:
GInteractor GObservable

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

 GBrowserPane(string url="", QWidget* parent=nullptr)
 Constructs a new browser pane. More...
 
~GBrowserPane()
 Frees memory allocated internally by the browser pane. More...
 
void addActionListener() (deprecated)
 Adds an event listener to be notified when this interactor is clicked or generally interacted with. More...
 
void clearSelection()
 Deselects any text that is currently selected in the pane. More...
 
void clearText()
 Sets the text in the pane to be empty. More...
 
bool eventsEnabled() const
 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...
 
GContainergetContainer() const
 Returns a pointer to the onscreen container holding this interactor. More...
 
string getContentType() const
 Returns the MIME content type for the current page. More...
 
int getCursorPosition() const
 Returns the keyboard cursor's current position in the text pane 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 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
 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 getPageUrl() const
 Returns the URL of the web page or file name being currently viewed. 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...
 
string getSelectedText() const
 Returns the text that is currently selected in the text pane. 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 full text of the current page or file being displayed in the pane. More...
 
string getType() const
 Returns a string representing the class name of this interactor, such as "GButton" or "GCheckBox". More...
 
QWidget*  getWidget() const
 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 isEditable() const
 Returns whether the text pane 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 pane 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 pane's keyboard cursor position to the end of the current text. More...
 
void moveCursorToStart()
 Sets the text pane's keyboard cursor position to the start of the current text. More...
 
void readTextFromFile(std::istream &file)
 Reads text from the given file and displays the entire file's text as the contents of this formatted pane. More...
 
void readTextFromFile(string filename)
 Reads text from the given file and displays the entire file's text as the contents of this formatted pane. More...
 
void readTextFromUrl(string url)
 Reads text from the given web page URL and displays the entire page's text as the contents of this formatted pane. More...
 
void removeKeyListener()
 Removes the key listener from this text pane so that it will no longer call it when the user types keys. More...
 
void removeLinkListener()
 Removes the link listener from the canvas so that it will no longer call it when hyperlink events occur. More...
 
void removeMouseListener()
 Removes the mouse listener from this text pane so that it will no longer call it when the user moves/clicks the mouse. More...
 
void removeTextChangeListener()
 Removes the text change listener from this text pane 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 pane so that the bottom part of the text is visible. More...
 
void scrollToTop()
 Moves the visible scroll region of the text pane 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 pane. 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 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 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 setContentType(string contentType)
 Sets the MIME content type being used to display the current/future pages. More...
 
void setCursorPosition(int index, bool keepAnchor=false)
 Moves the keyboard cursor to the given 0-based character index within the text. More...
 
void setEditable(bool value)
 Sets whether the text pane 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 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 text pane so that it will be called when the user presses any key. More...
 
void setKeyListener(GEventListenerVoid func)
 Sets a key listener on this text pane so that it will be called when the user presses any key. More...
 
void setLineWrap(bool wrap)
 Sets whether the text pane wraps its text when a line becomes too long. More...
 
void setLinkListener(GEventListener func)
 Sets a link listener on this canvas so that it will be called when the user clicks on hyperlinks on the pane. More...
 
void setLinkListener(GEventListenerVoid func)
 Sets a link listener on this canvas so that it will be called when the user clicks on hyperlinks on the pane. 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)
 Sets a mouse listener on this text pane so that it will be called when the user moves or clicks the mouse. More...
 
void setMouseListener(GEventListenerVoid func)
 Sets a mouse listener on this text pane 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 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 pane to display to the given contents using its current content type. More...
 
void setTextChangeListener(GEventListener func)
 Sets a text change listener on this text pane 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 pane 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 GBrowserPane is a graphical interactor that displays a web page.

This interactor is a wrapping around the Qt QTextBrowser widget, which is able to display rich content such as HTML pages.

You can use GBrowserPane to implement the core rendering engine of a basic web browser, though it does not support all web browser features such as JavaScript content, secure sessions, or cookies.

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

◆ GBrowserPane()

GBrowserPane ( string   url = "",
QWidget*   parent = nullptr 
)

Constructs a new browser pane.

If a URL string is passed, loads the data from that URL. Otherwise, the pane is initially blank.

◆ ~GBrowserPane()

~GBrowserPane ( )
virtual

Frees memory allocated internally by the browser pane.

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.

◆ clearSelection()

void clearSelection ( )
virtual

Deselects any text that is currently selected in the pane.

◆ clearText()

void clearText ( )
virtual

Sets the text in the pane to be empty.

◆ ensureThreadSafety()

void ensureThreadSafety ( string   memberName = "")
protectedvirtualinherited

Ensures that we are currently in the Qt GUI thread.

◆ eventsEnabled()

bool eventsEnabled ( ) const
virtualinherited

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.

◆ fireGEvent() [1/8]

void fireGEvent ( QEvent *  event,
EventType  eventType,
string   eventName 
)
protectedvirtualinherited

Creates an event of the given type, then sends it out to any attached listeners.

◆ fireGEvent() [2/8]

void fireGEvent ( QCloseEvent *  event,
EventType  eventType,
string   eventName 
)
protectedvirtualinherited

Creates an event of the given type, then sends it out to any attached listeners.

◆ fireGEvent() [3/8]

void fireGEvent ( QKeyEvent *  event,
EventType  eventType,
string   eventName 
)
protectedvirtualinherited

Creates an event of the given type, then sends it out to any attached listeners.

◆ fireGEvent() [4/8]

void fireGEvent ( QMouseEvent *  event,
EventType  eventType,
string   eventName,
string   actionCommand = "" 
)
protectedvirtualinherited

Creates an event of the given type, then sends it out to any attached listeners.

◆ fireGEvent() [5/8]

void fireGEvent ( QResizeEvent *  event,
EventType  eventType,
string   eventName 
)
protectedvirtualinherited

Creates an event of the given type, then sends it out to any attached listeners.

◆ fireGEvent() [6/8]

void fireGEvent ( QTimerEvent *  event,
EventType  eventType,
string   eventName 
)
protectedvirtualinherited

Creates an event of the given type, then sends it out to any attached listeners.

◆ fireGEvent() [7/8]

void fireGEvent ( QWheelEvent *  event,
EventType  eventType,
string   eventName 
)
protectedvirtualinherited

Creates an event of the given type, then sends it out to any attached listeners.

◆ fireGEvent() [8/8]

void fireGEvent ( QWindowStateChangeEvent *  event,
EventType  eventType,
string   eventName 
)
protectedvirtualinherited

Creates an event of the given type, then sends it out to any attached listeners.

◆ getAccelerator()

string getAccelerator ( ) const
virtualinherited

Returns a string representing a hotkey for this interactor, or an empty string if no accelerator has been set.

Returns
an accelerator such as "Ctrl-S"

Reimplemented in GButton.

◆ getActionCommand()

string getActionCommand ( ) const
virtualinherited

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

For example, for buttons, the default action command is the button's text.

Reimplemented in GChooser, GRadioButton, GCheckBox, and GButton.

◆ getBackground()

string getBackground ( ) const
virtualinherited

Returns the background color of the interactor as a string.

Returns
a string such as "blue" or "#7700ff"

Reimplemented in GCanvas.

◆ getBackgroundInt()

int getBackgroundInt ( ) const
virtualinherited

Returns the background color of the interactor as an RGB integer.

Returns
an integer such as 0x7700ff

Reimplemented in GCanvas.

◆ getBounds()

GRectangle getBounds ( ) const
virtualinherited

Returns a rectangle representing the x/y position and size of this interactor.

◆ getColor()

string getColor ( ) const
virtualinherited

Returns the foreground/text color of the interactor as a string.

Equivalent to getForeground.

Returns
a string such as "blue" or "#7700ff"

◆ getColorInt()

int getColorInt ( ) const
virtualinherited

Returns the foreground/text color of the interactor as an RGB integer.

Equivalent to getForegroundInt.

Returns
an integer such as 0x7700ff

◆ getContainer()

GContainer * getContainer ( ) const
virtualinherited

Returns a pointer to the onscreen container holding this interactor.

When an interactor is created, its container is initially null. This will become non-null automatically if you add the interactor to a window or other layout container. Interactors must be added to a container or window to receive events or to become visible on the screen.

Returns
the container, or nullptr if interactor has not yet been added to any container

◆ getContentType()

string getContentType ( ) const
virtual

Returns the MIME content type for the current page.

The default content type is "text/html". (If you need to look up the content type for a given file/page extension, consider using the HttpServer::getContentType(extension) function.)

◆ getCursorPosition()

int getCursorPosition ( ) const
virtual

Returns the keyboard cursor's current position in the text pane as a 0-based character index within the overall text string.

◆ getFont()

string getFont ( ) const
virtualinherited

Returns the font of this interactor's text as a font string such as "Helvetica-12-Bold".

Returns
a font string such as "Helvetica-12-Bold"

Reimplemented in GCanvas.

◆ getForeground()

string getForeground ( ) const
virtualinherited

Returns the foreground/text color of the interactor as a string.

Equivalent to getColor.

Returns
a string such as "blue" or "#7700ff"

◆ getForegroundInt()

int getForegroundInt ( ) const
virtualinherited

Returns the foreground/text color of the interactor as an RGB integer.

Equivalent to getColorInt.

Returns
an integer such as 0x7700ff

◆ getHeight()

double getHeight ( ) const
virtualinherited

Returns the current onscreen height of this interactor in pixels.

◆ getIcon()

string getIcon ( ) const
virtualinherited

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

Not all types of interactors support icons.

◆ getID()

int getID ( ) const
virtualinherited

Returns a globally unique identifier for this interactor, which is set when the interactor is constructed.

These IDs can be useful for debugging to help identify interactors uniquely.

◆ getInternalWidget()

_Internal_QWidget* getInternalWidget ( ) const
virtual

Returns a direct pointer to the internal Qt widget being wrapped by this interactor.

This must be overridden by all interactor subclasses. Students/clients generally should not need to call this.

Implements GInteractor.

◆ getLocation()

GPoint getLocation ( ) const
virtualinherited

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

◆ getMinimumHeight()

double getMinimumHeight ( ) const
virtualinherited

Returns the minimum height in pixels that this interactor will permit itself to be resized to.

◆ getMinimumSize()

GDimension getMinimumSize ( ) const
virtualinherited

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

◆ getMinimumWidth()

double getMinimumWidth ( ) const
virtualinherited

Returns the minimum width in pixels that this interactor will permit itself to be resized to.

◆ getName()

string getName ( ) const
virtualinherited

Returns a string representing a unique name for this interactor.

The default name string uses the interactor's type and its ID to make a string like "GButton_14", but you can override this by calling setName.

Returns
a string such as "GButton_14"

◆ getPageUrl()

string getPageUrl ( ) const
virtual

Returns the URL of the web page or file name being currently viewed.

If no page or file has been loaded, returns an empty string.

◆ getPreferredHeight()

double getPreferredHeight ( ) const
virtualinherited

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

◆ getPreferredSize()

GDimension getPreferredSize ( ) const
virtualinherited

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.

Reimplemented in GContainer.

◆ getPreferredWidth()

double getPreferredWidth ( ) const
virtualinherited

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

◆ getSelectedText()

string getSelectedText ( ) const
virtual

Returns the text that is currently selected in the text pane.

If no text is currently selected, returns an empty string.

◆ getSelectionEnd()

int getSelectionEnd ( ) const
virtual

Returns the index just past the end of the current selection of text as a 0-based character index within the overall text string.

If no text is currently selected, returns -1.

◆ getSelectionLength()

int getSelectionLength ( ) const
virtual

Returns the number of characters that are currently selected.

If no text is currently selected, returns 0.

◆ getSelectionStart()

int getSelectionStart ( ) const
virtual

Returns the index of the start of the current selection of text as a 0-based character index within the overall text string.

If no text is currently selected, returns -1.

◆ getSize()

GDimension getSize ( ) const
virtualinherited

Returns a GDimension structure storing the current onscreen width and height of this interactor in pixels.

◆ getText()

string getText ( ) const
virtual

Returns the full text of the current page or file being displayed in the pane.

This could be a fairly long string, depending on the page. Initially an empty string if no page or file has yet been loaded.

◆ getType()

string getType ( ) const
virtual

Returns a string representing the class name of this interactor, such as "GButton" or "GCheckBox".

All subclasses of GInteractor must implement this method.

Returns
a string such as "GCheckBox"

Implements GInteractor.

◆ getWidget()

QWidget* getWidget ( ) const
virtual

Returns a direct pointer to the internal Qt widget being wrapped by this interactor.

This must be overridden by all interactor subclasses. Students/clients generally should not need to call this.

Implements GInteractor.

◆ getWidth()

double getWidth ( ) const
virtualinherited

Returns the current onscreen width of this interactor in pixels.

◆ getX()

double getX ( ) const
virtualinherited

Returns the x-coordinate of the top-left pixel of this interactor within its onscreen window.

◆ getY()

double getY ( ) const
virtualinherited

Returns the y-coordinate of the top-left pixel of this interactor within its onscreen window.

◆ hasEventListener()

bool hasEventListener ( string   eventName) const
protectedvirtualinherited

Returns true if the observable object has a listener for the given type of event.

◆ inBounds() [1/2]

bool inBounds ( double  x,
double  y 
) const
virtualinherited

Returns true if the given x/y pixel is within the bounds of this interactor.

◆ inBounds() [2/2]

bool inBounds ( int  x,
int  y 
) const
virtualinherited

Returns true if the given x/y pixel is within the bounds of this interactor.

Reimplemented in GTable.

◆ isAcceptingEvent() [1/3]

bool isAcceptingEvent ( int  eventMask) const
protectedvirtualinherited

Returns true if the observable object has a listener for the given type of event.

See gevent.h for event types and masks.

◆ isAcceptingEvent() [2/3]

bool isAcceptingEvent ( const GEvent event) const
protectedvirtualinherited

Returns true if the observable object has a listener for the given type of event.

◆ isAcceptingEvent() [3/3]

bool isAcceptingEvent ( string   eventType) const
protectedvirtualinherited

Returns true if the observable object has a listener for the given type of event.

◆ isEditable()

bool isEditable ( ) const
virtual

Returns whether the text pane allows the user to modify its text.

Default false.

◆ isEnabled()

bool isEnabled ( ) const
virtualinherited

Returns true if this interactor is currently enabled.

Most interactors begin as enabled but can be disabled to stop them from being able to be clicked on or otherwise emit events.

◆ isLineWrap()

bool isLineWrap ( ) const
virtual

Returns whether the text pane wraps its text when a line becomes too long.

Default true.

◆ isVisible()

bool isVisible ( ) const
virtualinherited

Returns true if the interactor is visible on the screen.

Interactors will not be visible until they are added to an onscreen window or container.

◆ moveCursorToEnd()

void moveCursorToEnd ( )
virtual

Sets the text pane's keyboard cursor position to the end of the current text.

◆ moveCursorToStart()

void moveCursorToStart ( )
virtual

Sets the text pane's keyboard cursor position to the start of the current text.

◆ readTextFromFile() [1/2]

void readTextFromFile ( std::istream &  file)
virtual

Reads text from the given file and displays the entire file's text as the contents of this formatted pane.

The pane will try to display the content in the best appropriate format, such as rendering basic HTML content with formatting intact. If the file cannot be read, sets the pane's text to be empty.

◆ readTextFromFile() [2/2]

void readTextFromFile ( string   filename)
virtual

Reads text from the given file and displays the entire file's text as the contents of this formatted pane.

The pane will try to display the content in the best appropriate format, such as rendering basic HTML content with formatting intact. If the file does not exist or cannot be read, sets the pane's text to be empty.

◆ readTextFromUrl()

void readTextFromUrl ( string   url)
virtual

Reads text from the given web page URL and displays the entire page's text as the contents of this formatted pane.

If the page does not exist or cannot be read, sets the pane's text to be empty.

◆ removeEventListener()

void removeEventListener ( string   eventName)
protectedvirtualinherited

Removes any event listener from this observable object that would respond to the given type of event, such as "click" or "keydown".

◆ removeEventListeners()

void removeEventListeners ( std::initializer_list< string >  eventNames)
protectedvirtualinherited

Removes any event listener from this observable object that would respond to the given types of events, such as "click" or "keydown".

◆ removeKeyListener()

void removeKeyListener ( )
virtual

Removes the key listener from this text pane so that it will no longer call it when the user types keys.

◆ removeLinkListener()

void removeLinkListener ( )
virtual

Removes the link listener from the canvas so that it will no longer call it when hyperlink events occur.

◆ removeMouseListener()

void removeMouseListener ( )
virtual

Removes the mouse listener from this text pane so that it will no longer call it when the user moves/clicks the mouse.

◆ removeTextChangeListener()

void removeTextChangeListener ( )
virtual

Removes the text change listener from this text pane so that it will no longer call it when the user modifies the text.

◆ requestFocus()

void requestFocus ( )
virtualinherited

Transfers keyboard focus to this interactor.

Reimplemented in GTable.

◆ scrollToBottom()

void scrollToBottom ( )
virtual

Moves the visible scroll region of the text pane so that the bottom part of the text is visible.

◆ scrollToTop()

void scrollToTop ( )
virtual

Moves the visible scroll region of the text pane so that the top part of the text is visible.

◆ select()

void select ( int  startIndex,
int  length 
)
virtual

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.

Exceptions
ErrorExceptionif start index or length is negative

◆ selectAll()

void selectAll ( )
virtual

Selects the entire text of the text pane.

◆ setAccelerator()

void setAccelerator ( string   accelerator)
virtualinherited

Sets an accelerator hotkey for this interactor, such as "Ctrl-S".

Not all interactor types support accelerators.

Parameters
acceleratora hotkey such as "Ctrl-S"

Reimplemented in GButton.

◆ setActionCommand()

void setActionCommand ( string   actionCommand)
virtualinherited

Sets the action command for this interactor.

The action command is meant to be a semi-unique string you can use to identify the interactor when events occur. For example, for buttons, the default action command is the button's text, but you can change it to a different string if you prefer. The main usage of this feature is if you want to use the same function as an event listener for many interactors, you can use the action command to help distinguish which interactor generates each event.

◆ setBackground() [1/2]

void setBackground ( int  rgb)
virtualinherited

Sets the background color of the interactor to the color represented by the given RGB integer.

Parameters
rgban RGB integer such as 0x7700ff

Reimplemented in GCanvas, and GTable.

◆ setBackground() [2/2]

void setBackground ( string   color)
virtualinherited

Sets the background color of the interactor to the color represented by the given string.

Parameters
colora string such as "blue" or "#7700ff"

Reimplemented in GCanvas, and GTable.

◆ setBounds() [1/2]

void setBounds ( double  x,
double  y,
double  width,
double  height 
)
virtualinherited

Sets the size and location of the widget.

In general you should avoid explicitly sizing and positioning widgets in this way; instead, use containers and regions to help you lay out widgets at the proper sizes.

Reimplemented in GLabel.

◆ setBounds() [2/2]

void setBounds ( const GRectangle size)
virtualinherited

Sets the size and location of the widget.

In general you should avoid explicitly sizing and positioning widgets in this way; instead, use containers and regions to help you lay out widgets at the proper sizes.

Reimplemented in GLabel.

◆ setColor() [1/2]

void setColor ( int  rgb)
virtualinherited

Sets the foreground/text color of the interactor to the color represented by the given RGB integer.

Equivalent to setForeground.

Parameters
rgban RGB integer such as 0x7700ff

Reimplemented in GCanvas, GTable, and GLabel.

◆ setColor() [2/2]

void setColor ( string   color)
virtualinherited

Sets the foreground/text color of the interactor to the color represented by the given string.

Equivalent to setForeground.

Parameters
colora string such as "blue" or "#7700ff"

Reimplemented in GCanvas, GTable, and GLabel.

◆ setContentType()

void setContentType ( string   contentType)
virtual

Sets the MIME content type being used to display the current/future pages.

The default content type is "text/html". The suggested use of this function would be to call it just before calling loadTextFromFile or loadTextFromUrl. (If you need to look up the content type for a given file/page extension, consider using the HttpServer::getContentType(extension) function.)

◆ setCursorPosition()

void setCursorPosition ( int  index,
bool  keepAnchor = false 
)
virtual

Moves the keyboard cursor to the given 0-based character index within the text.

Exceptions
ErrorExceptionif index is negative

◆ setEditable()

void setEditable ( bool  value)
virtual

Sets whether the text pane allows the user to modify its text.

Default true.

◆ setEnabled()

void setEnabled ( bool  value)
virtualinherited

Sets whether this interactor is currently enabled.

Most interactors begin as enabled but can be disabled to stop them from being able to be clicked on or otherwise emit events.

◆ setEventListener() [1/2]

void setEventListener ( string   eventName,
GEventListener  func 
)
protectedvirtualinherited

Adds an event listener from this observable object to respond to the given type of event, such as "click" or "keydown".

Any prior listener for that type of event is replaced.

◆ setEventListener() [2/2]

void setEventListener ( string   eventName,
GEventListenerVoid  func 
)
protectedvirtualinherited

Adds an event listener from this observable object to respond to the given type of event, such as "click" or "keydown".

Any prior listener for that type of event is replaced.

◆ setEventListeners() [1/2]

void setEventListeners ( std::initializer_list< string >  eventNames,
GEventListener  func 
)
protectedvirtualinherited

Adds an event listener from this observable object to respond to the given types of events, such as "click" or "keydown".

Any prior listener for those types of event are replaced.

◆ setEventListeners() [2/2]

void setEventListeners ( std::initializer_list< string >  eventNames,
GEventListenerVoid  func 
)
protectedvirtualinherited

Adds an event listener from this observable object to respond to the given types of events, such as "click" or "keydown".

Any prior listener for those types of event are replaced.

◆ setEventsEnabled()

void setEventsEnabled ( bool  eventsEnabled)
virtualinherited

Sets whether the object is currently allowing itself to fire events.

Initially this is true.

◆ setFont() [1/2]

void setFont ( const QFont &  font)
virtualinherited

Sets the font used by this widget to the given Qt font.

Clients should generally use the string version of this method.

Reimplemented in GCanvas, GTable, and GLabel.

◆ setFont() [2/2]

void setFont ( string   font)
virtualinherited

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

Parameters
fonta font string such as "Helvetica-16-Bold"

Reimplemented in GCanvas, GTable, and GLabel.

◆ setForeground() [1/2]

void setForeground ( int  rgb)
virtualinherited

Sets the foreground/text color of the interactor to the color represented by the given RGB integer.

Equivalent to setColor.

Parameters
rgban RGB integer such as 0x7700ff

Reimplemented in GCanvas, GTable, and GLabel.

◆ setForeground() [2/2]

void setForeground ( string   color)
virtualinherited

Sets the foreground/text color of the interactor to the color represented by the given string.

Equivalent to setColor.

Parameters
colora string such as "blue" or "#7700ff"

Reimplemented in GCanvas, GTable, and GLabel.

◆ setHeight()

void setHeight ( double  height)
virtualinherited

Sets the onscreen height of the interactor in pixels.

Exceptions
ErrorExceptionif height is negative

Reimplemented in GLabel.

◆ setIcon()

void setIcon ( string   filename,
bool  retainIconSize = true 
)
virtualinherited

Sets the file name of the icon associated with this interactor, or an empty string if no icon has been set.

Not all types of interactors support icons.

Parameters
filenameicon file path to use
retainIconSizetrue if icon should stay at its existing pixel size (default), or false if it should be resized to fit the interactor

Reimplemented in GLabel, and GButton.

◆ setKeyListener() [1/2]

void setKeyListener ( GEventListener  func)
virtual

Sets a key listener on this text pane so that it will be called when the user presses any key.

Any existing key listener will be replaced.

◆ setKeyListener() [2/2]

void setKeyListener ( GEventListenerVoid  func)
virtual

Sets a key listener on this text pane so that it will be called when the user presses any key.

Any existing key listener will be replaced.

◆ setLineWrap()

void setLineWrap ( bool  wrap)
virtual

Sets whether the text pane wraps its text when a line becomes too long.

Default true.

◆ setLinkListener() [1/2]

void setLinkListener ( GEventListener  func)
virtual

Sets a link listener on this canvas so that it will be called when the user clicks on hyperlinks on the pane.

Any existing mouse listener will be replaced.

◆ setLinkListener() [2/2]

void setLinkListener ( GEventListenerVoid  func)
virtual

Sets a link listener on this canvas so that it will be called when the user clicks on hyperlinks on the pane.

Any existing mouse listener will be replaced.

◆ setLocation()

void setLocation ( double  x,
double  y 
)
virtualinherited

Sets the onscreen x/y-coordinate of the top-left corner of the interactor relative to its window.

Generally clients should not call this and should instead use containers and layout regions to position interactors.

Reimplemented in GLabel.

◆ setMinimumSize() [1/2]

void setMinimumSize ( double  width,
double  height 
)
virtualinherited

Sets the minimum size in pixels that this interactor will permit itself to be resized to.

Exceptions
ErrorExceptionif width or height is negative

◆ setMinimumSize() [2/2]

void setMinimumSize ( const GDimension size)
virtualinherited

Sets the minimum size in pixels that this interactor will permit itself to be resized to.

Exceptions
ErrorExceptionif width or height is negative

◆ setMouseListener() [1/2]

void setMouseListener ( GEventListener  func)
virtual

Sets a mouse listener on this text pane so that it will be called when the user moves or clicks the mouse.

Any existing mouse listener will be replaced.

◆ setMouseListener() [2/2]

void setMouseListener ( GEventListenerVoid  func)
virtual

Sets a mouse listener on this text pane so that it will be called when the user moves or clicks the mouse.

Any existing mouse listener will be replaced.

◆ setName()

void setName ( string   name)
virtualinherited

Sets a string representing a unique name for this interactor.

The default name string uses the interactor's type and its ID to make a string like "GButton_14", but you can override this by calling setName.

Parameters
namea string such as "GButton_14"

◆ setPreferredHeight()

void setPreferredHeight ( double  height)
virtualinherited

Sets the height in pixels that this interactor would prefer to be.

Normally clients do not need to call this method; the interactor can figure out its own preferred size. But calling it can help you to hint to the container/layout system if you want a given interactor to "prefer" to make itself larger or smaller for the purposes of your particular program.

◆ setPreferredSize() [1/2]

void setPreferredSize ( double  width,
double  height 
)
virtualinherited

Sets the width and height in pixels that this interactor would prefer to be.

Normally clients do not need to call this method; the interactor can figure out its own preferred size. But calling it can help you to hint to the container/layout system if you want a given interactor to "prefer" to make itself larger or smaller for the purposes of your particular program.

◆ setPreferredSize() [2/2]

void setPreferredSize ( const GDimension size)
virtualinherited

Sets the size in pixels that this interactor would prefer to be.

Normally clients do not need to call this method; the interactor can figure out its own preferred size.

◆ setPreferredWidth()

void setPreferredWidth ( double  width)
virtualinherited

Sets the width in pixels that this interactor would prefer to be.

Normally clients do not need to call this method; the interactor can figure out its own preferred size.

◆ setSize() [1/2]

void setSize ( double  width,
double  height 
)
virtualinherited

Sets the onscreen width and height of the interactor in pixels.

Exceptions
ErrorExceptionif width or height is negative

Reimplemented in GLabel.

◆ setSize() [2/2]

void setSize ( const GDimension size)
virtualinherited

Sets the onscreen width and height of the interactor in pixels.

Exceptions
ErrorExceptionif width or height is negative

Reimplemented in GLabel.

◆ setText()

void setText ( string   text)
virtual

Sets the pane to display to the given contents using its current content type.

For example, if you build your own string of HTML or text content and want to display it in the pane without saving it to a file, this is the method to use.

◆ setTextChangeListener() [1/2]

void setTextChangeListener ( GEventListener  func)
virtual

Sets a text change listener on this text pane so that it will be called when the user modifies the current text.

Any existing text change listener will be replaced.

A text change listener is similar to a key listener in that each will fire an event when the user types a character in the text pane. But a key listener will fire when any key is pressed, even one that does not modify the text itself, such as when the user presses an arrow key or the Ctrl key or Esc or any other special character.

A text change listener will fire only when the actual text changes, such as when the user types a new character into the area.

◆ setTextChangeListener() [2/2]

void setTextChangeListener ( GEventListenerVoid  func)
virtual

Sets a text change listener on this text pane so that it will be called when the user modifies the current text.

Any existing text change listener will be replaced.

A text change listener is similar to a key listener in that each will fire an event when the user types a character in the text pane. But a key listener will fire when any key is pressed, even one that does not modify the text itself, such as when the user presses an arrow key or the Ctrl key or Esc or any other special character.

A text change listener will fire only when the actual text changes, such as when the user types a new character into the area.

◆ setTooltip()

void setTooltip ( string   tooltipText)
virtualinherited

Sets a "tooltip" that will appear if the user hovers their mouse over the interactor.

Set an empty string to clear the tooltip.

◆ setVisible()

void setVisible ( bool  visible)
virtualinherited

Returns true if the interactor is visible on the screen.

Interactors will not be visible until they are added to an onscreen window or container. If you call setVisible on an interactor that is not in any onscreen container, it will have no effect.

Reimplemented in GLabel.

◆ setWidth()

void setWidth ( double  width)
virtualinherited

Sets the onscreen width of the interactor in pixels.

Exceptions
ErrorExceptionif width is negative

Reimplemented in GLabel.

◆ setX()

void setX ( double  x)
virtualinherited

Sets the onscreen x-coordinate of the top-left corner of the interactor relative to its window.

Generally clients should not call this and should instead use containers and layout regions to position interactors.

Reimplemented in GLabel.

◆ setY()

void setY ( double  y)
virtualinherited

Sets the onscreen y-coordinate of the top-left corner of the interactor relative to its window.

Generally clients should not call this and should instead use containers and layout regions to position interactors.

Reimplemented in GLabel.

◆ toString()

string toString ( ) const
virtualinherited

Returns a string representation of this observable object's state.

Primarily used for debugging purposes.