ACF $AcfVersion:0$
Classes | Public Types | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
iqtgui::CSimpleMainWindowGuiComp Class Reference

#include <CSimpleMainWindowGuiComp.h>

Inheritance diagram for iqtgui::CSimpleMainWindowGuiComp:
iqtgui::CSimpleMainWindowGuiCompBase iqtgui::TRestorableGuiWrap< iqtgui::TGuiComponentBase< QMainWindow > > iqtgui::TGuiComponentBase< QMainWindow > iqtgui::CGuiComponentBase iqtgui::TMakeIconProviderCompWrap< ibase::TLocalizableWrap< icomp::CComponentBase > > iqtgui::IGuiObject iqtgui::TDesignSchemaHandlerWrap< Base > iqtgui::CIconProvider istd::IPolymorphic iqtdoc::CMainWindowGuiCompBase iqtdoc::CMainWindowGuiComp

Classes

class  CommandsObserver
 

Public Types

enum  GroupId { GI_SETTINGS = 0x400 }
 
enum  ModelId { MI_PREFERENCE_COMMAND = 0x1000 }
 
typedef CSimpleMainWindowGuiCompBase BaseClass
 
- Public Types inherited from iqtgui::CSimpleMainWindowGuiCompBase
typedef iqtgui::TRestorableGuiWrap< iqtgui::TGuiComponentBase< QMainWindow > > BaseClass
 
- Public Types inherited from iqtgui::TRestorableGuiWrap< iqtgui::TGuiComponentBase< QMainWindow > >
typedef iqtgui::TGuiComponentBase< QMainWindow > BaseClass
 
- Public Types inherited from iqtgui::TGuiComponentBase< QMainWindow >
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 Member Functions

 CSimpleMainWindowGuiComp ()
 
virtual void OnTryClose (bool *ignoredPtr=NULL) override
 Called when the application is attempting to close.
 
- Public Member Functions inherited from iqtgui::TGuiComponentBase< QMainWindow >
 TGuiComponentBase ()
 
virtual QMainWindow * 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 QWidget * GetWidget () const override
 Gets access to the internal QWidget object.
 
- 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 OnShowToolbars ()
 
void OnFullScreen ()
 
void OnAbout ()
 
void OnHelpManual ()
 
void OnSettings ()
 
void OnShowOtherCommandTriggered (bool enabled)
 

Protected Member Functions

virtual void UpdateMenuActions ()
 
virtual void SetupMainWindowComponents (QMainWindow &mainWindow)
 
virtual void AddMainComponent (int componentIndex, iqtgui::IMainWindowComponent *componentPtr)
 
virtual void RemoveMainComponent (iqtgui::IMainWindowComponent *componentPtr)
 
virtual void CreateMenuBar ()
 
virtual void CreateDefaultToolBar ()
 
virtual void SetToolBarsVisible (bool isVisible=true)
 
virtual void SetupMenu ()
 
virtual void UpdateFixedCommands (iqtgui::CHierarchicalCommand &fixedCommands)
 
virtual void UpdateViewCommands (iqtgui::CHierarchicalCommand &viewCommand)
 
virtual void UpdateToolsCommands (iqtgui::CHierarchicalCommand &toolsCommand)
 
virtual void UpdateHelpCommands (iqtgui::CHierarchicalCommand &helpCommand)
 
virtual void AppendMenuActions (iqtgui::CHierarchicalCommand &menuCommands)
 
virtual void UpdateMainWindowComponentsVisibility ()
 Set main window visible or invisible, depending on menu commands.
 
virtual bool IsMainWindowActive (int index) const
 
virtual void OnRestoreSettings (const QSettings &settings) override
 
virtual void OnSaveSettings (QSettings &settings) const override
 
virtual void OnGuiCreated () override
 Called just after GUI is initialized.
 
virtual void OnGuiDestroyed () override
 Called just before GUI is released.
 
virtual void OnRetranslate () override
 Called when non-GUI elements (like commands) should be retranslated.
 
virtual void OnGuiShown () override
 Called from widget event filter when slave widget is shown.
 
virtual void OnGuiDesignChanged () override
 
virtual bool eventFilter (QObject *sourcePtr, QEvent *eventPtr) override
 
- Protected Member Functions inherited from iqtgui::TRestorableGuiWrap< iqtgui::TGuiComponentBase< QMainWindow > >
virtual bool CreateGui (QWidget *parentPtr) override
 
virtual bool DestroyGui () override
 
