lxgui
Public Member Functions | List of all members
lxgui::gui::event_data Class Reference

Stores a variable number of arguments for an event. More...

#include <gui_event_data.hpp>

Public Member Functions

 event_data ()=default
 Default constructor. More...
 
 event_data (std::initializer_list< utils::variant > data)
 List constructor. More...
 
 event_data (const event_data &)=default
 
 event_data (event_data &&)=default
 
event_dataoperator= (const event_data &)=default
 
event_dataoperator= (event_data &&)=default
 
template<typename T >
void add (T &&value)
 Adds a parameter to this event. More...
 
const utils::variantget (std::size_t index) const
 Returns a parameter of this event. More...
 
utils::variantget (std::size_t index)
 Returns a parameter of this event. More...
 
template<typename T >
const T & get (std::size_t index) const
 Returns a parameter of this event. More...
 
template<typename T >
T & get (std::size_t index)
 Returns a parameter of this event. More...
 
std::size_t get_param_count () const
 Returns the number of parameters. More...
 

Detailed Description

Stores a variable number of arguments for an event.

Definition at line 14 of file gui_event_data.hpp.

Constructor & Destructor Documentation

◆ event_data() [1/4]

lxgui::gui::event_data::event_data ( )
default

Default constructor.

◆ event_data() [2/4]

lxgui::gui::event_data::event_data ( std::initializer_list< utils::variant data)

List constructor.

Definition at line 5 of file gui_event_data.cpp.

◆ event_data() [3/4]

lxgui::gui::event_data::event_data ( const event_data )
default

◆ event_data() [4/4]

lxgui::gui::event_data::event_data ( event_data &&  )
default

Member Function Documentation

◆ add()

template<typename T >
void lxgui::gui::event_data::add ( T &&  value)
inline

Adds a parameter to this event.

Parameters
valueThe value

Definition at line 33 of file gui_event_data.hpp.

◆ get() [1/4]

utils::variant& lxgui::gui::event_data::get ( std::size_t  index)
inline

Returns a parameter of this event.

Parameters
indexThe index of the parameter (see get_param_count())
Returns
A parameter of this event

Definition at line 53 of file gui_event_data.hpp.

◆ get() [2/4]

template<typename T >
T& lxgui::gui::event_data::get ( std::size_t  index)
inline

Returns a parameter of this event.

Parameters
indexThe index of the parameter (see get_param_count())
Returns
A parameter of this event

Definition at line 75 of file gui_event_data.hpp.

◆ get() [3/4]

const utils::variant& lxgui::gui::event_data::get ( std::size_t  index) const
inline

Returns a parameter of this event.

Parameters
indexThe index of the parameter (see get_param_count())
Returns
A parameter of this event

Definition at line 42 of file gui_event_data.hpp.

◆ get() [4/4]

template<typename T >
const T& lxgui::gui::event_data::get ( std::size_t  index) const
inline

Returns a parameter of this event.

Parameters
indexThe index of the parameter (see get_param_count())
Returns
A parameter of this event

Definition at line 65 of file gui_event_data.hpp.

◆ get_param_count()

std::size_t lxgui::gui::event_data::get_param_count ( ) const
inline

Returns the number of parameters.

Returns
The number of parameters

Definition at line 83 of file gui_event_data.hpp.

◆ operator=() [1/2]

event_data& lxgui::gui::event_data::operator= ( const event_data )
default

◆ operator=() [2/2]

event_data& lxgui::gui::event_data::operator= ( event_data &&  )
default

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