#include <gui.hpp>

Public Member Functions
virtual void	addGlobalKeyListener (KeyListener *keyListener)
void	addHiddenWidget (Widget *widget)
void	addShownWidget (Widget *widget)
virtual void	draw ()
virtual void	focusNone ()
virtual FocusHandler *	getFocusHandler () const
virtual Graphics *	getGraphics () const
virtual Input *	getInput () const
virtual Widget *	getTop () const
	Gui (Gui &&)=delete
	Gui (Gui const &)=delete
virtual void	initialize (std::unique_ptr< Graphics > graphics, std::unique_ptr< Input > input, int width, int height)
virtual bool	isTabbingEnabled ()
virtual void	logic ()
Gui &	operator= (Gui &&)=delete
Gui &	operator= (Gui const &)=delete
virtual void	removeGlobalKeyListener (KeyListener *keyListener)
virtual void	setGlobalFont (std::string const &filename, int size)
virtual void	setGraphics (Graphics *graphics)
virtual void	setGraphics (std::unique_ptr< Graphics > graphics)
virtual void	setInput (Input *input)
virtual void	setInput (std::unique_ptr< Input > input)
virtual void	setRoot (std::unique_ptr< Widget > top)
virtual void	setRoot (Widget *top)
virtual void	setTabbingEnabled (bool tabbing)
virtual void	setTop (std::unique_ptr< Widget > top)
virtual void	setTop (Widget *top)
void	widgetDied (Widget const *widget)

Protected Types
using	KeyListenerList = std::list<KeyListener*>
using	KeyListenerListIterator = KeyListenerList::iterator

Protected Member Functions
void	captureMouse (Widget *widget)
virtual void	distributeKeyEvent (KeyEvent &keyEvent)
virtual void	distributeKeyEventToGlobalKeyListeners (KeyEvent &keyEvent)
void	distributeMouseEvent (Widget *source, MouseEvent::Type type, MouseEvent::Button button, int x, int y)
void	distributeMouseEvent (Widget *source, MouseEvent::Type type, MouseEvent::Button button, int x, int y, bool force)
virtual void	distributeMouseEvent (Widget *source, MouseEvent::Type type, MouseEvent::Button button, int x, int y, bool force, bool toSourceOnly)
virtual Widget *	getKeyEventSource ()
virtual Widget *	getMouseEventSource (int x, int y)
Widget *	getWidgetAt (int x, int y)
virtual Widget *	getWidgetAt (int x, int y, Widget *exclude)
virtual std::vector< Widget * >	getWidgetsAt (int x, int y)
virtual void	handleHiddenWidgets ()
virtual void	handleKeyInput ()
virtual void	handleModalFocus ()
virtual void	handleModalFocusGained ()
virtual void	handleModalFocusReleased ()
virtual void	handleModalMouseInputFocus ()
virtual void	handleModalMouseInputFocusGained ()
virtual void	handleModalMouseInputFocusReleased ()
virtual void	handleMouseInput ()
virtual void	handleMouseMoved (MouseInput const &mouseInput)
virtual void	handleMousePressed (MouseInput const &mouseInput)
virtual void	handleMouseReleased (MouseInput const &mouseInput)
virtual void	handleMouseWheelMovedDown (MouseInput const &mouseInput)
virtual void	handleMouseWheelMovedLeft (MouseInput const &mouseInput)
virtual void	handleMouseWheelMovedRight (MouseInput const &mouseInput)
virtual void	handleMouseWheelMovedUp (MouseInput const &mouseInput)
virtual void	handleShownWidgets ()
virtual void	handleTextInput ()
void	releaseMouse (Widget *widget)

Protected Attributes
bool	mAltPressed
int	mClickCount
bool	mControlPressed
GuiDeathListener *	mDeathListener
FocusHandler *	mFocusHandler
std::shared_ptr< Font >	mGlobalFont
Graphics *	mGraphics
std::vector< Widget * >	mHiddenWidgets
Input *	mInput
KeyListenerList	mKeyListeners
int	mLastMouseDragButton
unsigned int	mLastMousePressButton
int	mLastMousePressTimeStamp
int	mLastMouseX
int	mLastMouseY
bool	mMetaPressed
std::unique_ptr< Graphics >	mOwnedGraphics
std::unique_ptr< Input >	mOwnedInput
std::unique_ptr< Widget >	mOwnedTop
bool	mShiftPressed
std::vector< Widget * >	mShownWidgets
bool	mTabbing
Widget *	mTop
VisibilityEventHandler *	mVisibilityEventHandler

Friends
class	DragHandler

Detailed Description

The central GUI manager.

Integrates backend implementations and manages the root widget tree.

GUI is the core class of FifeGUI to which implementations of backends are passed, to make FifeGUI work with a specific library, and to where the top widget (root widget of GUI) is added. If you want to be able to have more then one widget in your GUI, the top widget should be a container.

A Gui object cannot work properly without passing backend implementations to it. A Gui object must have an implementation of a Graphics and an implementation of Input.