- Protected Member Functions inherited from iqtgui::CGuiComponentBase
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 OnGuiRetranslate ()
 Called from widget event filter when GUI should be retranslated.
 
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 void OnComponentCreated () override
 
virtual void OnComponentDestroyed () override
 
- Protected Member Functions inherited from iqtgui::CIconProvider
virtual QIcon CreateIcon (const QString &iconName) const
 

Protected Attributes

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

Detailed Description

Definition at line 82 of file CSimpleMainWindowGuiComp.h.

Member Typedef Documentation

◆ BaseClass

Definition at line 87 of file CSimpleMainWindowGuiComp.h.

Member Enumeration Documentation

◆ GroupId

Enumerator
GI_SETTINGS 

Definition at line 99 of file CSimpleMainWindowGuiComp.h.

◆ ModelId

Enumerator
MI_PREFERENCE_COMMAND 

Definition at line 104 of file CSimpleMainWindowGuiComp.h.

Constructor & Destructor Documentation

◆ CSimpleMainWindowGuiComp()

iqtgui::CSimpleMainWindowGuiComp::CSimpleMainWindowGuiComp ( )

Member Function Documentation

◆ AddMainComponent()

virtual void iqtgui::CSimpleMainWindowGuiComp::AddMainComponent ( int  componentIndex,
iqtgui::IMainWindowComponent componentPtr 
)
protectedvirtual

◆ AppendMenuActions()

virtual void iqtgui::CSimpleMainWindowGuiComp::AppendMenuActions ( iqtgui::CHierarchicalCommand menuCommands)
protectedvirtual

Reimplemented in iqtdoc::CMainWindowGuiComp.

◆ CreateDefaultToolBar()

virtual void iqtgui::CSimpleMainWindowGuiComp::CreateDefaultToolBar ( )
protectedvirtual

◆ CreateMenuBar()

virtual void iqtgui::CSimpleMainWindowGuiComp::CreateMenuBar ( )
protectedvirtual

◆ eventFilter()

virtual bool iqtgui::CSimpleMainWindowGuiComp::eventFilter ( QObject *  sourcePtr,
QEvent *  eventPtr 
)
overrideprotectedvirtual

Reimplemented from iqtgui::CGuiComponentBase.

Reimplemented in iqtdoc::CMainWindowGuiComp.

◆ IsMainWindowActive()

virtual bool iqtgui::CSimpleMainWindowGuiComp::IsMainWindowActive ( int  index) const
protectedvirtual

Reimplemented in iqtdoc::CMainWindowGuiComp.

◆ OnAbout

void iqtgui::CSimpleMainWindowGuiComp::OnAbout ( )
protectedslot

◆ OnFullScreen

void iqtgui::CSimpleMainWindowGuiComp::OnFullScreen ( )
protectedslot

◆ OnGuiCreated()

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

Called just after GUI is initialized.

Reimplemented from iqtgui::CGuiComponentBase.

Reimplemented in iqtdoc::CMainWindowGuiComp.

◆ OnGuiDesignChanged()

virtual void iqtgui::CSimpleMainWindowGuiComp::OnGuiDesignChanged ( )
overrideprotectedvirtual

Reimplemented from iqtgui::CGuiComponentBase.

Reimplemented in iqtdoc::CMainWindowGuiComp.

◆ OnGuiDestroyed()

virtual void iqtgui::CSimpleMainWindowGuiComp::OnGuiDestroyed ( )
overrideprotectedvirtual

Called just before GUI is released.

Reimplemented from iqtgui::CGuiComponentBase.

Reimplemented in iqtdoc::CMainWindowGuiComp.

◆ OnGuiShown()

virtual void iqtgui::CSimpleMainWindowGuiComp::OnGuiShown ( )
overrideprotectedvirtual

Called from widget event filter when slave widget is shown.

Reimplemented from iqtgui::CGuiComponentBase.

◆ OnHelpManual

void iqtgui::CSimpleMainWindowGuiComp::OnHelpManual ( )
protectedslot

◆ OnRestoreSettings()

virtual void iqtgui::CSimpleMainWindowGuiComp::OnRestoreSettings ( const QSettings &  settings)
overrideprotectedvirtual

◆ OnRetranslate()

virtual void iqtgui::CSimpleMainWindowGuiComp::OnRetranslate ( )
overrideprotectedvirtual

Called when non-GUI elements (like commands) should be retranslated.

Reimplemented from iqtgui::CGuiComponentBase.

