iloggui::CMessageBoxComp Class Reference

Component for displaying log messages in modal Qt message boxes. More...

#include <CMessageBoxComp.h>

Inheritance diagram for iloggui::CMessageBoxComp:

Public Types
typedef icomp::CComponentBase	BaseClass
Public Types inherited from ilog::IMessageConsumer
typedef istd::TSharedInterfacePtr< istd::IInformationProvider >	MessagePtr
	Shared pointer type for message objects.

Signals
void	EmitAddMessage ()

Public Member Functions
	CMessageBoxComp ()
virtual bool	IsMessageSupported (int messageCategory=-1, int messageId=-1, const istd::IInformationProvider *messagePtr=NULL) const override
	Check if a message is supported by this consumer.
virtual void	AddMessage (const MessagePtr &messagePtr) override
	Adds a message to this consumer.
Public Member Functions inherited from icomp::CComponentBase
	CComponentBase ()
	Create component and assign it to specific context.
virtual const icomp::IComponent *	GetParentComponent (bool ownerOnly=false) const override
	Get parent of this component.
virtual void *	GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="") override
	Get access to specified component interface.
virtual IComponentContextSharedPtr	GetComponentContext () const override
	Get access to component context describing all application-specified component information loaded from components registry.
virtual void	SetComponentContext (const IComponentContextSharedPtr &contextPtr, const icomp::IComponent *parentPtr, bool isParentOwner) override
	Set component context of this component.
Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Protected Slots
virtual void	OnAddMessage ()

Protected Member Functions
QIcon	GetCategoryIcon (int category) const
	Get icons corresponding to specified information category.
virtual void	OnComponentCreated () override
virtual void	OnComponentDestroyed () override
Protected Member Functions inherited from icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.
virtual const icomp::IRealComponentStaticInfo &	GetComponentStaticInfo () const =0
	Get access to static info of this component.

Additional Inherited Members
Static Protected Member Functions inherited from icomp::CComponentBase
static const icomp::IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)
static QByteArray	GetComponentId (const icomp::IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())

Detailed Description

Component for displaying log messages in modal Qt message boxes.

CMessageBoxComp provides a simple way to display important messages (especially errors and warnings) to users in standard Qt message box dialogs. It implements IMessageConsumer to receive messages and displays them in modal dialogs with appropriate icons.

Messages are queued and displayed one at a time. If multiple messages are added before the dialog is shown, they're batched into a single dialog with a detailed text area.

Features

• Modal message box display
• Severity-appropriate icons (info, warning, critical)
• Thread-safe message queuing with QMutex
• Batch multiple messages into one dialog
• Signal/slot based asynchronous display
• Automatic message formatting

Message Icons

• IC_INFO, IC_NONE: Information icon (blue "i")
• IC_WARNING: Warning icon (yellow triangle)
• IC_ERROR, IC_CRITICAL: Critical icon (red "X")

Usage Example

// Create message box component
istd::TSharedInterfacePtr<iloggui::CMessageBoxComp> msgBox(
    new iloggui::CMessageBoxComp);
 
// Send error message (displays immediately)
msgBox->AddMessage(istd::TSharedInterfacePtr<ilog::CMessage>(
    new ilog::CMessage(
        istd::IInformationProvider::IC_CRITICAL,
        5001,
        "Database connection failed",
        "DatabaseManager"
    )
));
 
// Dialog blocks until user clicks OK

Component Configuration

<Component Id="ErrorDialog" Class="iloggui::CMessageBoxComp">
    <!-- No additional configuration needed -->
</Component>

Integration with Logging

// Create main log
istd::TSharedInterfacePtr<ilog::CLogComp> mainLog(
    new ilog::CLogComp);
 
// Create message box for errors
istd::TSharedInterfacePtr<iloggui::CMessageBoxComp> errorBox(
    new iloggui::CMessageBoxComp);
 
// Create router to send only errors to message box
istd::TSharedInterfacePtr<ilog::CLogRouterComp> router(
    new ilog::CLogRouterComp);
// Configure:
//   InputMessageContainer -> mainLog
//   OutputMessageConsumer -> errorBox
//   MinimalCategory -> IC_ERROR
 
// All messages go to log, but only errors show in dialogs