Note: A complete GUI also must have the ability to load images. Images are loaded with the Image class, so to make Fifechan able to load images an implementation of ImageLoader must be passed to Image.

See also: Graphics, Input, Image

Definition at line 107 of file gui.hpp.

Member Typedef Documentation

◆ KeyListenerList

using fcn::Gui::KeyListenerList = std::list<KeyListener*>

protected

List of KeyListener.

Definition at line 601 of file gui.hpp.

◆ KeyListenerListIterator

using fcn::Gui::KeyListenerListIterator = KeyListenerList::iterator

protected

Iterator for KeyListenerList.

Definition at line 604 of file gui.hpp.

Constructor & Destructor Documentation

◆ Gui()

fcn::Gui::Gui ( )

Definition at line 68 of file gui.cpp.

◆ ~Gui()

fcn::Gui::~Gui ( )

virtual

Definition at line 96 of file gui.cpp.

Member Function Documentation

◆ addGlobalKeyListener()

void fcn::Gui::addGlobalKeyListener ( KeyListener * keyListener )

virtual

Adds a global key listener to the GUI.

A global key listener will receive all key events generated from the GUI and global key listeners will receive the events before key listeners of widgets.

Parameters

keyListener The key listener to add.

See also: removeGlobalKeyListener

Definition at line 283 of file gui.cpp.

References mKeyListeners.

◆ addHiddenWidget()

void fcn::Gui::addHiddenWidget ( Widget * widget )

Inform gui that a widget was hidden.

Parameters

widget Hidden widget.

Definition at line 293 of file gui.cpp.

References mHiddenWidgets.

◆ addShownWidget()

void fcn::Gui::addShownWidget ( Widget * widget )

Inform gui that a widget was shown.

Parameters

widget Shown widget.

Definition at line 298 of file gui.cpp.

References mShownWidgets.

◆ captureMouse()

void fcn::Gui::captureMouse ( Widget * widget )

protected

Explicitly captures mouse input to a widget.

When a widget has explicit capture, all mouse events are routed to that widget regardless of cursor position.

Parameters

widget The widget to capture mouse to, or nullptr to release.

Definition at line 780 of file gui.cpp.

References fcn::Widget::captureMouse().

◆ distributeKeyEvent()

void fcn::Gui::distributeKeyEvent ( KeyEvent & keyEvent )

protectedvirtual

Distributes a key event.

Parameters

keyEvent The key event to distribute.

Definition at line 944 of file gui.cpp.

References fcn::Widget::_getKeyListeners(), fcn::Widget::getParent(), fcn::Event::getSource(), fcn::KeyEvent::getType(), fcn::Widget::isEnabled(), fcn::Widget::isModalFocused(), fcn::InputEvent::mDistributor, mFocusHandler, fcn::throwException(), and fcn::Widget::widgetExists().

Referenced by handleKeyInput().

◆ distributeKeyEventToGlobalKeyListeners()

void fcn::Gui::distributeKeyEventToGlobalKeyListeners ( KeyEvent & keyEvent )

protectedvirtual

Distributes a key event to the global key listeners.

Parameters

keyEvent The key event to distribute.

Definition at line 995 of file gui.cpp.

References fcn::KeyEvent::getType(), fcn::InputEvent::isConsumed(), mKeyListeners, and fcn::throwException().

Referenced by handleKeyInput().

◆ distributeMouseEvent() [1/3]

void fcn::Gui::distributeMouseEvent	(	Widget *	source,
		MouseEvent::Type	type,
		MouseEvent::Button	button,
		int	x,
		int	y )

inlineprotected

Convenience overload: distribute a mouse event forwarding to the full overload with force and toSourceOnly set to false.

Definition at line 449 of file gui.hpp.

References distributeMouseEvent().

Referenced by distributeMouseEvent(), distributeMouseEvent(), handleHiddenWidgets(), handleModalFocusGained(), handleModalFocusReleased(), handleModalMouseInputFocusGained(), handleModalMouseInputFocusReleased(), handleMouseMoved(), handleMousePressed(), handleMouseReleased(), handleMouseWheelMovedDown(), handleMouseWheelMovedLeft(), handleMouseWheelMovedRight(), handleMouseWheelMovedUp(), and handleShownWidgets().

◆ distributeMouseEvent() [2/3]

void fcn::Gui::distributeMouseEvent	(	Widget *	source,
		MouseEvent::Type	type,
		MouseEvent::Button	button,
		int	x,
		int	y,
		bool	force )

inlineprotected

Convenience overload: forward and allow specifying force while toSourceOnly remains false.

Definition at line 457 of file gui.hpp.

References distributeMouseEvent().

◆ distributeMouseEvent() [3/3]

void fcn::Gui::distributeMouseEvent	(	Widget *	source,
		MouseEvent::Type	type,
		MouseEvent::Button	button,
		int	x,
		int	y,
		bool	force,
		bool	toSourceOnly )

protectedvirtual

