ACF $AcfVersion:0$
Public Types | Public Member Functions | Protected Member Functions | List of all members
iqtprm::CExtComposedParamsSetGuiComp Class Reference

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

#include <CExtComposedParamsSetGuiComp.h>

Inheritance diagram for iqtprm::CExtComposedParamsSetGuiComp:
iqtgui::TGuiObserverWrap< iqtgui::CComposedGuiComp, imod::TSingleModelObserverBase< iprm::IParamsSet > > iqt2d::IViewExtender iqtgui::CComposedGuiComp imod::TSingleModelObserverBase< iprm::IParamsSet > imod::IModelEditor istd::IPolymorphic iqtgui::TRestorableGuiWrap< CMultiPageGuiCompBase > imod::CSingleModelObserverBase istd::IPolymorphic iqtgui::CMultiPageGuiCompBase imod::IObserver iqtgui::CMultiPageGuiCompAttr imod::CMultiModelDispatcherBase istd::IPolymorphic iqtgui::CGuiComponentBase istd::IPolymorphic iqtgui::TMakeIconProviderCompWrap< ibase::TLocalizableWrap< icomp::CComponentBase > > iqtgui::IGuiObject iqtgui::TDesignSchemaHandlerWrap< Base > iqtgui::CIconProvider istd::IPolymorphic

Public Types

typedef iqtgui::TGuiObserverWrap< iqtgui::CComposedGuiComp, imod::TSingleModelObserverBase< iprm::IParamsSet > > BaseClass
 
- Public Types inherited from iqtgui::CComposedGuiComp
typedef iqtgui::TRestorableGuiWrap< CMultiPageGuiCompBaseBaseClass
 
- 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::CComponentBaseBaseClass
 
- Public Types inherited from iqtgui::TDesignSchemaHandlerWrap< Base >
typedef Base 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 iqt2d::IViewExtender
enum  SceneFlags { SF_BACKGROUND = 1 , SF_DIRECT = 2 }
 Standard flags for items . More...
 

Public Member Functions

virtual void UpdateEditor (const istd::IChangeable::ChangeSet &changeSet) override
 Updates editor with model data.
 
virtual void SetReadOnly (bool state) override
 Set flag that the model data can be changed.
 
virtual void OnGuiCreated () override
 Called just after GUI is initialized.
 
virtual void OnGuiDestroyed () override
 Called just before GUI is released.
 
virtual void AddItemsToScene (iqt2d::IViewProvider *providerPtr, int flags) override
 Called when items should be added to specified scene.
 
virtual void RemoveItemsFromScene (iqt2d::IViewProvider *providerPtr) override
 Called when items should be removed from specified scene.
 
- Public Member Functions inherited from iqtgui::TGuiObserverWrap< iqtgui::CComposedGuiComp, imod::TSingleModelObserverBase< iprm::IParamsSet > >
 TGuiObserverWrap ()
 
virtual bool OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
 
virtual bool OnModelDetached (imod::IModel *modelPtr) override
 
- Public Member Functions inherited from iqtgui::CComposedGuiComp
virtual int GetPagesCount () const override
 Get the number of the pages in the UI container.
 
