ITEM_MODIFICATION_ROUTINE::CALLABLE_BASED_HANDLER Class Reference

A handler that is based on a set of callbacks provided by the user of the ITEM_MODIFICATION_ROUTINE. More...

#include <item_modification_routine.h>

Inheritance diagram for ITEM_MODIFICATION_ROUTINE::CALLABLE_BASED_HANDLER:

Public Types
using	CREATION_HANDLER = std::function<void( std::unique_ptr<BOARD_ITEM> )>
	Handler for creating a new item on the board.
using	MODIFICATION_HANDLER = std::function<void( BOARD_ITEM& )>
	Handler for modifying or deleting an existing item on the board.
using	DELETION_HANDLER = std::function<void( BOARD_ITEM& )>
	Handler for modifying or deleting an existing item on the board.

Public Member Functions
	CALLABLE_BASED_HANDLER (CREATION_HANDLER aCreationHandler, MODIFICATION_HANDLER aModificationHandler, DELETION_HANDLER aDeletionHandler)
void	AddNewItem (std::unique_ptr< BOARD_ITEM > aItem) override
	Report that the tools wants to add a new item to the board.
void	MarkItemModified (BOARD_ITEM &aItem) override
	Report that the tool has modified an item on the board.
void	DeleteItem (BOARD_ITEM &aItem) override
	Report that the tool has deleted an item on the board.

Public Attributes
CREATION_HANDLER	m_creationHandler
MODIFICATION_HANDLER	m_modificationHandler
DELETION_HANDLER	m_deletionHandler

Detailed Description

A handler that is based on a set of callbacks provided by the user of the ITEM_MODIFICATION_ROUTINE.

Definition at line 89 of file item_modification_routine.h.

Member Typedef Documentation

CREATION_HANDLER

using ITEM_MODIFICATION_ROUTINE::CALLABLE_BASED_HANDLER::CREATION_HANDLER = std::function<void( std::unique_ptr<BOARD_ITEM> )>

Handler for creating a new item on the board.

Parameters

BOARD_ITEM&

the item to add

Definition at line 97 of file item_modification_routine.h.

DELETION_HANDLER

using ITEM_MODIFICATION_ROUTINE::CALLABLE_BASED_HANDLER::DELETION_HANDLER = std::function<void( BOARD_ITEM& )>

Handler for modifying or deleting an existing item on the board.

Parameters

BOARD_ITEM&

the item to delete

Definition at line 111 of file item_modification_routine.h.

MODIFICATION_HANDLER

using ITEM_MODIFICATION_ROUTINE::CALLABLE_BASED_HANDLER::MODIFICATION_HANDLER = std::function<void( BOARD_ITEM& )>

Handler for modifying or deleting an existing item on the board.

Parameters

BOARD_ITEM&

the item to modify

Definition at line 104 of file item_modification_routine.h.

Constructor & Destructor Documentation

CALLABLE_BASED_HANDLER()

ITEM_MODIFICATION_ROUTINE::CALLABLE_BASED_HANDLER::CALLABLE_BASED_HANDLER ( CREATION_HANDLER aCreationHandler, MODIFICATION_HANDLER aModificationHandler, DELETION_HANDLER aDeletionHandler )

inline

Definition at line 113 of file item_modification_routine.h.

References m_creationHandler, m_deletionHandler, m_modificationHandler, and move.

Member Function Documentation

AddNewItem()

void ITEM_MODIFICATION_ROUTINE::CALLABLE_BASED_HANDLER::AddNewItem ( std::unique_ptr< BOARD_ITEM > aItem )

inlineoverridevirtual

Report that the tools wants to add a new item to the board.

Parameters

aItem

the new item

Implements ITEM_MODIFICATION_ROUTINE::CHANGE_HANDLER.

Definition at line 127 of file item_modification_routine.h.

References m_creationHandler.

DeleteItem()

void ITEM_MODIFICATION_ROUTINE::CALLABLE_BASED_HANDLER::DeleteItem ( BOARD_ITEM & aItem )

inlineoverridevirtual

Report that the tool has deleted an item on the board.

Parameters

aItem

the deleted item

Implements ITEM_MODIFICATION_ROUTINE::CHANGE_HANDLER.

Definition at line 144 of file item_modification_routine.h.

References m_deletionHandler.

MarkItemModified()

void ITEM_MODIFICATION_ROUTINE::CALLABLE_BASED_HANDLER::MarkItemModified ( BOARD_ITEM & aItem )

inlineoverridevirtual

Report that the tool has modified an item on the board.

Parameters

aItem

the modified item

Implements ITEM_MODIFICATION_ROUTINE::CHANGE_HANDLER.

Definition at line 137 of file item_modification_routine.h.

References m_modificationHandler.

Member Data Documentation

m_creationHandler

CREATION_HANDLER ITEM_MODIFICATION_ROUTINE::CALLABLE_BASED_HANDLER::m_creationHandler

Definition at line 146 of file item_modification_routine.h.

Referenced by AddNewItem(), and CALLABLE_BASED_HANDLER().

m_deletionHandler

DELETION_HANDLER ITEM_MODIFICATION_ROUTINE::CALLABLE_BASED_HANDLER::m_deletionHandler

Definition at line 148 of file item_modification_routine.h.

Referenced by CALLABLE_BASED_HANDLER(), and DeleteItem().

m_modificationHandler

MODIFICATION_HANDLER ITEM_MODIFICATION_ROUTINE::CALLABLE_BASED_HANDLER::m_modificationHandler

Definition at line 147 of file item_modification_routine.h.

Referenced by CALLABLE_BASED_HANDLER(), and MarkItemModified().

---

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

• item_modification_routine.h