ACF $AcfVersion:0$
Public Types | Signals | Public Member Functions | Protected Slots | Protected Member Functions | List of all members
iqtgui::CSplashScreenGuiComp Class Reference

#include <CSplashScreenGuiComp.h>

Inheritance diagram for iqtgui::CSplashScreenGuiComp:
iqtgui::TDesignerGuiCompBase< Ui::CSplashScreenGuiComp, CSplashScreenCustom > ilog::IMessageConsumer iqtgui::TGuiComponentBase< WidgetType > istd::IPolymorphic iqtgui::CGuiComponentBase iqtgui::TMakeIconProviderCompWrap< ibase::TLocalizableWrap< icomp::CComponentBase > > iqtgui::IGuiObject iqtgui::TDesignSchemaHandlerWrap< Base > iqtgui::CIconProvider istd::IPolymorphic

Public Types

typedef TDesignerGuiCompBase< Ui::CSplashScreenGuiComp, CSplashScreenCustomBaseClass
 
- Public Types inherited from iqtgui::TGuiComponentBase< WidgetType >
typedef CGuiComponentBase BaseClass
 
- Public Types inherited from iqtgui::CGuiComponentBase
typedef TMakeIconProviderCompWrap< ibase::TLocalizableWrap< icomp::CComponentBase > > BaseClass
 
- Public Types inherited from iqtgui::TMakeIconProviderCompWrap< ibase::TLocalizableWrap< icomp::CComponentBase > >
typedef ibase::TLocalizableWrap< icomp::CComponentBaseBaseClass
 
- Public Types inherited from iqtgui::TDesignSchemaHandlerWrap< Base >
typedef Base BaseClass
 
- Public Types inherited from ilog::IMessageConsumer
typedef istd::TSharedInterfacePtr< istd::IInformationProviderMessagePtr
 Shared pointer type for message objects.
 

Signals

void EmitAddMessage (const MessagePtr &messagePtr)
 

Public Member Functions

 CSplashScreenGuiComp ()
 
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 iqtgui::TGuiComponentBase< WidgetType >
 TGuiComponentBase ()
 
virtual WidgetType * GetQtWidget () const
 
virtual QWidget * CreateQtWidget (QWidget *parentPtr) override
 Create slave widget object.
 
- Public Member Functions inherited from iqtgui::CGuiComponentBase
 I_REGISTER_SUBELEMENT_INTERFACE_T (VisualStatus, IVisualStatus, ExtractVisualStatus)
 
 I_REGISTER_SUBELEMENT_INTERFACE_T (VisualStatus, istd::IChangeable, ExtractVisualStatus)
 
 I_REGISTER_SUBELEMENT_INTERFACE_T (VisualStatus, imod::IModel, ExtractVisualStatus)
 
 CGuiComponentBase ()
 
bool IsGuiShown () const
 
virtual bool IsGuiCreated () const override
 Checks if the GUI has been initialized and created.
 
virtual bool CreateGui (QWidget *parentPtr) override
 Initializes the GUI and connects it to the parent widget.
 
virtual bool DestroyGui () override
 Releases GUI resources and disconnects from the parent.
 
virtual QWidget * GetWidget () const override
 Gets access to the internal QWidget object.
 
virtual void OnTryClose (bool *ignoredPtr=NULL) override
 Called when the application is attempting to close.
 
- Public Member Functions inherited from iqtgui::TDesignSchemaHandlerWrap< Base >
 TDesignSchemaHandlerWrap ()
 
virtual void EnableDesignHandler (bool enable=true)
 If enabled, listen to the design schema change events from the application context.
 
- Public Member Functions inherited from iqtgui::CIconProvider
virtual QIcon GetIcon (const QString &iconName) const
 
virtual QString GetIconPath (const QString &iconName) const
 
virtual QString GetStyleSheetPath (const QString &styleSheetPath) const
 
