Classes Files

Wombat::MamaSymbolListMembershipHandler

More…

#include <MamaSymbolListHandlerTypes.h>

Public Functions

  Name
virtual ~MamaSymbolListMembershipHandler()
virtual void onMemberAdd(MamaSymbolList & symbolList, MamaSymbolListMember & member) =0
virtual void onMemberRemove(MamaSymbolList & symbolList, MamaSymbolListMember & member) =0
virtual void onOrderChange(MamaSymbolList & symbolList) =0

Detailed Description

class Wombat::MamaSymbolListMembershipHandler;

The MamaSymbolListMembershipHandler interface. Instances of subclasses of this class can be registered with a MamaSymbolList in order to be notified of symbol add/remove events to the symbol list.

Public Functions Documentation

function ~MamaSymbolListMembershipHandler

inline virtual ~MamaSymbolListMembershipHandler()

function onMemberAdd

virtual void onMemberAdd(
    MamaSymbolList & symbolList,
    MamaSymbolListMember & member
) =0

Parameters:

  • symbolList The symbolList.
  • member The member just added to the list.

Method invoked when a symbol has been added to the list. Invocation of this function is conditional and is subject to a positive return (true) from the prior invocation of onDeclareInterest where the registered object has the opportunity to declare their interest in subsequent events on the given symbol.

function onMemberRemove

virtual void onMemberRemove(
    MamaSymbolList & symbolList,
    MamaSymbolListMember & member
) =0

Parameters:

  • symbolList The symbolList.
  • member The member just removed from the list.

Method invoked immediately prior to a symbol being removed from the list. Invocation of this function is conditional and is subject to a positive return (true) from the prior invocation of onDeclareInterest where the registered object has the opportunity to declare their interest in subsequent events on the given symbol.

function onOrderChange

virtual void onOrderChange(
    MamaSymbolList & symbolList
) =0

Parameters:

  • symbolList The symbol list.

Method invoked when the sorting of the symbol list has changed.


Updated on 2023-03-31 at 15:29:26 +0100