ICF 3.0.5.47
Technical documentation of ICF Libraries
istdgui::CTabContainerGuiComp Class Reference

Component to create the tab widget, that shows the specified sub-UI-component in its tab page. More...

#include <CTabContainerGuiComp.h>

Inheritance diagram for istdgui::CTabContainerGuiComp:
Collaboration diagram for istdgui::CTabContainerGuiComp:

Public Types

typedef CMultiPageGuiCompBase BaseClass
 
- Public Types inherited from istdgui::CMultiPageGuiCompBase
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::CComponentBaseBaseClass
 
- Public Types inherited from ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >
typedef icomp::CComponentBase BaseClass
 

Protected Member Functions

int GetPagesCount () const override
 Get the number of the pages in the UI container.
 
istdgui::IGuiObjectGetPageGuiComponent (int pageIndex) const override
 Get the UI component for a given page.
 
int GetDesignType () const override
 Get the container UI mode.
 
void OnGuiCreated () override
 Called just after GUI is initialized.
 
void OnGuiDestroyed () override
 Called just before GUI is released.
 
- Protected Member Functions inherited from istdgui::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.
 
QWidget * CreateQtWidget (QWidget *parentPtr) override
 Create slave widget object.
 
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::CMultiPageGuiCompAttr
 I_MULTITEXTATTR (m_pageNamesAttrPtr)
 
- 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 IRealComponentStaticInfoGetComponentStaticInfo () 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.
 

Additional Inherited Members

- Public Member Functions inherited from istdgui::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::ISelectionParamGetPageModelRef ()
 
- Public Member Functions inherited from istdgui::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
 
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
 
CComponentBaseoperator= (const CComponentBase &)=delete
 
virtual const ICompositeComponentGetParentComponent (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 IComponentContextGetComponentContext () 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
- Static Public Member Functions inherited from istdgui::CGuiComponentBase
static void MakeAutoSlotConnection (const QWidget &widget, QObject &object)
 
- Protected Slots inherited from istdgui::CMultiPageGuiCompBase
virtual void OnPageChanged (int widgetIndex)
 
- Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfoInitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 
- Protected Attributes inherited from istdgui::CMultiPageGuiCompBase
imod::TModelWrap< PageModel > m_pageModel
 
- Protected Attributes inherited from istdgui::CGuiComponentBase
istd::CMainThreadCaller m_updateGuiCaller
 
imod::TModelWrap< VisualStatusm_visualStatus
 

Detailed Description

Component to create the tab widget, that shows the specified sub-UI-component in its tab page.

You can control some settings of the tabs such icons, title, orientation or tab visualization. Optionally, you can specify the corner widget, which will be placed beside of the last tab.

Definition at line 23 of file CTabContainerGuiComp.h.

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ GetDesignType()

int istdgui::CTabContainerGuiComp::GetDesignType ( ) const
overrideprotectedvirtual

Get the container UI mode.

See also
istdgui::CMultiPageWidget::DesignType

Implements istdgui::CMultiPageGuiCompBase.

◆ GetPageGuiComponent()

istdgui::IGuiObject * istdgui::CTabContainerGuiComp::GetPageGuiComponent ( int pageIndex) const
overrideprotectedvirtual

Get the UI component for a given page.

Implements istdgui::CMultiPageGuiCompBase.

◆ GetPagesCount()

int istdgui::CTabContainerGuiComp::GetPagesCount ( ) const
overrideprotectedvirtual

Get the number of the pages in the UI container.

Implements istdgui::CMultiPageGuiCompBase.

◆ OnGuiCreated()

void istdgui::CTabContainerGuiComp::OnGuiCreated ( )
overrideprotectedvirtual

Called just after GUI is initialized.

Reimplemented from istdgui::CMultiPageGuiCompBase.

◆ OnGuiDestroyed()

void istdgui::CTabContainerGuiComp::OnGuiDestroyed ( )
overrideprotectedvirtual

Called just before GUI is released.

Reimplemented from istdgui::CMultiPageGuiCompBase.


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

© Witold Gantzke and Kirill Lepskiy