ICF 3.1.1.10
Technical documentation of ICF Libraries
istdgui::CMultiPageGuiCompBase Class Referenceabstract

#include <CMultiPageGuiCompBase.h>

Inheritance diagram for istdgui::CMultiPageGuiCompBase:
Collaboration diagram for istdgui::CMultiPageGuiCompBase:

Public Types

enum  ModelId { MI_USER = 1000 }
 
typedef CMultiPageGuiCompAttr BaseClass
 
typedef imod::CMultiModelDispatcherBase BaseClass2
 
- Public Types inherited from istdgui::CMultiPageGuiCompAttr
typedef istdgui::CGuiComponentBase BaseClass
 
- Public Types inherited from istdgui::CGuiComponentBase
typedef ibase::TVisualChangesHandlerWrap< icomp::CComponentBase > BaseClass
 
- Public Types inherited from ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >
typedef icomp::CComponentBase BaseClass
 

Public Member Functions

 CMultiPageGuiCompBase ()
 
iprm::ISelectionParam & GetPageModelRef ()
 
virtual int GetPagesCount () const =0
 Get the number of the pages in the UI container.
 
virtual istdgui::IGuiObject * GetPageGuiComponent (int pageIndex) const =0
 Get the UI component for a given page.
 
- Public Member Functions inherited from istdgui::CGuiComponentBase
 CGuiComponentBase ()
 
bool IsGuiShown () const
 
bool IsGuiCreated () const override
 Inform if GUI was initilized.
 
bool CreateGui (QWidget *parentPtr) override
 Initialize GUI and connect it to the parent.
 
bool DestroyGui () override
 Release GUI and disconnect it from parent.
 
QWidget * GetWidget () const override
 Get access to internal QWidget object.
 
- Public Member Functions inherited from ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >
 TVisualChangesHandlerWrap (Args &&... args)
 
virtual void EnableVisualChangesHandler (bool enableLocalization=true)
 If enabled, listen to the language change event from the application context.
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context.
 
 CComponentBase (const CComponentBase &)=delete
 
CComponentBase & operator= (const CComponentBase &)=delete
 
virtual const ICompositeComponent * GetParentComponent (bool ownerOnly=false) const
 Get parent of this component.
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
 Get access to specified component interface.
 
virtual const IComponentContext * GetComponentContext () const
 Get access to component context describing all application-specified component information loaded from components registry.
 
virtual void SetComponentContext (const IComponentContext *contextPtr, const ICompositeComponent *parentPtr, bool isParentOwner)
 Set component context of this component.
 
- Public Member Functions inherited from icomp::IComponent
- Public Member Functions inherited from istdgui::IGuiObject

Protected Slots

virtual void OnPageChanged (int widgetIndex)
 

Protected Member Functions

virtual int GetDesignType () const =0
 Get the container UI mode.
 
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.
 
QWidget * CreateQtWidget (QWidget *parentPtr) override
 Create slave widget object.
 
void OnGuiCreated () override
 Called just after GUI is initialized.
 
void OnGuiDestroyed () override
 Called just before GUI is released.
 
void OnGuiRetranslate () override
 Called from widget event filter when GUI should be retranslated.
 
void OnTryClose (bool *ignoredPtr=nullptr) override
 Called on trying to close application.
 
void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
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 istdgui::CGuiComponentBase
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 OnLanguageChanged () override
 
void OnDesignSchemaChanged () override
 
bool eventFilter (QObject *sourcePtr, QEvent *eventPtr) override
 
- Protected Member Functions inherited from ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active.
 
virtual const IRealComponentStaticInfo & GetComponentStaticInfo () const =0
 Get access to static info of this component.
 
- Protected Member Functions inherited from imod::CMultiModelDispatcherBase
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.
 

Protected Attributes

imod::TModelWrap< PageModel > m_pageModel
 
- Protected Attributes inherited from istdgui::CGuiComponentBase
istd::CMainThreadCaller m_updateGuiCaller
 
imod::TModelWrap< VisualStatus > m_visualStatus
 

Additional Inherited Members

- Static Public Member Functions inherited from istdgui::CGuiComponentBase
static void MakeAutoSlotConnection (const QWidget &widget, QObject &object)
 
- Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfo & InitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 

Detailed Description

Definition at line 58 of file CMultiPageGuiCompBase.h.

Member Typedef Documentation

◆ BaseClass

◆ BaseClass2

Member Enumeration Documentation

◆ ModelId

Enumerator
MI_USER 

Minimal number which should be used for user-specific data models.

Definition at line 67 of file CMultiPageGuiCompBase.h.

Constructor & Destructor Documentation

◆ CMultiPageGuiCompBase()

istdgui::CMultiPageGuiCompBase::CMultiPageGuiCompBase ( )

Member Function Documentation

◆ CreatePage()

virtual bool istdgui::CMultiPageGuiCompBase::CreatePage ( int pageIndex)
protectedvirtual