Reimplemented in iqtdoc::CMainWindowGuiComp.

◆ OnSaveSettings()

virtual void iqtgui::CSimpleMainWindowGuiComp::OnSaveSettings ( QSettings &  settings) const
overrideprotectedvirtual

◆ OnSettings

void iqtgui::CSimpleMainWindowGuiComp::OnSettings ( )
protectedslot

◆ OnShowOtherCommandTriggered

void iqtgui::CSimpleMainWindowGuiComp::OnShowOtherCommandTriggered ( bool  enabled)
protectedslot

◆ OnShowToolbars

void iqtgui::CSimpleMainWindowGuiComp::OnShowToolbars ( )
protectedslot

◆ OnTryClose()

virtual void iqtgui::CSimpleMainWindowGuiComp::OnTryClose ( bool *  ignoredPtr = NULL)
overridevirtual

Called when the application is attempting to close.

This method is invoked before the application closes, giving the GUI component a chance to prevent the close operation (e.g., to save unsaved data, show confirmation dialogs, or perform cleanup operations).

Parameters
ignoredPtrOptional pointer to a boolean flag. If not nullptr and the component wants to prevent closing (e.g., user cancels a save dialog), the implementation should set *ignoredPtr to true. If nullptr, the close operation cannot be prevented.
Note
If ignoredPtr is nullptr, the implementation must not try to prevent closing and should only perform necessary cleanup.
This method may be called multiple times if the close is initially prevented but later attempted again.
// Example implementation
virtual void OnTryClose(bool* ignoredPtr)
{
if (m_hasUnsavedData) {
if (ignoredPtr) {
// Show save dialog
int result = QMessageBox::question(GetWidget(),
"Unsaved Changes",
"Do you want to save your changes?",
QMessageBox::Save | QMessageBox::Discard | QMessageBox::Cancel);
if (result == QMessageBox::Save) {
SaveData();
} else if (result == QMessageBox::Cancel) {
*ignoredPtr = true; // Prevent closing
return;
}
}
}
// Perform cleanup if needed
}
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.
See also
DestroyGui()

Reimplemented from iqtgui::CGuiComponentBase.

◆ RemoveMainComponent()

virtual void iqtgui::CSimpleMainWindowGuiComp::RemoveMainComponent ( iqtgui::IMainWindowComponent componentPtr)
protectedvirtual

◆ SetToolBarsVisible()

virtual void iqtgui::CSimpleMainWindowGuiComp::SetToolBarsVisible ( bool  isVisible = true)
protectedvirtual

◆ SetupMainWindowComponents()

virtual void iqtgui::CSimpleMainWindowGuiComp::SetupMainWindowComponents ( QMainWindow &  mainWindow)
protectedvirtual

◆ SetupMenu()

virtual void iqtgui::CSimpleMainWindowGuiComp::SetupMenu ( )
protectedvirtual

◆ UpdateFixedCommands()

virtual void iqtgui::CSimpleMainWindowGuiComp::UpdateFixedCommands ( iqtgui::CHierarchicalCommand fixedCommands)
protectedvirtual

Reimplemented in iqtdoc::CMainWindowGuiComp.

◆ UpdateHelpCommands()

virtual void iqtgui::CSimpleMainWindowGuiComp::UpdateHelpCommands ( iqtgui::CHierarchicalCommand helpCommand)
protectedvirtual

◆ UpdateMainWindowComponentsVisibility()

virtual void iqtgui::CSimpleMainWindowGuiComp::UpdateMainWindowComponentsVisibility ( )
protectedvirtual

Set main window visible or invisible, depending on menu commands.

◆ UpdateMenuActions()

virtual void iqtgui::CSimpleMainWindowGuiComp::UpdateMenuActions ( )
protectedvirtual

◆ UpdateToolsCommands()

virtual void iqtgui::CSimpleMainWindowGuiComp::UpdateToolsCommands ( iqtgui::CHierarchicalCommand toolsCommand)
protectedvirtual

Reimplemented in iqtdoc::CMainWindowGuiComp.

◆ UpdateViewCommands()

virtual void iqtgui::CSimpleMainWindowGuiComp::UpdateViewCommands ( iqtgui::CHierarchicalCommand viewCommand)
protectedvirtual

Member Data Documentation

◆ m_commandsObserver

CommandsObserver iqtgui::CSimpleMainWindowGuiComp::m_commandsObserver
protected

Definition at line 175 of file CSimpleMainWindowGuiComp.h.


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