#include <actionevent.hpp>

Inheritance diagram for fcn::ActionEvent:

Public Member Functions
	ActionEvent (Widget *source, std::string id)
std::string const &	getId () const
Public Member Functions inherited from fcn::Event
	Event (Widget *source)
Widget *	getSource () const

Protected Attributes
std::string	mId
Protected Attributes inherited from fcn::Event
Widget *	mSource {nullptr}

Detailed Description

Represents an action trigger (e.g., button click).

An action event is an event that can be fired by a widget whenever an action has occurred. What exactly an action is is up to the widget that fires the action event. An example is a Button which fires an action event as soon as the Button is clicked, another example is TextField which fires an action event as soon as the enter key is pressed.

Any object can listen for actions from widgets by implementing the ActionListener interface.

If you have implement a widget of your own it's a good idea to let the widget fire action events whenever you feel an action has occurred so action listeners of the widget can be informed of the state of the widget.

See also: Widget::addActionListener, Widget::removeActionListener, Widget::distributeActionEvent

Definition at line 45 of file actionevent.hpp.

Constructor & Destructor Documentation

◆ ActionEvent()

fcn::ActionEvent::ActionEvent	(	Widget *	source,
		std::string	id )

Constructor.

Parameters

source	The source widget of the event.
id	An identifier of the event.

Definition at line 18 of file actionevent.cpp.

References fcn::Event::Event(), and mId.

Member Function Documentation

◆ getId()

std::string const & fcn::ActionEvent::getId ( ) const

Returns the event identifier.

The identifier can be used to distinguish between different actions from the same widget, or to group actions from multiple widgets that should be handled equivalently.

Returns: Reference to the event identifier string.

Definition at line 23 of file actionevent.cpp.

References mId.

Member Data Documentation

◆ mId

std::string fcn::ActionEvent::mId

protected

Holds the identifier of the event.

Definition at line 71 of file actionevent.hpp.

Referenced by ActionEvent(), and getId().

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

Public Member Functions