Component for the layouting/grouping of the UI-subcomponents. More...

#include <CComposedGuiComp.h>

Inheritance diagram for iqtgui::CComposedGuiComp:

Public Types
typedef iqtgui::TRestorableGuiWrap< CMultiPageGuiCompBase >	BaseClass

Public Types inherited from iqtgui::TRestorableGuiWrap< CMultiPageGuiCompBase >
typedef CMultiPageGuiCompBase	BaseClass

Public Types inherited from iqtgui::CMultiPageGuiCompBase
enum	ModelId { MI_USER = 1000 }

typedef CMultiPageGuiCompAttr	BaseClass

typedef imod::CMultiModelDispatcherBase	BaseClass2

Public Types inherited from iqtgui::CMultiPageGuiCompAttr
typedef iqtgui::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::CComponentBase >	BaseClass

Public Types inherited from iqtgui::TDesignSchemaHandlerWrap< Base >
typedef Base	BaseClass

Public Member Functions
virtual int	GetPagesCount () const override
	Get the number of the pages in the UI container.

virtual iqtgui::IGuiObject *	GetPageGuiComponent (int pageIndex) const override
	Get the UI component for a given page.

Public Member Functions inherited from iqtgui::CMultiPageGuiCompBase
	I_REGISTER_SUBELEMENT_INTERFACE_T (PageModel, iprm::ISelectionParam, ExtractPageModel)

	I_REGISTER_SUBELEMENT_INTERFACE_T (PageModel, iprm::IOptionsList, ExtractPageModel)

	I_REGISTER_SUBELEMENT_INTERFACE_T (PageModel, iser::ISerializable, ExtractPageModel)

	I_REGISTER_SUBELEMENT_INTERFACE_T (PageModel, imod::IModel, ExtractPageModel)

	I_REGISTER_SUBELEMENT_INTERFACE_T (PageModel, istd::IChangeable, ExtractPageModel)

	I_REGISTER_SUBELEMENT_INTERFACE_T (PageModel, IMultiVisualStatusProvider, ExtractPageModel)

	CMultiPageGuiCompBase ()

iprm::ISelectionParam &	GetPageModelRef ()

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 Member Functions
QWidget *	GetPageContainerWidget () const

virtual void	OnRestoreSettings (const QSettings &settings) override

virtual void	OnSaveSettings (QSettings &settings) const override

virtual int	GetDesignType () const override
	Get the container UI mode.

virtual void	OnGuiCreated () override
	Called just after GUI is initialized.

Protected Member Functions inherited from iqtgui::TRestorableGuiWrap< CMultiPageGuiCompBase >
virtual bool	CreateGui (QWidget *parentPtr) override

virtual bool	DestroyGui () override

Protected Member Functions inherited from iqtgui::CMultiPageGuiCompBase
virtual int	GetLogicalPageIndex (int physicalWidgetIndex) const
	Get logical page index from a given widget index.

virtual bool	CreatePage (int pageIndex)
	Create a page in the page container widget.

virtual void	RemovePage (int pageIndex)
	Remove a page from the container widget.

virtual void	SetCurrentPage (int pageIndex)
	Set current page.

virtual void	UpdateVisualElements ()
	Update visual status of the page elements.

virtual void	CreatePages ()
	Create all container pages.

virtual void	ResetPages ()
	Clear all container pages.

virtual QWidget *	CreateQtWidget (QWidget *parentPtr) override
	Create slave widget object.

virtual void	OnGuiDestroyed () override
	Called just before GUI is released.

virtual void	OnGuiRetranslate () override
	Called from widget event filter when GUI should be retranslated.

virtual void	OnTryClose (bool *ignoredPtr=NULL) override
	Called when the application is attempting to close.

virtual void	OnComponentCreated () override

virtual void	OnComponentDestroyed () override

virtual void	OnModelChanged (int modelId, const istd::IChangeable::ChangeSet &changeSet) override
	Called when some model observed by dispatcher will be changed.

bool	EnsurePageInitialized (int pageIndex)