Distributes a mouse event to the GUI handling code.

Parameters

source	The source widget of the event.
type	The type of the event to distribute.
button	The button of the event (if any) to distribute.
x	The x coordinate of the event.
y	The y coordinate of the event.
force	If true, distributes the event even if the receiving widget is not enabled, not visible, or another widget has modal focus.
toSourceOnly	If true, only the source widget receives the event, otherwise parent listeners may also receive it.

Definition at line 840 of file gui.cpp.

References fcn::Widget::_getMouseListeners(), fcn::Widget::getAbsolutePosition(), fcn::Widget::getParent(), fcn::MouseEvent::getType(), fcn::Widget::isEnabled(), fcn::Widget::isModalFocused(), fcn::Widget::isUnderMouseModal(), mAltPressed, mClickCount, mControlPressed, fcn::InputEvent::mDistributor, mFocusHandler, mMetaPressed, mShiftPressed, fcn::MouseEvent::mX, fcn::MouseEvent::mY, and fcn::Widget::widgetExists().

◆ draw()

void fcn::Gui::draw ( )

virtual

Draws the GUI.

By calling this function all draw functions down in the GUI hierarchy will be called. When draw is called the used Graphics object will be initialised and drawing of the top widget will commence.

See also: Widget::draw

Definition at line 246 of file gui.cpp.

References mGraphics, mTop, and fcn::throwException().

◆ focusNone()

void fcn::Gui::focusNone ( )

virtual

Focuses none of the widgets in the GUI.

Definition at line 268 of file gui.cpp.

References mFocusHandler.

◆ getFocusHandler()

FocusHandler * fcn::Gui::getFocusHandler ( ) const

virtual

Returns the focus handler used by this GUI.

Returns: Focus handler.

Definition at line 201 of file gui.cpp.

References mFocusHandler.

◆ getGraphics()

Graphics * fcn::Gui::getGraphics ( ) const

virtual

Gets the graphics object used for drawing.

Returns: The graphics object used for drawing. Nullptr if no graphics object has been set.

See also: setGraphics, OpenGLGraphics, SDLGraphics

Definition at line 167 of file gui.cpp.

References mGraphics.

◆ getInput()

Input * fcn::Gui::getInput ( ) const

virtual

Gets the input object being used for input handling.

Returns: The input object used for handling input. Nullptr if no input object has been set.

See also: setInput, SDLInput

Definition at line 188 of file gui.cpp.

References mInput.

◆ getKeyEventSource()

Widget * fcn::Gui::getKeyEventSource ( )

protectedvirtual

Gets the source of the key event.

Returns: The source widget of the key event.

Definition at line 828 of file gui.cpp.

References fcn::Widget::_getInternalFocusHandler(), fcn::FocusHandler::getFocused(), and mFocusHandler.

Referenced by handleKeyInput().

◆ getMouseEventSource()

Widget * fcn::Gui::getMouseEventSource	(	int	x,
		int	y )

protectedvirtual

Gets the source of the mouse event.

Returns: The source widget of the mouse event.

Definition at line 798 of file gui.cpp.

References getWidgetAt(), and mFocusHandler.

Referenced by handleMouseMoved(), handleMousePressed(), handleMouseReleased(), handleMouseWheelMovedDown(), handleMouseWheelMovedLeft(), handleMouseWheelMovedRight(), and handleMouseWheelMovedUp().

◆ getTop()

Widget * fcn::Gui::getTop ( ) const

virtual

Gets the top widget.

The top widget is the root widget of the GUI.

Returns: The top widget. Nullptr if no top widget has been set.

Definition at line 146 of file gui.cpp.

References mTop.

◆ getWidgetAt() [1/2]

Widget * fcn::Gui::getWidgetAt	(	int	x,
		int	y )

inlineprotected

Gets the widget at a certain position.

Returns: The widget at a certain position.

Definition at line 506 of file gui.hpp.

References getWidgetAt().

Referenced by getMouseEventSource(), getWidgetAt(), handleHiddenWidgets(), and handleShownWidgets().

◆ getWidgetAt() [2/2]

Widget * fcn::Gui::getWidgetAt	(	int	x,
		int	y,
		Widget *	exclude )

protectedvirtual

Gets the widget at a certain position, optionally excluding one widget.

Parameters

x	The x coordinate.
y	The y coordinate.
exclude	Widget to ignore when searching (may be nullptr).

Returns: The widget at the specified position or nullptr if none.

Definition at line 700 of file gui.cpp.

References fcn::Widget::getAbsolutePosition(), fcn::Widget::getWidgetAt(), and mTop.

◆ getWidgetsAt()

std::vector< Widget * > fcn::Gui::getWidgetsAt	(	int	x,
		int	y )

protectedvirtual

Gets all widgets a certain coordinate in the GUI.

Parameters

x	The x coordinate.
y	The y coordinate.

Returns: A vector of all widgets at the specified coordinate.

Definition at line 720 of file gui.cpp.

