Nickvision::Events::ParamEventArgs< T > Class Template Reference

An event argument that contains a single parameter. More...

#include <parameventargs.h>

Inheritance diagram for Nickvision::Events::ParamEventArgs< T >:

Public Member Functions
	ParamEventArgs (const T &param)
	Constructs a ParamEventArgs.
const T &	getParam () const
	Gets the param stored in the event args.
const T &	operator-> () const
	Gets the param stored in the event args.
T &	operator-> ()
	Gets the param stored in the event args.
const T &	operator* () const
	Gets the param stored in the event args.
T &	operator* ()
	Gets the param stored in the event args.
Public Member Functions inherited from Nickvision::Events::EventArgs
	EventArgs ()=default
	Constructs an EventArgs.

Detailed Description

template<typename T>
class Nickvision::Events::ParamEventArgs< T >

An event argument that contains a single parameter.

T must be copy and move constructible.

Constructor & Destructor Documentation

ParamEventArgs()

template<typename T>

Nickvision::Events::ParamEventArgs< T >::ParamEventArgs ( const T & param )

inline

Constructs a ParamEventArgs.

Parameters

param

The parameter to store in the event args

Member Function Documentation

getParam()

template<typename T>

const T & Nickvision::Events::ParamEventArgs< T >::getParam ( ) const

inline

Gets the param stored in the event args.

Returns

The param stored

operator*() [1/2]

template<typename T>

T & Nickvision::Events::ParamEventArgs< T >::operator* ( )

inline

Gets the param stored in the event args.

Returns

The param stored

operator*() [2/2]

template<typename T>

const T & Nickvision::Events::ParamEventArgs< T >::operator* ( ) const

inline

Gets the param stored in the event args.

Returns

The param stored

operator->() [1/2]

template<typename T>

T & Nickvision::Events::ParamEventArgs< T >::operator-> ( )

inline

Gets the param stored in the event args.

Returns

The param stored

operator->() [2/2]

template<typename T>

const T & Nickvision::Events::ParamEventArgs< T >::operator-> ( ) const

inline

Gets the param stored in the event args.

Returns

The param stored

---

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

• include/events/parameventargs.h