ICF 3.1.1.10
Technical documentation of ICF Libraries
iprmgui::CExtComposedParamsSetGuiComp Class Reference

New version of parameter set UI based on standard multi page UI concept. More...

#include <CExtComposedParamsSetGuiComp.h>

Inheritance diagram for iprmgui::CExtComposedParamsSetGuiComp:
Collaboration diagram for iprmgui::CExtComposedParamsSetGuiComp:

Public Types

typedef istdgui::TGuiObserverWrap< istdgui::CComposedGuiComp, imod::TSingleModelObserverBase< iprm::IParamsSet > > BaseClass
 
- Public Types inherited from istdgui::CComposedGuiComp
typedef istdgui::TRestorableGuiWrap< CMultiPageGuiCompBaseBaseClass
 
- Public Types inherited from istdgui::TRestorableGuiWrap< CMultiPageGuiCompBase >
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
 
- Public Types inherited from imod::TSingleModelObserverBase< iprm::IParamsSet >
typedef CSingleModelObserverBase BaseClass
 
typedef iprm::IParamsSet ModelType
 
- Public Types inherited from imod::CSingleModelObserverBase
typedef imod::IModel ModelType
 
- Public Types inherited from imod::IModelEditor
enum  ChangeFlags { CF_INIT_EDITOR = 0x3720694 }
 Data model change notification flags. More...
 
- Public Types inherited from i2dgui::IViewExtender
enum  SceneFlags { SF_BACKGROUND = 1 , SF_DIRECT = 2 }
 Standard flags for items . More...
 

Public Member Functions

void UpdateEditor (const istd::IChangeable::ChangeSet &changeSet) override
 Updates editor with model data.
 
void SetReadOnly (bool state) override
 Set flag that the model data can be changed.
 
void OnGuiCreated () override
 Called just after GUI is initialized.
 
void OnGuiDestroyed () override
 Called just before GUI is released.
 
void AddItemsToScene (i2dgui::IViewProvider *providerPtr, int flags) override
 Called when items should be added to specified scene.
 
void RemoveItemsFromScene (i2dgui::IViewProvider *providerPtr) override
 Called when items should be removed from specified scene.
 
- Public Member Functions inherited from istdgui::TGuiObserverWrap< istdgui::CComposedGuiComp, imod::TSingleModelObserverBase< iprm::IParamsSet > >
 TGuiObserverWrap ()
 
bool OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
 
bool OnModelDetached (imod::IModel *modelPtr) override
 
- Public Member Functions inherited from istdgui::CComposedGuiComp
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.
 
- Public Member Functions inherited from istdgui::CMultiPageGuiCompBase
 CMultiPageGuiCompBase ()
 
iprm::ISelectionParamGetPageModelRef ()
 
- Public Member Functions inherited from istdgui::CGuiComponentBase
 CGuiComponentBase ()
 
bool IsGuiShown () const
 
bool IsGuiCreated () const override
 Inform if GUI was initilized.
 
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
- Public Member Functions inherited from imod::TSingleModelObserverBase< iprm::IParamsSet >
 TSingleModelObserverBase ()
 
iprm::IParamsSetGetObservedObject () const
 Get instance of observed object.
 
iprm::IParamsSetGetObjectPtr () const
 Get instance of observed object.
 
bool AttachOrSetObject (iprm::IParamsSet *objectPtr)
 Attach to model of object or set object pointer, if no connection is possible.
 
bool OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
 This call back function will be called, if an observable object is about to be attached.
 
bool OnModelDetached (imod::IModel *modelPtr) override
 This call back function will be called, if an observable object is about to be detached.
 
- Public Member Functions inherited from imod::CSingleModelObserverBase
 CSingleModelObserverBase ()
 
virtual ~CSingleModelObserverBase ()
 
imod::IModelGetObservedModel () const
 Get access to observed model.
 
imod::IModelGetModelPtr () const
 Get access to observed model.
 
void EnsureModelDetached ()
 Make sure this observer is detached.
 
void SetObservedIds (const istd::IChangeable::ChangeSet &changeMask)
 Set list of ID's beeing observed.
 
bool IsModelAttached (const imod::IModel *modelPtr=nullptr) const override
 Check if specified model is attached.
 
void BeforeModelChange (imod::IModel *modelPtr) override
 This function will be called before update of the observer contents occures.
 
- Public Member Functions inherited from imod::IObserver
- Public Member Functions inherited from imod::IModelEditor
- Public Member Functions inherited from i2dgui::IViewExtender

Protected Member Functions

void AttachToScene (i2dgui::IViewProvider *providerPtr, int flags)
 
void DetachFromScene (i2dgui::IViewProvider *providerPtr)
 
void CreatePages () override
 Create all container pages.
 
void OnPageChanged (int widgetIndex) override
 
void OnGuiModelAttached () override
 Called when model is attached and GUI is created.
 
void OnGuiModelDetached () override
 Called when model is detached or GUI is destroyed.
 
void UpdateModel () const override
 Do update of the model to reflect the current contents of GUI.
 
- Protected Member Functions inherited from istdgui::TGuiObserverWrap< istdgui::CComposedGuiComp, imod::TSingleModelObserverBase< iprm::IParamsSet > >
virtual void OnGuiModelShown ()
 Called when model is attached and GUI is shown.
 
virtual void OnGuiModelHidden ()
 Called when model is detached or GUI is hidden.
 
bool IsUpdateBlocked () const
 Check if GUI updating is blocked.
 
bool DoUpdateModel () const
 Secure update model.
 
virtual void UpdateGui (const istd::IChangeable::ChangeSet &changeSet)
 Do update of the GUI to reflect the state of model.
 