Create a page in the page container widget.

◆ CreatePages()

virtual void istdgui::CMultiPageGuiCompBase::CreatePages ( )
protectedvirtual

Create all container pages.

Reimplemented in iprmgui::CExtComposedParamsSetGuiComp.

◆ CreateQtWidget()

QWidget * istdgui::CMultiPageGuiCompBase::CreateQtWidget ( QWidget * parentPtr)
overrideprotectedvirtual

Create slave widget object.

Implements istdgui::CGuiComponentBase.

◆ EnsurePageInitialized()

bool istdgui::CMultiPageGuiCompBase::EnsurePageInitialized ( int pageIndex)
protected

◆ GetDesignType()

virtual int istdgui::CMultiPageGuiCompBase::GetDesignType ( ) const
protectedpure virtual

Get the container UI mode.

See also
istdgui::CMultiPageWidget::DesignType

Implemented in istdgui::CComposedGuiComp, and istdgui::CTabContainerGuiComp.

◆ GetLogicalPageIndex()

virtual int istdgui::CMultiPageGuiCompBase::GetLogicalPageIndex ( int physicalWidgetIndex) const
protectedvirtual

Get logical page index from a given widget index.

◆ GetPageGuiComponent()

virtual istdgui::IGuiObject * istdgui::CMultiPageGuiCompBase::GetPageGuiComponent ( int pageIndex) const
pure virtual

Get the UI component for a given page.

Implemented in istdgui::CComposedGuiComp, and istdgui::CTabContainerGuiComp.

◆ GetPageModelRef()

iprm::ISelectionParam & istdgui::CMultiPageGuiCompBase::GetPageModelRef ( )

◆ GetPagesCount()

virtual int istdgui::CMultiPageGuiCompBase::GetPagesCount ( ) const
pure virtual

Get the number of the pages in the UI container.

Implemented in istdgui::CComposedGuiComp, and istdgui::CTabContainerGuiComp.

◆ OnComponentCreated()

void istdgui::CMultiPageGuiCompBase::OnComponentCreated ( )
overrideprotectedvirtual

Reimplemented from istdgui::CGuiComponentBase.

◆ OnComponentDestroyed()

void istdgui::CMultiPageGuiCompBase::OnComponentDestroyed ( )
overrideprotectedvirtual

Reimplemented from istdgui::CGuiComponentBase.

◆ OnGuiCreated()

void istdgui::CMultiPageGuiCompBase::OnGuiCreated ( )
overrideprotectedvirtual

◆ OnGuiDestroyed()

void istdgui::CMultiPageGuiCompBase::OnGuiDestroyed ( )
overrideprotectedvirtual

◆ OnGuiRetranslate()

void istdgui::CMultiPageGuiCompBase::OnGuiRetranslate ( )
overrideprotectedvirtual

Called from widget event filter when GUI should be retranslated.

Reimplemented from istdgui::CGuiComponentBase.

Reimplemented in istdgui::TGuiObserverWrap< istdgui::CComposedGuiComp, imod::TSingleModelObserverBase< iprm::IParamsSet > >.

◆ OnModelChanged()

void istdgui::CMultiPageGuiCompBase::OnModelChanged ( int modelId,
const istd::IChangeable::ChangeSet & changeSet )
overrideprotectedvirtual

Called when some model observed by dispatcher will be changed.

Implements imod::CMultiModelDispatcherBase.

◆ OnPageChanged

virtual void istdgui::CMultiPageGuiCompBase::OnPageChanged ( int widgetIndex)
protectedvirtualslot

◆ OnTryClose()

void istdgui::CMultiPageGuiCompBase::OnTryClose ( bool * ignoredPtr = nullptr)
overrideprotectedvirtual

Called on trying to close application.

Parameters
ignoredPtrif it is not nullptr, ignoring of close is allowed. In this case implementation should set pointed value to true.

Reimplemented from istdgui::CGuiComponentBase.

◆ RemovePage()

virtual void istdgui::CMultiPageGuiCompBase::RemovePage ( int pageIndex)
protectedvirtual

Remove a page from the container widget.

◆ ResetPages()

virtual void istdgui::CMultiPageGuiCompBase::ResetPages ( )
protectedvirtual

Clear all container pages.

◆ SetCurrentPage()

virtual void istdgui::CMultiPageGuiCompBase::SetCurrentPage ( int pageIndex)
protectedvirtual

Set current page.

◆ UpdateVisualElements()

virtual void istdgui::CMultiPageGuiCompBase::UpdateVisualElements ( )
protectedvirtual

Update visual status of the page elements.

Member Data Documentation

◆ m_pageModel

imod::TModelWrap<PageModel> istdgui::CMultiPageGuiCompBase::m_pageModel
protected

Definition at line 222 of file CMultiPageGuiCompBase.h.


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

© Witold Gantzke and Kirill Lepskiy