Public Member Functions | Protected Attributes
ActionEvent Class Reference

#include <actionevent.h>

Inheritance diagram for ActionEvent:

Public Member Functions

 ActionEvent (Widget *const source, const std::string &id)
const std::string & getId () const
- Public Member Functions inherited from Event
 Event (Widget *const source)
virtual ~Event ()
WidgetgetSource () const

Protected Attributes

std::string mId
- Protected Attributes inherited from Event

Detailed Description

Represents an action event. An action event is an event that can be fired by a widget whenever an action has occured. 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 occured so action listeners of the widget can be informed of the state of the widget.

See also
Widget::addActionListener, Widget::removeActionListener, Widget::distributeActionEvent
Olof Naessén

Definition at line 97 of file actionevent.h.

Constructor & Destructor Documentation

◆ ActionEvent()

ActionEvent::ActionEvent ( Widget *const  source,
const std::string &  id 


sourceThe source widget of the event.
idAn identifier of the event.

Definition at line 106 of file actionevent.h.

106  :
107  Event(source),
108  mId(id)
109  {
110  }
std::string mId
Definition: actionevent.h:129
Event(Widget *const source)
Definition: event.h:86

Member Function Documentation

◆ getId()

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

Field Documentation

◆ mId

std::string ActionEvent::mId

Holds the identifier of the event.

Definition at line 129 of file actionevent.h.

Referenced by getId().

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