void UpdateEditor (const istd::IChangeable::ChangeSet &changeSet) override
 Updates editor with model data.
 
void UpdateModelFromEditor () const override
 Updates model from editor.
 
void OnGuiShown () override
 
void OnGuiHidden () override
 
void OnGuiRetranslate () override
 
void OnGuiCreated () override
 
void OnGuiDestroyed () override
 
void AfterModelChange (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
 
bool IsReadOnly () const override
 Returns true if the model data can be changed.
 
void SetReadOnly (bool state) override
 Set flag that the model data can be changed.
 
void SetDisableUiIfReadOnly (bool state)
 Control if GUI should be disaled for read-only editors.
 
- Protected Member Functions inherited from istdgui::CComposedGuiComp
QWidget * GetPageContainerWidget () const
 
void OnRestoreSettings (const QSettings &settings) override
 
void OnSaveSettings (QSettings &settings) const override
 
int GetDesignType () const override
 Get the container UI mode.
 
- Protected Member Functions inherited from istdgui::TRestorableGuiWrap< CMultiPageGuiCompBase >
bool CreateGui (QWidget *parentPtr) override
 
bool DestroyGui () override
 
- 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 ResetPages ()
 Clear all container pages.
 
QWidget * CreateQtWidget (QWidget *parentPtr) override
 Create slave widget object.
 
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 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.
 
- Protected Member Functions inherited from imod::TSingleModelObserverBase< iprm::IParamsSet >
virtual iprm::IParamsSetCastFromModel (imod::IModel *modelPtr) const
 
- Protected Member Functions inherited from imod::CSingleModelObserverBase
void SetModelPtr (imod::IModel *modelPtr)
 Set internal model pointer to specified value.
 
virtual void OnUpdate (const istd::IChangeable::ChangeSet &changeSet)
 Called on update of observed model.
 

Additional Inherited Members

- Static Public Member Functions inherited from istdgui::CGuiComponentBase
static void MakeAutoSlotConnection (const QWidget &widget, QObject &object)
 
- Protected Slots inherited from istdgui::CMultiPageGuiCompBase
- 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::TGuiObserverWrap< istdgui::CComposedGuiComp, imod::TSingleModelObserverBase< iprm::IParamsSet > >
bool m_isReadOnly
 
- 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

New version of parameter set UI based on standard multi page UI concept.

Definition at line 30 of file CExtComposedParamsSetGuiComp.h.

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ AddItemsToScene()

void iprmgui::CExtComposedParamsSetGuiComp::AddItemsToScene ( i2dgui::IViewProvider * providerPtr,
int flags )
overridevirtual

Called when items should be added to specified scene.

Implements i2dgui::IViewExtender.

◆ AttachToScene()

void iprmgui::CExtComposedParamsSetGuiComp::AttachToScene ( i2dgui::IViewProvider * providerPtr,
int flags )
protected

◆ CreatePages()

void iprmgui::CExtComposedParamsSetGuiComp::CreatePages ( )
overrideprotectedvirtual

Create all container pages.

Reimplemented from istdgui::CMultiPageGuiCompBase.

◆ DetachFromScene()

void iprmgui::CExtComposedParamsSetGuiComp::DetachFromScene ( i2dgui::IViewProvider * providerPtr)
protected

◆ OnGuiCreated()

void iprmgui::CExtComposedParamsSetGuiComp::OnGuiCreated ( )
overridevirtual

Called just after GUI is initialized.

Reimplemented from istdgui::CComposedGuiComp.

◆ OnGuiDestroyed()

void iprmgui::CExtComposedParamsSetGuiComp::OnGuiDestroyed ( )
overridevirtual

Called just before GUI is released.

Reimplemented from istdgui::CGuiComponentBase.

◆ OnGuiModelAttached()

void iprmgui::CExtComposedParamsSetGuiComp::OnGuiModelAttached ( )
overrideprotectedvirtual

Called when model is attached and GUI is created.

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

◆ OnGuiModelDetached()

void iprmgui::CExtComposedParamsSetGuiComp::OnGuiModelDetached ( )
overrideprotectedvirtual

Called when model is detached or GUI is destroyed.

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

◆ OnPageChanged()

void iprmgui::CExtComposedParamsSetGuiComp::OnPageChanged ( int widgetIndex)
overrideprotectedvirtual

Reimplemented from istdgui::CMultiPageGuiCompBase.

◆ RemoveItemsFromScene()

void iprmgui::CExtComposedParamsSetGuiComp::RemoveItemsFromScene ( i2dgui::IViewProvider * providerPtr)
overridevirtual

Called when items should be removed from specified scene.

Implements i2dgui::IViewExtender.

◆ SetReadOnly()

void iprmgui::CExtComposedParamsSetGuiComp::SetReadOnly ( bool state)
overridevirtual

Set flag that the model data can be changed.

Returns
true, if this feature is supported.

Implements imod::IModelEditor.

◆ UpdateEditor()

void iprmgui::CExtComposedParamsSetGuiComp::UpdateEditor ( const istd::IChangeable::ChangeSet & changeSet)
overridevirtual

Updates editor with model data.

This method will be called only if GUI is connected.

Parameters
changeSetthe same as changeSet in istd::IChangeable.

Implements imod::IModelEditor.

◆ UpdateModel()

void iprmgui::CExtComposedParamsSetGuiComp::UpdateModel ( ) const
overrideprotectedvirtual

Do update of the model to reflect the current contents of GUI.

This method should be implmented by derived classes instead of imod::IModelEditor::UpdateModelFromEditor().

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


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

© Witold Gantzke and Kirill Lepskiy