References fcn::Widget::getAbsolutePosition(), fcn::Widget::getWidgetAt(), and mTop.

Referenced by handleModalFocusGained(), handleModalFocusReleased(), handleModalMouseInputFocusGained(), handleModalMouseInputFocusReleased(), and handleMouseMoved().

◆ handleHiddenWidgets()

void fcn::Gui::handleHiddenWidgets ( )

protectedvirtual

Handles hidden widgets.

Definition at line 1127 of file gui.cpp.

References distributeMouseEvent(), getWidgetAt(), fcn::Rectangle::isContaining(), mHiddenWidgets, mLastMouseX, mLastMouseY, and fcn::Widget::widgetExists().

Referenced by logic().

◆ handleKeyInput()

void fcn::Gui::handleKeyInput ( )

protectedvirtual

Handles key input.

Definition at line 374 of file gui.cpp.

References distributeKeyEvent(), distributeKeyEventToGlobalKeyListeners(), fcn::KeyInput::getKey(), getKeyEventSource(), fcn::KeyInput::getType(), fcn::KeyInput::isAltPressed(), fcn::InputEvent::isConsumed(), fcn::KeyInput::isControlPressed(), fcn::KeyInput::isMetaPressed(), fcn::KeyInput::isNumericPad(), fcn::KeyInput::isShiftPressed(), mAltPressed, mControlPressed, mFocusHandler, mInput, mMetaPressed, mShiftPressed, and mTabbing.

Referenced by logic().

◆ handleModalFocus()

void fcn::Gui::handleModalFocus ( )

protectedvirtual

Handles modal focus.

Modal focus needs to be checked at each logic iteration as it might be necessary to distribute mouse entered or mouse exited events.

Definition at line 1031 of file gui.cpp.

References handleModalFocusGained(), handleModalFocusReleased(), and mFocusHandler.

Referenced by logic().

◆ handleModalFocusGained()

void fcn::Gui::handleModalFocusGained ( )

protectedvirtual

Handles modal focus gained.

If modal focus has been gained it might be necessary to distribute mouse entered or mouse exited events.

Definition at line 1045 of file gui.cpp.

References distributeMouseEvent(), getWidgetsAt(), mFocusHandler, mLastMousePressButton, mLastMouseX, and mLastMouseY.

Referenced by handleModalFocus().

◆ handleModalFocusReleased()

void fcn::Gui::handleModalFocusReleased ( )

protectedvirtual

Handles modal focus released.

If modal focus has been released it might be necessary to distribute mouse entered or mouse exited events.

Definition at line 1067 of file gui.cpp.

References distributeMouseEvent(), getWidgetsAt(), mFocusHandler, mLastMousePressButton, mLastMouseX, and mLastMouseY.

Referenced by handleModalFocus().

◆ handleModalMouseInputFocus()

void fcn::Gui::handleModalMouseInputFocus ( )

protectedvirtual

Handles modal mouse input focus.

Modal mouse input focus needs to be checked at each logic iteration as it might be necessary to distribute mouse entered or mouse exited events.

Definition at line 1017 of file gui.cpp.

References handleModalMouseInputFocusGained(), handleModalMouseInputFocusReleased(), and mFocusHandler.

Referenced by logic().

◆ handleModalMouseInputFocusGained()

void fcn::Gui::handleModalMouseInputFocusGained ( )

protectedvirtual

Handles modal mouse input focus gained.

If modal focus has been gained it might be necessary to distribute mouse entered or mouse exited events.

Definition at line 1086 of file gui.cpp.

References distributeMouseEvent(), getWidgetsAt(), mFocusHandler, mLastMousePressButton, mLastMouseX, and mLastMouseY.

Referenced by handleModalMouseInputFocus().

◆ handleModalMouseInputFocusReleased()

void fcn::Gui::handleModalMouseInputFocusReleased ( )

protectedvirtual

Handles modal mouse input focus released.

If modal focus has been released it might be necessary to distribute mouse entered or mouse exited events.

Definition at line 1108 of file gui.cpp.

References distributeMouseEvent(), getWidgetsAt(), mFocusHandler, mLastMousePressButton, mLastMouseX, and mLastMouseY.

Referenced by handleModalMouseInputFocus().

◆ handleMouseInput()

void fcn::Gui::handleMouseInput ( )

protectedvirtual

Handles all mouse input.

Definition at line 309 of file gui.cpp.

References fcn::MouseInput::getType(), fcn::MouseInput::getX(), fcn::MouseInput::getY(), handleMouseMoved(), handleMousePressed(), handleMouseReleased(), handleMouseWheelMovedDown(), handleMouseWheelMovedLeft(), handleMouseWheelMovedRight(), handleMouseWheelMovedUp(), mInput, mLastMouseX, mLastMouseY, and fcn::throwException().

Referenced by logic().

◆ handleMouseMoved()

void fcn::Gui::handleMouseMoved ( MouseInput const & mouseInput )

protectedvirtual

Handles mouse moved input.

Parameters