QByteArray GetCurrentThemeId () const
 
void SetThemeId (const QByteArray &themeId)
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Protected Slots

void OnAddMessage (const MessagePtr &messagePtr)
 

Protected Member Functions

virtual void OnGuiCreated () override
 Called just after GUI is initialized.
 
virtual void OnGuiRetranslate () override
 Called from widget event filter when GUI should be retranslated.
 
- Protected Member Functions inherited from iqtgui::CGuiComponentBase
virtual void OnGuiDesignChanged ()
 
virtual void OnGuiShown ()
 Called from widget event filter when slave widget is shown.
 
virtual void OnGuiHidden ()
 Called from widget event filter when slave widget is hidden.
 
virtual bool OnKeyPressed (QKeyEvent *event)
 Called from widget event filter when key is pressed.
 
virtual void OnRetranslate ()
 Called when non-GUI elements (like commands) should be retranslated.
 
virtual void OnGuiDestroyed ()
 Called just before GUI is released.
 
void SetStatusIcon (const QIcon &icon)
 Set status icon;.
 
void SetStatusText (const QString &text)
 Set status text;.
 
void SetDefaultVisualStatus ()
 
virtual void OnLanguageChanged () override
 
virtual void OnDesignSchemaChanged (const QByteArray &themeId) override
 
virtual bool eventFilter (QObject *sourcePtr, QEvent *eventPtr) override
 
virtual void OnComponentCreated () override
 
virtual void OnComponentDestroyed () override
 
- Protected Member Functions inherited from iqtgui::CIconProvider
virtual QIcon CreateIcon (const QString &iconName) const
 

Additional Inherited Members

- Protected Attributes inherited from iqtgui::CGuiComponentBase
imod::TModelWrap< VisualStatusm_visualStatus
 

Detailed Description

Definition at line 42 of file CSplashScreenGuiComp.h.

Member Typedef Documentation

◆ BaseClass

Definition at line 48 of file CSplashScreenGuiComp.h.

Constructor & Destructor Documentation

◆ CSplashScreenGuiComp()

iqtgui::CSplashScreenGuiComp::CSplashScreenGuiComp ( )

Member Function Documentation

◆ AddMessage()

virtual void iqtgui::CSplashScreenGuiComp::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
messagePtrShared 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
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
Basic implementation of the istd::IInformationProvider interface for log messages.
Definition CMessage.h:80
@ IC_ERROR
Information about error, processing could not be done correctly.
Shared ownership smart pointer for interface types.
See also
IsMessageSupported()

Implements ilog::IMessageConsumer.

◆ EmitAddMessage

void iqtgui::CSplashScreenGuiComp::EmitAddMessage ( const MessagePtr messagePtr)
signal

◆ IsMessageSupported()

virtual bool iqtgui::CSplashScreenGuiComp::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
messageCategoryCategory 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
messageIdNumeric ID of message or -1 if ID check should be skipped. Message IDs are application-defined for filtering and routing.
messagePtrOptional 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
if (consumer->IsMessageSupported(-1, -1, &msg)) {
// Consumer accepts this specific message
}
@ IC_INFO
Normal information level.
@ IC_WARNING
Information about warning, processing could be done.

Implements ilog::IMessageConsumer.

◆ OnAddMessage

void iqtgui::CSplashScreenGuiComp::OnAddMessage ( const MessagePtr messagePtr)
protectedslot

◆ OnGuiCreated()

virtual void iqtgui::CSplashScreenGuiComp::OnGuiCreated ( )
overrideprotectedvirtual

Called just after GUI is initialized.

Reimplemented from iqtgui::CGuiComponentBase.

◆ OnGuiRetranslate()

virtual void iqtgui::CSplashScreenGuiComp::OnGuiRetranslate ( )
overrideprotectedvirtual

Called from widget event filter when GUI should be retranslated.

Reimplemented from iqtgui::CGuiComponentBase.


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