Protected Member Functions inherited from iqtgui::CMultiPageGuiCompAttr
	I_MULTITEXTATTR (m_pageNamesAttrPtr)

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.

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

Protected Member Functions inherited from iqtgui::CIconProvider
virtual QIcon	CreateIcon (const QString &iconName) const

bool	RegisterModel (IModel *modelPtr, int modelId=0, const istd::IChangeable::ChangeSet &relevantFlags=istd::IChangeable::GetAllChanges())
	Register the data model to be observed.

void	UnregisterModel (int modelId=0)
	Unregister the data model object.

void	UnregisterAllModels ()
	Unregister all observed data objects.

template<class Object >
Object *	GetObjectAt (int modelId) const
	Get concrete object instance of the obsered model.

Additional Inherited Members
Protected Slots inherited from iqtgui::CMultiPageGuiCompBase
virtual void	OnPageChanged (int widgetIndex)

Protected Attributes inherited from iqtgui::CMultiPageGuiCompBase
imod::TModelWrap< PageModel >	m_pageModel

Protected Attributes inherited from iqtgui::CGuiComponentBase
imod::TModelWrap< VisualStatus >	m_visualStatus

Detailed Description

Component for the layouting/grouping of the UI-subcomponents.

Five different types of the layout/grouping are provided:

Vertical or horizontal placing of components without any visible container
Vertical or horizontal placing of components in a labeled group box
Vertical or horizontal placing of component in a splitted view
Tool box
Tab widget
Stacked widget
Collaplsible page
Mini-widget

Definition at line 38 of file CComposedGuiComp.h.

Member Typedef Documentation

◆ BaseClass

typedef iqtgui::TRestorableGuiWrap<CMultiPageGuiCompBase> iqtgui::CComposedGuiComp::BaseClass

Definition at line 42 of file CComposedGuiComp.h.

Member Function Documentation

◆ GetDesignType()

virtual int iqtgui::CComposedGuiComp::GetDesignType ( ) const

overrideprotectedvirtual

Get the container UI mode.

See also: iqtgui::CMultiPageWidget::DesignType

Implements iqtgui::CMultiPageGuiCompBase.

◆ GetPageContainerWidget()

QWidget * iqtgui::CComposedGuiComp::GetPageContainerWidget ( ) const

protected

◆ GetPageGuiComponent()

virtual iqtgui::IGuiObject * iqtgui::CComposedGuiComp::GetPageGuiComponent ( int pageIndex ) const

overridevirtual

Get the UI component for a given page.

Implements iqtgui::CMultiPageGuiCompBase.

◆ GetPagesCount()

virtual int iqtgui::CComposedGuiComp::GetPagesCount ( ) const

overridevirtual

Get the number of the pages in the UI container.

Implements iqtgui::CMultiPageGuiCompBase.

◆ OnGuiCreated()

virtual void iqtgui::CComposedGuiComp::OnGuiCreated ( )

overrideprotectedvirtual

Called just after GUI is initialized.

Reimplemented from iqtgui::CMultiPageGuiCompBase.

Reimplemented in iqtgui::TGuiObserverWrap< iqtgui::CComposedGuiComp, imod::TSingleModelObserverBase< iprm::IParamsSet > >, and iqtprm::CExtComposedParamsSetGuiComp.

◆ OnRestoreSettings()

virtual void iqtgui::CComposedGuiComp::OnRestoreSettings ( const QSettings & settings )

overrideprotectedvirtual

Implements iqtgui::TRestorableGuiWrap< CMultiPageGuiCompBase >.

◆ OnSaveSettings()

virtual void iqtgui::CComposedGuiComp::OnSaveSettings ( QSettings & settings ) const

overrideprotectedvirtual

Implements iqtgui::TRestorableGuiWrap< CMultiPageGuiCompBase >.

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

Acf/Include/iqtgui/CComposedGuiComp.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ GetDesignType()

◆ GetPageContainerWidget()

◆ GetPageGuiComponent()

◆ GetPagesCount()

◆ OnGuiCreated()

◆ OnRestoreSettings()

◆ OnSaveSettings()