Object Class Reference

Base object class with fundamental properties. More...

#include <object.h>

Inheritance diagram for Object:

Classes
struct	CallbackMeta
	Manages metadata about a registered callback. More...

Public Types
using	EventCallback = std::function< void(Event &event)>
	Event handler callback function.
using	FilterFlags = FlagsBase< EventId >
	Event handler EventId filter.
using	RegisterHandle = uint64_t
	Handle type.

Public Member Functions
	Object () noexcept=default
	Object (const Object &)=delete
	Object (Object &&)=default
virtual	~Object () noexcept=default
void	clear_handlers ()
	Clear all registered event handlers.
void	invoke_handlers (Event &event)
	Invoke all handlers with the specified event.
void	invoke_handlers (EventId event)
	Invoke all handlers with the specified EventId.
EGT_NODISCARD const std::string &	name () const
	Get the name of the Object.
void	name (const std::string &name)
	Set the name of the Object.
RegisterHandle	on_event (const EventCallback &handler, const FilterFlags &mask={})
	Add an event handler to be called when the widget generates an event.
Object &	operator= (const Object &)=delete
Object &	operator= (Object &&)=default
void	remove_handler (RegisterHandle handle)
	Remove an event handler.

Protected Types
using	CallbackArray = std::vector< CallbackMeta >
	Helper type for an array of callbacks.

Protected Attributes
detail::CopyOnWriteAllocate< CallbackArray >	m_callbacks
	Array of callbacks.
RegisterHandle	m_handle_counter {0}
	Counter used to generate unique handles for each callback registration.
std::string	m_name
	A user defined name for the Object.

Detailed Description

Base object class with fundamental properties.

Member Typedef Documentation

CallbackArray

using CallbackArray = std::vector<CallbackMeta>

protected

Helper type for an array of callbacks.

EventCallback

using EventCallback = std::function<void (Event& event)>

Event handler callback function.

FilterFlags

using FilterFlags = FlagsBase<EventId>

Event handler EventId filter.

RegisterHandle

using RegisterHandle = uint64_t

Handle type.

Constructor & Destructor Documentation

Object() [1/3]

Object ( )

defaultnoexcept

Object() [2/3]

Object ( const Object &  )

delete

Object() [3/3]

Object ( Object &&  )

default

~Object()

virtual ~Object ( )

virtualdefaultnoexcept

Member Function Documentation

clear_handlers()

void clear_handlers

(

)

Clear all registered event handlers.

invoke_handlers() [1/2]

void invoke_handlers

(

Event &

event

)

Invoke all handlers with the specified event.

Parameters

event

The event to invoke.

invoke_handlers() [2/2]

void invoke_handlers

(

EventId

event

)

Invoke all handlers with the specified EventId.

Parameters

event

The EventId to invoke.

name() [1/2]

EGT_NODISCARD const std::string & name ( ) const

inline

Get the name of the Object.

name() [2/2]

void name ( const std::string &  name )

inline

Set the name of the Object.

Assigns a human readable name to an Object that can then be used to find timers by name or debug.

Parameters

[in]

name

Name to set for the Object.

on_event()

RegisterHandle on_event	(	const EventCallback &	handler,
		const FilterFlags &	mask = {}
	)

Add an event handler to be called when the widget generates an event.

Any number of handlers (callbacks) can be registered. Also, the same handler function can be registered multiple times, optionally with different masks.

Parameters

handler	The callback to invoke on event.
mask	An optional EventId mask specifying what events to invoke the handler with. If no mask is supplied, any EventId will cause the handler to be invoked.

Returns

A handle used to identify the registration. This can then be passed to remove_handler().

operator=() [1/2]

Object & operator= ( const Object &  )

delete

operator=() [2/2]

Object & operator= ( Object &&  )

default

remove_handler()

void remove_handler

(

RegisterHandle

handle

)

Remove an event handler.

Parameters

handle

The handle returned from on_event().

Member Data Documentation

m_callbacks

detail::CopyOnWriteAllocate<CallbackArray> m_callbacks

protected

Array of callbacks.

m_handle_counter

RegisterHandle m_handle_counter {0}

protected

Counter used to generate unique handles for each callback registration.

m_name

std::string m_name

protected

A user defined name for the Object.