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) noexcept
	Constructs a ParamEventArgs.
	ParamEventArgs (const ParamEventArgs &) noexcept=default
	ParamEventArgs (ParamEventArgs &&) noexcept=default
const T &	getParam () const noexcept
	Gets the param stored in the event args.
const T *	operator-> () const noexcept
	Gets the param stored in the event args.
T *	operator-> () noexcept
	Gets the param stored in the event args.
const T &	operator* () const noexcept
	Gets the param stored in the event args.
T &	operator* () noexcept
	Gets the param stored in the event args.
ParamEventArgs &	operator= (const ParamEventArgs &) noexcept=default
ParamEventArgs &	operator= (ParamEventArgs &&) noexcept=default
Public Member Functions inherited from Nickvision::Events::EventArgs
	EventArgs () noexcept=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() [1/3]

template<typename T>

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

inlinenoexcept

Constructs a ParamEventArgs.

Parameters

param

The parameter to store in the event args

ParamEventArgs() [2/3]

template<typename T>

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

defaultnoexcept

ParamEventArgs() [3/3]

template<typename T>

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

defaultnoexcept

Member Function Documentation

getParam()

template<typename T>

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

inlinenoexcept

Gets the param stored in the event args.

Returns

The param stored

operator*() [1/2]

template<typename T>

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

inlinenoexcept

Gets the param stored in the event args.

Returns

The param stored

operator*() [2/2]

template<typename T>

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

inlinenoexcept

Gets the param stored in the event args.

Returns

The param stored

operator->() [1/2]

template<typename T>

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

inlinenoexcept

Gets the param stored in the event args.

Returns

The param stored

operator->() [2/2]

template<typename T>

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

inlinenoexcept

Gets the param stored in the event args.

Returns

The param stored

operator=() [1/2]

template<typename T>

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

defaultnoexcept

operator=() [2/2]

template<typename T>

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

defaultnoexcept

---

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

• include/events/parameventargs.h