mouseInput The mouse input to handle.

Definition at line 443 of file gui.cpp.

References distributeMouseEvent(), fcn::MouseInput::getButton(), getMouseEventSource(), getWidgetsAt(), fcn::MouseInput::getX(), fcn::MouseInput::getY(), mClickCount, mFocusHandler, mLastMouseDragButton, mLastMousePressTimeStamp, mLastMouseX, mLastMouseY, and mTop.

Referenced by handleMouseInput().

◆ handleMousePressed()

void fcn::Gui::handleMousePressed ( MouseInput const & mouseInput )

protectedvirtual

Handles mouse pressed input.

Parameters

mouseInput The mouse input to handle.

Definition at line 538 of file gui.cpp.

References distributeMouseEvent(), fcn::Widget::getAbsolutePosition(), fcn::MouseInput::getButton(), getMouseEventSource(), fcn::MouseInput::getTimeStamp(), fcn::MouseInput::getX(), fcn::MouseInput::getY(), fcn::Widget::isModalFocused(), mClickCount, mFocusHandler, mLastMouseDragButton, mLastMousePressButton, mLastMousePressTimeStamp, and fcn::Widget::requestFocus().

Referenced by handleMouseInput().

◆ handleMouseReleased()

void fcn::Gui::handleMouseReleased ( MouseInput const & mouseInput )

protectedvirtual

Handles mouse released input.

Parameters

mouseInput The mouse input to handle.

Definition at line 657 of file gui.cpp.

References distributeMouseEvent(), fcn::Widget::getAbsolutePosition(), fcn::MouseInput::getButton(), getMouseEventSource(), fcn::MouseInput::getX(), fcn::MouseInput::getY(), mClickCount, mFocusHandler, and mLastMousePressButton.

Referenced by handleMouseInput().

◆ handleMouseWheelMovedDown()

void fcn::Gui::handleMouseWheelMovedDown ( MouseInput const & mouseInput )

protectedvirtual

Handles mouse wheel moved down input.

Parameters

mouseInput The mouse input to handle.

Definition at line 577 of file gui.cpp.

References distributeMouseEvent(), fcn::Widget::getAbsolutePosition(), fcn::MouseInput::getButton(), getMouseEventSource(), fcn::MouseInput::getX(), fcn::MouseInput::getY(), and mFocusHandler.

Referenced by handleMouseInput().

◆ handleMouseWheelMovedLeft()

void fcn::Gui::handleMouseWheelMovedLeft ( MouseInput const & mouseInput )

protectedvirtual

Handles mouse wheel moved left input.

Parameters

mouseInput The mouse input to handle.

Definition at line 637 of file gui.cpp.

References distributeMouseEvent(), fcn::Widget::getAbsolutePosition(), fcn::MouseInput::getButton(), getMouseEventSource(), fcn::MouseInput::getX(), fcn::MouseInput::getY(), and mFocusHandler.

Referenced by handleMouseInput().

◆ handleMouseWheelMovedRight()

void fcn::Gui::handleMouseWheelMovedRight ( MouseInput const & mouseInput )

protectedvirtual

Handles mouse wheel moved right input.

Parameters

mouseInput The mouse input to handle.

Definition at line 617 of file gui.cpp.

References distributeMouseEvent(), fcn::Widget::getAbsolutePosition(), fcn::MouseInput::getButton(), getMouseEventSource(), fcn::MouseInput::getX(), fcn::MouseInput::getY(), and mFocusHandler.

Referenced by handleMouseInput().

◆ handleMouseWheelMovedUp()

void fcn::Gui::handleMouseWheelMovedUp ( MouseInput const & mouseInput )

protectedvirtual

Handles mouse wheel moved up input.

Parameters

mouseInput The mouse input to handle.

Definition at line 597 of file gui.cpp.

References distributeMouseEvent(), fcn::Widget::getAbsolutePosition(), fcn::MouseInput::getButton(), getMouseEventSource(), fcn::MouseInput::getX(), fcn::MouseInput::getY(), and mFocusHandler.

Referenced by handleMouseInput().

◆ handleShownWidgets()

void fcn::Gui::handleShownWidgets ( )

protectedvirtual

Handles shown widgets.

Definition at line 1159 of file gui.cpp.

References distributeMouseEvent(), getWidgetAt(), fcn::Rectangle::isContaining(), mLastMouseX, mLastMouseY, and mShownWidgets.

Referenced by logic().

◆ handleTextInput()

void fcn::Gui::handleTextInput ( )

protectedvirtual

Handles text input from the backend.

Definition at line 350 of file gui.cpp.

References fcn::TextInputEvent::Input, fcn::Widget::isEnabled(), mAltPressed, mControlPressed, mFocusHandler, mInput, mMetaPressed, mShiftPressed, and fcn::Widget::textInput().

Referenced by logic().

◆ initialize()

void fcn::Gui::initialize	(	std::unique_ptr< Graphics >	graphics,
		std::unique_ptr< Input >	input,
		int	width,
		int	height )

