Simple class containing event information. More...

Public Types
enum	Type { Type::configure, Type::initialize, Type::periods, Type::run, Type::stop, Type::step, Type::quit, Type::none }
	The types of events that the GUI thread can send to the main thread. More...

Public Member Functions
	operator bool ()
	True if this is actually an event, false if this reflects that there are no events pending (that is, an event with `type = Event::Type::none`).

Public Attributes
Type	type = Type::none
	The type of the event.

Parameter	parameter
	Will be set to a list of configured GUI::Parameters if this is a setup event. More...

unsigned long	ul
	unsigned long integer value associated with the event. More...

Detailed Description

Simple class containing event information.

Member Enumeration Documentation

strong

The types of events that the GUI thread can send to the main thread.

Enumerator
configure	An event that configures a Parameter.
initialize	An event triggered when the user hits "begin" with configuration data.
periods	An event indicating that the number of periods is now known or has changed.
run	An event triggered when starting a new or resuming a stopped simulation.
stop	The user hit the "stop" button to pause the simulation.
step	The user hit the "step" button to unpause the simulation for one step.
quit	Sent when the user quits the application.
none	Fake Event indicating that no events are pending.

Parameter creativity::gui::GUI::Event::parameter

Will be set to a list of configured GUI::Parameters if this is a setup event.

The begin and finished GUI::Parameter meta-values are not included.

unsigned long creativity::gui::GUI::Event::ul

unsigned long integer value associated with the event.

Used by Event::Type::run to send the number of iterations to run.

Collaboration diagram for creativity::gui::GUI::Event:

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