virtual iqtgui::IGuiObjectGetPageGuiComponent (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::ISelectionParamGetPageModelRef ()
 
- 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 ()
 
- 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.
 
- 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.
 
virtual bool IsModelAttached (const imod::IModel *modelPtr=NULL) const override
 Checks if the specified model is currently attached to this observer.
 
virtual void BeforeUpdate (imod::IModel *modelPtr) override
 Callback invoked before an update of the observer's content occurs.
 

Protected Member Functions

void AttachToScene (iqt2d::IViewProvider *providerPtr, int flags)
 
void DetachFromScene (iqt2d::IViewProvider *providerPtr)
 
virtual void CreatePages () override
 Create all container pages.
 
virtual void OnPageChanged (int widgetIndex) override
 
virtual void OnGuiModelAttached () override
 Called when model is attached and GUI is created.
 
virtual void OnGuiModelDetached () override
 Called when model is detached or GUI is destroyed.
 
virtual void UpdateModel () const override
 Do update of the model to reflect the current contents of GUI.
 
- Protected Member Functions inherited from iqtgui::TGuiObserverWrap< iqtgui::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.
 
virtual void UpdateModelFromEditor () const override
 Updates model from editor.
 
virtual void OnGuiShown () override
 
virtual void OnGuiHidden () override
 
virtual void OnGuiRetranslate () override
 
virtual void AfterUpdate (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
 
virtual bool IsReadOnly () const override
 Returns true if 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 iqtgui::CComposedGuiComp
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.
 
- 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 ResetPages ()
 Clear all container pages.
 
virtual QWidget * CreateQtWidget (QWidget *parentPtr) override
 Create slave widget object.
 
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 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.
 
- 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

- Protected Slots inherited from iqtgui::CMultiPageGuiCompBase
- Protected Attributes inherited from iqtgui::TGuiObserverWrap< iqtgui::CComposedGuiComp, imod::TSingleModelObserverBase< iprm::IParamsSet > >
bool m_isReadOnly
 
- Protected Attributes inherited from iqtgui::CMultiPageGuiCompBase
imod::TModelWrap< PageModel > m_pageModel
 
- Protected Attributes inherited from iqtgui::CGuiComponentBase
imod::TModelWrap< VisualStatusm_visualStatus
 
- Static Protected Attributes inherited from imod::CSingleModelObserverBase
static const istd::IChangeable::ChangeSet s_undoChanges
 

Detailed Description

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

Definition at line 25 of file CExtComposedParamsSetGuiComp.h.

Member Typedef Documentation

◆ BaseClass

Definition at line 32 of file CExtComposedParamsSetGuiComp.h.

Member Function Documentation

◆ AddItemsToScene()

virtual void iqtprm::CExtComposedParamsSetGuiComp::AddItemsToScene ( iqt2d::IViewProvider providerPtr,
int  flags 
)
overridevirtual

Called when items should be added to specified scene.

Implements iqt2d::IViewExtender.

◆ AttachToScene()

void iqtprm::CExtComposedParamsSetGuiComp::AttachToScene ( iqt2d::IViewProvider providerPtr,
int  flags 
)
protected

◆ CreatePages()

virtual void iqtprm::CExtComposedParamsSetGuiComp::CreatePages ( )
overrideprotectedvirtual

Create all container pages.

Reimplemented from iqtgui::CMultiPageGuiCompBase.

◆ DetachFromScene()

void iqtprm::CExtComposedParamsSetGuiComp::DetachFromScene ( iqt2d::IViewProvider providerPtr)
protected

◆ OnGuiCreated()

virtual void iqtprm::CExtComposedParamsSetGuiComp::OnGuiCreated ( )
overridevirtual

◆ OnGuiDestroyed()

virtual void iqtprm::CExtComposedParamsSetGuiComp::OnGuiDestroyed ( )
overridevirtual

◆ OnGuiModelAttached()

virtual void iqtprm::CExtComposedParamsSetGuiComp::OnGuiModelAttached ( )
overrideprotectedvirtual

Called when model is attached and GUI is created.

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

◆ OnGuiModelDetached()

virtual void iqtprm::CExtComposedParamsSetGuiComp::OnGuiModelDetached ( )
overrideprotectedvirtual

Called when model is detached or GUI is destroyed.

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

◆ OnPageChanged()

virtual void iqtprm::CExtComposedParamsSetGuiComp::OnPageChanged ( int  widgetIndex)
overrideprotectedvirtual

Reimplemented from iqtgui::CMultiPageGuiCompBase.

◆ RemoveItemsFromScene()

virtual void iqtprm::CExtComposedParamsSetGuiComp::RemoveItemsFromScene ( iqt2d::IViewProvider providerPtr)
overridevirtual

Called when items should be removed from specified scene.

Implements iqt2d::IViewExtender.

◆ SetReadOnly()

virtual void iqtprm::CExtComposedParamsSetGuiComp::SetReadOnly ( bool  state)
overridevirtual

Set flag that the model data can be changed.

Returns
true, if this feature is supported.

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

◆ UpdateEditor()

virtual void iqtprm::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.

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

◆ UpdateModel()

virtual void iqtprm::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 iqtgui::TGuiObserverWrap< iqtgui::CComposedGuiComp, imod::TSingleModelObserverBase< iprm::IParamsSet > >.


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