virtual

Initializes GUI backends in one call.

Parameters

graphics	Owned graphics backend.
input	Owned input backend.
width	Unused by the core implementation.
height	Unused by the core implementation.

Definition at line 193 of file gui.cpp.

References setGraphics(), and setInput().

◆ isTabbingEnabled()

bool fcn::Gui::isTabbingEnabled ( )

virtual

Checks if tabbing is enabled.

Returns: True if tabbing is enabled, false otherwise.

See also: setTabbingEnabled

Definition at line 278 of file gui.cpp.

References mTabbing.

◆ logic()

void fcn::Gui::logic ( )

virtual

Performs logic of the GUI.

By calling this function all logic functions down in the GUI heirarchy will be called. When logic is called for Gui, user input will be handled.

See also: Widget::logic

Definition at line 221 of file gui.cpp.

References handleHiddenWidgets(), handleKeyInput(), handleModalFocus(), handleModalMouseInputFocus(), handleMouseInput(), handleShownWidgets(), handleTextInput(), mInput, mTop, and fcn::throwException().

◆ releaseMouse()

void fcn::Gui::releaseMouse ( Widget * widget )

protected

Releases explicit mouse capture from a widget.

Parameters

widget The widget to release capture from.

Definition at line 787 of file gui.cpp.

References fcn::Widget::releaseMouse().

◆ removeGlobalKeyListener()

void fcn::Gui::removeGlobalKeyListener ( KeyListener * keyListener )

virtual

Removes global key listener from the GUI.

Parameters

keyListener The key listener to remove.

Exceptions

Exception if the key listener hasn't been added.

See also: addGlobalKeyListener

Definition at line 288 of file gui.cpp.

References mKeyListeners.

◆ setGlobalFont()

void fcn::Gui::setGlobalFont	(	std::string const &	filename,
		int	size )

virtual

Loads a font using the active graphics backend and sets it as global widget font.

Parameters

filename	Path to font file.
size	Font size.

Definition at line 206 of file gui.cpp.

References mGlobalFont, mGraphics, fcn::Widget::setGlobalFont(), and fcn::throwException().

◆ setGraphics() [1/2]

void fcn::Gui::setGraphics ( Graphics * graphics )

virtual

Sets the graphics object to use for drawing.

Parameters

graphics The graphics object to use for drawing.

See also: getGraphics, OpenGLGraphics, SDLGraphics

Definition at line 151 of file gui.cpp.

References mGraphics, and mOwnedGraphics.

Referenced by initialize(), and setGraphics().

◆ setGraphics() [2/2]

void fcn::Gui::setGraphics ( std::unique_ptr< Graphics > graphics )

virtual

Sets and owns the graphics object used for drawing.

Parameters

graphics The graphics object.

Definition at line 161 of file gui.cpp.

References mOwnedGraphics, and setGraphics().

◆ setInput() [1/2]

void fcn::Gui::setInput ( Input * input )

virtual

Sets the input object to use for input handling.

Parameters

input The input object to use for input handling.

See also: getInput, SDLInput

Definition at line 172 of file gui.cpp.

References mInput, and mOwnedInput.

Referenced by initialize(), and setInput().

◆ setInput() [2/2]

void fcn::Gui::setInput ( std::unique_ptr< Input > input )

virtual

Sets and owns the input object used for input handling.

Parameters

input The input object.

Definition at line 182 of file gui.cpp.

References mOwnedInput, and setInput().

◆ setRoot() [1/2]

void fcn::Gui::setRoot ( std::unique_ptr< Widget > top )

virtual

Alias for ownership-based setTop.

Parameters

top	The root widget to own.

Definition at line 141 of file gui.cpp.

References setTop().

◆ setRoot() [2/2]

void fcn::Gui::setRoot ( Widget * top )

virtual

Alias for setTop.

Parameters

top	The root widget.

Definition at line 136 of file gui.cpp.

References setTop().

◆ setTabbingEnabled()

void fcn::Gui::setTabbingEnabled ( bool tabbing )

virtual

Sets tabbing enabled, or not.

Tabbing is the usage of changing focus by utilizing the tab key.

Parameters

tabbing True if tabbing should be enabled, false otherwise.

See also: isTabbingEnabled

Definition at line 273 of file gui.cpp.

References mTabbing.

◆ setTop() [1/2]

void fcn::Gui::setTop ( std::unique_ptr< Widget > top )

virtual

Sets the root widget and transfers ownership to Gui.

Parameters

top	The root widget to own.

Definition at line 130 of file gui.cpp.

References mOwnedTop, and setTop().

◆ setTop() [2/2]

void fcn::Gui::setTop ( Widget * top )

virtual

Sets the top widget.

The top widget is the root widget of the GUI. If you want a GUI to be able to contain more than one widget the top widget should be a container.

Parameters

top	The top widget.

See also: Container

Definition at line 112 of file gui.cpp.