Warning

Message boxes are modal and block the application. Use sparingly for critical messages only, not for general logging.

See also

ilog::IMessageConsumer, ilog::CMessage, QMessageBox

Definition at line 105 of file CMessageBoxComp.h.

Member Typedef Documentation

BaseClass

typedef icomp::CComponentBase iloggui::CMessageBoxComp::BaseClass

Definition at line 113 of file CMessageBoxComp.h.

Constructor & Destructor Documentation

CMessageBoxComp()

iloggui::CMessageBoxComp::CMessageBoxComp

(

)

Member Function Documentation

AddMessage()

virtual void iloggui::CMessageBoxComp::AddMessage ( const MessagePtr &  messagePtr )

overridevirtual

Adds a message to this consumer.

This method transfers ownership of the message to the consumer via shared pointer. The consumer may store, display, forward, or otherwise process the message.

Most implementations deliver messages asynchronously using Qt signals/slots to ensure thread safety when messages are added from worker threads.

Parameters

messagePtr

Shared pointer to the message. After this call, the message is owned by the shared pointer and will be automatically deleted when no longer referenced.

Note

This method should not throw exceptions. Implementations should handle errors gracefully (e.g., by logging internally or ignoring invalid messages).

Warning

The message object should not be modified after being added to a consumer, as multiple consumers may reference the same message object.

Example

// Create message with shared pointer
istd::TSharedInterfacePtr<ilog::CMessage> msg(
    new ilog::CMessage(
        istd::IInformationProvider::IC_ERROR,
        2001,
        "File not found: config.xml",
        "ConfigLoader"
    )
);
 
// Add to consumer (ownership transferred)
consumer->AddMessage(msg);
 
// msg can still be used as shared pointer maintains reference count
// but don't modify the message after adding it

See also

IsMessageSupported()

Implements ilog::IMessageConsumer.

EmitAddMessage

void iloggui::CMessageBoxComp::EmitAddMessage ( )

signal

GetCategoryIcon()

QIcon iloggui::CMessageBoxComp::GetCategoryIcon ( int  category ) const

protected

Get icons corresponding to specified information category.

IsMessageSupported()

virtual bool iloggui::CMessageBoxComp::IsMessageSupported ( int  messageCategory = -1, int  messageId = -1, const istd::IInformationProvider *  messagePtr = NULL  ) const

overridevirtual

Check if a message is supported by this consumer.

This method allows consumers to filter messages based on category, ID, or the complete message object. It's used to determine whether a message should be sent to this consumer before actually adding it.

Parameters

messageCategory

Category of message (IC_NONE, IC_INFO, IC_WARNING, IC_ERROR, IC_CRITICAL) or -1 if category check should be skipped.

See also

istd::IInformationProvider::InformationCategory.

Parameters

messageId	Numeric ID of message or -1 if ID check should be skipped. Message IDs are application-defined for filtering and routing.
messagePtr	Optional pointer to complete message object for detailed inspection, or NULL if not needed. The consumer will not store this pointer.

Returns

true if the message is supported and should be sent to this consumer, false if the message should be filtered out.

Note

Returning false does not indicate an error; it simply means the message doesn't match the consumer's filter criteria.

Example

// Check if consumer accepts warnings
if (consumer->IsMessageSupported(istd::IInformationProvider::IC_WARNING)) {
    // Consumer accepts warnings
}
 
// Check specific message ID
if (consumer->IsMessageSupported(-1, 5001)) {
    // Consumer accepts message ID 5001
}
 
// Check complete message
ilog::CMessage msg(istd::IInformationProvider::IC_INFO, 1, "Test", "Source");
if (consumer->IsMessageSupported(-1, -1, &msg)) {
    // Consumer accepts this specific message
}

Implements ilog::IMessageConsumer.

OnAddMessage

virtual void iloggui::CMessageBoxComp::OnAddMessage ( )

protectedvirtualslot

OnComponentCreated()

virtual void iloggui::CMessageBoxComp::OnComponentCreated ( )

overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

OnComponentDestroyed()

virtual void iloggui::CMessageBoxComp::OnComponentDestroyed ( )

overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

---

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

• Acf/Include/iloggui/CMessageBoxComp.h