orxonox::ChatListener Class Reference

Classes inheriting from this interface get a notification whenever a chat message was sent through ChatManager. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/orxonox/chat/ChatListener.h>

Inheritance diagram for orxonox::ChatListener:

Public Member Functions
	ChatListener ()
virtual	~ChatListener ()
Public Member Functions inherited from orxonox::Listable
	Listable ()
	Constructor: Allocates space in the element list. More...
	Listable (Context *context)
	Constructor: Allocates space in the element list and assigns the context. More...
virtual	~Listable ()
	Destructor: Removes the object from the object-lists. More...
Context *	getContext () const
void	setContext (Context *context)
	Changes the context. More...
void	unregisterObject ()
	Removes this object from the object-lists. More...
Public Member Functions inherited from orxonox::Identifiable
	Identifiable ()
	Constructor: Sets the default values. More...
virtual	~Identifiable ()
ORX_FORCEINLINE void *	getDerivedPointer (unsigned int classID)
	Returns a valid pointer of any derived type that is registered in the class hierarchy. More...
template<class T >
ORX_FORCEINLINE T *	getDerivedPointer (unsigned int classID)
	Version of getDerivedPointer with template. More...
template<class T >
ORX_FORCEINLINE const T *	getDerivedPointer (unsigned int classID) const
	Const version of getDerivedPointer with template. More...
Identifier *	getIdentifier () const
	Returns the Identifier of the object. More...
bool	isA (const Identifier *identifier)
	Returns true if the object's class is of the given type or a derivative. More...
template<class B >
bool	isA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is of the given type or a derivative. More...
bool	isA (const Identifiable *object)
	Returns true if the object's class is of the given type or a derivative. More...
bool	isChildOf (const Identifier *identifier)
	Returns true if the object's class is a child of the given type. More...
template<class B >
bool	isChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a child of the given type. More...
bool	isChildOf (const Identifiable *object)
	Returns true if the object's class is a child of the given type. More...
bool	isDirectChildOf (const Identifier *identifier)
	Returns true if the object's class is a direct child of the given type. More...
template<class B >
bool	isDirectChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct child of the given type. More...
bool	isDirectChildOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...
bool	isDirectParentOf (const Identifier *identifier)
	Returns true if the object's class is a direct parent of the given type. More...
template<class B >
bool	isDirectParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct parent of the given type. More...
bool	isDirectParentOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...
bool	isExactlyA (const Identifier *identifier)
	Returns true if the object's class is exactly of the given type. More...
template<class B >
bool	isExactlyA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is exactly of the given type. More...
bool	isExactlyA (const Identifiable *object)
	Returns true if the object's class is exactly of the given type. More...
bool	isParentOf (const Identifier *identifier)
	Returns true if the object's class is a parent of the given type. More...
template<class B >
bool	isParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a parent of the given type. More...
bool	isParentOf (const Identifiable *object)
	Returns true if the object's class is a parent of the given type. More...

Protected Member Functions
virtual void	incomingChat (const std::string &message, const std::string &name)=0
	Gets called whenever a chat message was sent through ChatManager. More...

Friends
class	ChatManager

Detailed Description

Classes inheriting from this interface get a notification whenever a chat message was sent through ChatManager.

Constructor & Destructor Documentation

orxonox::ChatListener::ChatListener

(

)

virtual orxonox::ChatListener::~ChatListener ( )

inlinevirtual

Member Function Documentation

virtual void orxonox::ChatListener::incomingChat ( const std::string &  message, const std::string &  name  )

protectedpure virtual

Gets called whenever a chat message was sent through ChatManager.

Parameters

message	The whole message (including name of the sender if available)
name	The name of the sender (if available, otherwise "")

Implemented in orxonox::ChatInputHandler, orxonox::ChatHistory, and orxonox::ChatOverlay.

Friends And Related Function Documentation

friend class ChatManager

friend

---

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

• orxonox/chat/ChatListener.h
• orxonox/chat/ChatManager.cc