References fcn::Widget::_setFocusHandler(), mFocusHandler, mOwnedTop, and mTop.

Referenced by setRoot(), setRoot(), and setTop().

◆ widgetDied()

void fcn::Gui::widgetDied ( Widget const * widget )

Inform gui that a widget was deleted.

Parameters

widget Deleted widget.

Definition at line 303 of file gui.cpp.

References mHiddenWidgets, and mShownWidgets.

◆ DragHandler

friend class DragHandler

friend

Definition at line 110 of file gui.hpp.

Member Data Documentation

◆ mAltPressed

bool fcn::Gui::mAltPressed

protected

True if alt is pressed, false otherwise.

Definition at line 629 of file gui.hpp.

Referenced by distributeMouseEvent(), handleKeyInput(), and handleTextInput().

◆ mClickCount

int fcn::Gui::mClickCount

protected

Holds the current click count.

Used to keep track of clicks for a the last pressed button.

Definition at line 655 of file gui.hpp.

Referenced by distributeMouseEvent(), handleMouseMoved(), handleMousePressed(), and handleMouseReleased().

◆ mControlPressed

bool fcn::Gui::mControlPressed

protected

True if control is pressed, false otherwise.

Definition at line 624 of file gui.hpp.

Referenced by distributeMouseEvent(), handleKeyInput(), and handleTextInput().

◆ mDeathListener

GuiDeathListener* fcn::Gui::mDeathListener

protected

Listener notified when the GUI or top widget is destroyed.

Definition at line 665 of file gui.hpp.

◆ mFocusHandler

FocusHandler* fcn::Gui::mFocusHandler

protected

Holds the focus handler for the GUI.

Definition at line 588 of file gui.hpp.

Referenced by distributeKeyEvent(), distributeMouseEvent(), focusNone(), getFocusHandler(), getKeyEventSource(), getMouseEventSource(), handleKeyInput(), handleModalFocus(), handleModalFocusGained(), handleModalFocusReleased(), handleModalMouseInputFocus(), handleModalMouseInputFocusGained(), handleModalMouseInputFocusReleased(), handleMouseMoved(), handleMousePressed(), handleMouseReleased(), handleMouseWheelMovedDown(), handleMouseWheelMovedLeft(), handleMouseWheelMovedRight(), handleMouseWheelMovedUp(), handleTextInput(), and setTop().

◆ mGlobalFont

std::shared_ptr<Font> fcn::Gui::mGlobalFont

protected

Shared global font used by widgets when not overridden.

Definition at line 677 of file gui.hpp.

Referenced by setGlobalFont().

◆ mGraphics

Graphics* fcn::Gui::mGraphics

protected

Holds the graphics implementation used.

Definition at line 578 of file gui.hpp.

Referenced by draw(), getGraphics(), setGlobalFont(), and setGraphics().

◆ mHiddenWidgets

std::vector<Widget*> fcn::Gui::mHiddenWidgets

protected

Holds hidden widgets.

Definition at line 568 of file gui.hpp.

Referenced by addHiddenWidget(), handleHiddenWidgets(), and widgetDied().

◆ mInput

Input* fcn::Gui::mInput

protected

Holds the input implementation used.

Definition at line 583 of file gui.hpp.

Referenced by getInput(), handleKeyInput(), handleMouseInput(), handleTextInput(), logic(), and setInput().

◆ mKeyListeners

KeyListenerList fcn::Gui::mKeyListeners

protected

Holds the global key listeners of the GUI.

Definition at line 609 of file gui.hpp.

Referenced by addGlobalKeyListener(), distributeKeyEventToGlobalKeyListeners(), and removeGlobalKeyListener().

◆ mLastMouseDragButton

int fcn::Gui::mLastMouseDragButton

protected

Holds the last button used when a drag of a widget was initiated.

Used to be able to release a drag when the same button is released.

Definition at line 662 of file gui.hpp.

Referenced by handleMouseMoved(), and handleMousePressed().

◆ mLastMousePressButton

unsigned int fcn::Gui::mLastMousePressButton

protected

Holds the last mouse button pressed.

Definition at line 634 of file gui.hpp.

Referenced by handleModalFocusGained(), handleModalFocusReleased(), handleModalMouseInputFocusGained(), handleModalMouseInputFocusReleased(), handleMousePressed(), and handleMouseReleased().

◆ mLastMousePressTimeStamp

int fcn::Gui::mLastMousePressTimeStamp

protected

Holds the last mouse press time stamp.

Definition at line 639 of file gui.hpp.

Referenced by handleMouseMoved(), and handleMousePressed().

◆ mLastMouseX

int fcn::Gui::mLastMouseX

protected

Holds the last mouse x coordinate.

Definition at line 644 of file gui.hpp.

Referenced by handleHiddenWidgets(), handleModalFocusGained(), handleModalFocusReleased(), handleModalMouseInputFocusGained(), handleModalMouseInputFocusReleased(), handleMouseInput(), handleMouseMoved(), and handleShownWidgets().

◆ mLastMouseY

