ilog::IMessageConsumer Class Reference

Common interface for a message container consuming information objects (messages). More...

#include <IMessageConsumer.h>

Inheritance diagram for ilog::IMessageConsumer:

Collaboration diagram for ilog::IMessageConsumer:

Public Types
typedef std::shared_ptr< const istd::IInformationProvider >	MessagePtr

Public Member Functions
virtual bool	IsMessageSupported (int messageCategory=-1, int messageId=-1, const QByteArray *senderIdPtr=nullptr) const =0
	Check if some messge is supported.
virtual void	AddMessage (const MessagePtr &messagePtr)=0
	Adds a message item to the container.

Detailed Description

Common interface for a message container consuming information objects (messages).

Definition at line 23 of file IMessageConsumer.h.

Member Typedef Documentation

MessagePtr

std::shared_ptr<const istd::IInformationProvider> ilog::IMessageConsumer::MessagePtr

Definition at line 26 of file IMessageConsumer.h.

Member Function Documentation

AddMessage()

virtual void ilog::IMessageConsumer::AddMessage ( const MessagePtr & messagePtr )

pure virtual

Adds a message item to the container.

Implemented in icmpstr::CRegistryPropEditorComp::TextLog, ilog::CLogCompBase, ilog::CMessageContainer, ilog::TMessageDelegatorComp< BaseComponent >, ilog::TMessageDelegatorComp< icomp::CComponentBase >, iloggui::CLogGuiComp, iloggui::CMessageBoxComp, istdgui::CGuiApplicationComp::TrayMessages, and istdgui::CSplashScreenGuiComp.

IsMessageSupported()

virtual bool ilog::IMessageConsumer::IsMessageSupported ( int messageCategory = -1, int messageId = -1, const QByteArray * senderIdPtr = nullptr ) const

pure virtual

Check if some messge is supported.

Parameters

messageCategory

category of message or -1 if undefined,

See also

istd::IInformationProvider::InformationCategory.

Parameters

messageId	ID of message as defined in istd::IInformationProvider or -1 if undefined.
senderId	optional ID identifying the sender object.

Implemented in icmpstr::CRegistryPropEditorComp::TextLog, ilog::CMessageContainer, ilog::CStreamLogCompBase, ilog::TMessageDelegatorComp< BaseComponent >, ilog::TMessageDelegatorComp< icomp::CComponentBase >, iloggui::CLogGuiComp, iloggui::CMessageBoxComp, istdgui::CGuiApplicationComp::TrayMessages, and istdgui::CSplashScreenGuiComp.

---

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

• ilog/IMessageConsumer.h