int fcn::Gui::mLastMouseY

protected

Holds the last mouse y coordinate.

Definition at line 649 of file gui.hpp.

Referenced by handleHiddenWidgets(), handleModalFocusGained(), handleModalFocusReleased(), handleModalMouseInputFocusGained(), handleModalMouseInputFocusReleased(), handleMouseInput(), handleMouseMoved(), and handleShownWidgets().

◆ mMetaPressed

bool fcn::Gui::mMetaPressed

protected

True if meta is pressed, false otherwise.

Definition at line 619 of file gui.hpp.

Referenced by distributeMouseEvent(), handleKeyInput(), and handleTextInput().

◆ mOwnedGraphics

std::unique_ptr<Graphics> fcn::Gui::mOwnedGraphics

protected

Optional owned graphics backend instance.

Definition at line 671 of file gui.hpp.

Referenced by setGraphics(), and setGraphics().

◆ mOwnedInput

std::unique_ptr<Input> fcn::Gui::mOwnedInput

protected

Optional owned input backend instance.

Definition at line 674 of file gui.hpp.

Referenced by setInput(), and setInput().

◆ mOwnedTop

std::unique_ptr<Widget> fcn::Gui::mOwnedTop

protected

Optional owned top widget (when Gui takes ownership).

Definition at line 668 of file gui.hpp.

Referenced by setTop(), and setTop().

◆ mShiftPressed

bool fcn::Gui::mShiftPressed

protected

True if shift is pressed, false otherwise.

Definition at line 614 of file gui.hpp.

Referenced by distributeMouseEvent(), handleKeyInput(), and handleTextInput().

◆ mShownWidgets

std::vector<Widget*> fcn::Gui::mShownWidgets

protected

Holds shown widgets.

Definition at line 573 of file gui.hpp.

Referenced by addShownWidget(), handleShownWidgets(), and widgetDied().

◆ mTabbing

bool fcn::Gui::mTabbing

protected

True if tabbing is enabled, false otherwise.

Definition at line 598 of file gui.hpp.

Referenced by handleKeyInput(), isTabbingEnabled(), and setTabbingEnabled().

◆ mTop

Widget* fcn::Gui::mTop

protected

Holds the top widget.

Definition at line 563 of file gui.hpp.

Referenced by draw(), getTop(), getWidgetAt(), getWidgetsAt(), handleMouseMoved(), logic(), and setTop().

◆ mVisibilityEventHandler

VisibilityEventHandler* fcn::Gui::mVisibilityEventHandler

protected

Holds the visibility event handler for the GUI.

Definition at line 593 of file gui.hpp.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ KeyListenerList

◆ KeyListenerListIterator

Constructor & Destructor Documentation

◆ Gui()

◆ ~Gui()

Member Function Documentation

◆ addGlobalKeyListener()

◆ addHiddenWidget()

◆ addShownWidget()

◆ captureMouse()

◆ distributeKeyEvent()

◆ distributeKeyEventToGlobalKeyListeners()

◆ distributeMouseEvent() [1/3]

◆ distributeMouseEvent() [2/3]

◆ distributeMouseEvent() [3/3]

◆ draw()

◆ focusNone()

◆ getFocusHandler()

◆ getGraphics()

◆ getInput()

◆ getKeyEventSource()

◆ getMouseEventSource()

◆ getTop()

◆ getWidgetAt() [1/2]

◆ getWidgetAt() [2/2]

◆ getWidgetsAt()

◆ handleHiddenWidgets()

◆ handleKeyInput()

◆ handleModalFocus()

◆ handleModalFocusGained()

◆ handleModalFocusReleased()

◆ handleModalMouseInputFocus()

◆ handleModalMouseInputFocusGained()

◆ handleModalMouseInputFocusReleased()

◆ handleMouseInput()

◆ handleMouseMoved()

◆ handleMousePressed()

◆ handleMouseReleased()

◆ handleMouseWheelMovedDown()

◆ handleMouseWheelMovedLeft()

◆ handleMouseWheelMovedRight()

◆ handleMouseWheelMovedUp()

◆ handleShownWidgets()

◆ handleTextInput()

◆ initialize()

◆ isTabbingEnabled()

◆ logic()

◆ releaseMouse()

◆ removeGlobalKeyListener()

◆ setGlobalFont()

◆ setGraphics() [1/2]

◆ setGraphics() [2/2]

◆ setInput() [1/2]

◆ setInput() [2/2]

◆ setRoot() [1/2]

◆ setRoot() [2/2]

◆ setTabbingEnabled()

◆ setTop() [1/2]

◆ setTop() [2/2]

◆ widgetDied()

Friends And Related Symbol Documentation

◆ DragHandler

Member Data Documentation

◆ mAltPressed

◆ mClickCount

◆ mControlPressed

◆ mDeathListener

◆ mFocusHandler

◆ mGlobalFont

◆ mGraphics

◆ mHiddenWidgets

◆ mInput

◆ mKeyListeners