ICF 3.0.5.47
Technical documentation of ICF Libraries
iprmgui::CParamsManagerGuiCompBase Class Referenceabstract

#include <CParamsManagerGuiCompBase.h>

Inheritance diagram for iprmgui::CParamsManagerGuiCompBase:
Collaboration diagram for iprmgui::CParamsManagerGuiCompBase:

Public Types

typedef istdgui::TDesignerGuiObserverCompBase< Ui::CParamsManagerGuiCompBase, iprm::IParamsManagerBaseClass
 
- Public Types inherited from istdgui::TGuiComponentBase< QWidget >
typedef 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::IParamsManager >
typedef CSingleModelObserverBase BaseClass
 
typedef iprm::IParamsManager 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

 CParamsManagerGuiCompBase ()
 
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::TGuiComponentBase< QWidget >
 TGuiComponentBase ()
 
virtual QWidget * GetQtWidget () const
 
- 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.
 
void OnTryClose (bool *ignoredPtr=nullptr) override
 Called on trying to close application.
 
- 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::IParamsManager >
 TSingleModelObserverBase ()
 
iprm::IParamsManagerGetObservedObject () const
 Get instance of observed object.
 
iprm::IParamsManagerGetObjectPtr () const
 Get instance of observed object.
 
bool AttachOrSetObject (iprm::IParamsManager *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.
 
void AfterModelChange (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
 This function will be called after update of the observer contents occures.
 
- Public Member Functions inherited from imod::IObserver
- Public Member Functions inherited from imod::IModelEditor
virtual void UpdateEditor (const istd::IChangeable::ChangeSet &changeSet)=0
 Updates editor with model data.
 
virtual void UpdateModelFromEditor () const =0
 Updates model from editor.
 
virtual bool IsReadOnly () const =0
 Returns true if the model data can be changed.
 
virtual void SetReadOnly (bool state)=0
 Set flag that the model data can be changed.
 
- Public Member Functions inherited from i2dgui::IViewExtender

Protected Slots

void on_AddButton_clicked ()
 
void on_RemoveButton_clicked ()
 
void on_UpButton_clicked ()
 
void on_DownButton_clicked ()
 
void on_ParamsTree_itemSelectionChanged ()
 
void on_ParamsTree_itemChanged (QTreeWidgetItem *item, int column)
 
void on_ParamsComboBox_currentIndexChanged (int index)
 
void on_ParamsComboBox_editTextChanged (const QString &text)
 
void on_LoadParamsButton_clicked ()
 
void on_SaveParamsButton_clicked ()
 
void OnAddMenuOptionClicked (QAction *action)
 

Protected Member Functions

virtual imod::IObserverGetEditorObserver (const iprm::IParamsSet *paramsSetPtr) const =0
 Get the observer for a given parameter set.
 
virtual istdgui::IGuiObjectGetEditorGui (const iprm::IParamsSet *paramsSetPtr) const =0
 Get the editor GUI for a given parameter set.
 
virtual i2dgui::IViewExtenderGetCurrentViewExtenderPtr () const
 Get the currently active view extender.
 
virtual void OnParameterSelectionChanged ()
 Callback for parameter selection.
 
void UpdateActions ()
 
void UpdateTree ()
 
void UpdateComboBox ()
 
virtual void UpdateParamsView (int selectedIndex)
 
int GetSelectedIndex () const
 
void EnsureParamsGuiDetached ()
 
QByteArray GetSelectedParamsSetTypeId () const
 
void InsertNewParamsSet (int typeIndex=-1)
 
void OnGuiModelAttached () override
 
void OnGuiModelDetached () override
 
void UpdateGui (const istd::IChangeable::ChangeSet &changeSet) override
 
void OnGuiCreated () override
 Called just after GUI is initialized.
 
void AfterModelChange (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
 This function will be called after update of the observer contents occures.
 
- Protected Member Functions inherited from istdgui::TGuiComponentBase< QWidget >
virtual QWidget * CreateQtWidget (QWidget *parentPtr)
 Create slave widget object.
 
- 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.
 
virtual void OnGuiRetranslate ()
 Called from widget event filter when GUI should be retranslated.
 
virtual void OnGuiDestroyed ()
 Called just before GUI is released.
 
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
 
void OnComponentCreated () override
 
void OnComponentDestroyed () 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::TSingleModelObserverBase< iprm::IParamsManager >
virtual iprm::IParamsManagerCastFromModel (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)
 
- 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::CGuiComponentBase
istd::CMainThreadCaller m_updateGuiCaller
 
imod::TModelWrap< VisualStatusm_visualStatus
 

Detailed Description

Definition at line 27 of file CParamsManagerGuiCompBase.h.

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CParamsManagerGuiCompBase()

iprmgui::CParamsManagerGuiCompBase::CParamsManagerGuiCompBase ( )

Member Function Documentation

◆ AddItemsToScene()

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

Called when items should be added to specified scene.

Implements i2dgui::IViewExtender.

◆ AfterModelChange()

void iprmgui::CParamsManagerGuiCompBase::AfterModelChange ( imod::IModel * modelPtr,
const istd::IChangeable::ChangeSet & changeSet )
overrideprotectedvirtual

This function will be called after update of the observer contents occures.

Implements imod::IObserver.

◆ EnsureParamsGuiDetached()

void iprmgui::CParamsManagerGuiCompBase::EnsureParamsGuiDetached ( )
protected

◆ GetCurrentViewExtenderPtr()

virtual i2dgui::IViewExtender * iprmgui::CParamsManagerGuiCompBase::GetCurrentViewExtenderPtr ( ) const
protectedvirtual

Get the currently active view extender.

Reimplemented in iprmgui::CMultiParamsManagerGuiComp.

◆ GetEditorGui()

virtual istdgui::IGuiObject * iprmgui::CParamsManagerGuiCompBase::GetEditorGui ( const iprm::IParamsSet * paramsSetPtr) const
protectedpure virtual

Get the editor GUI for a given parameter set.

Implemented in iprmgui::CMultiParamsManagerGuiComp, and iprmgui::CParamsManagerGuiComp.

◆ GetEditorObserver()

virtual imod::IObserver * iprmgui::CParamsManagerGuiCompBase::GetEditorObserver ( const iprm::IParamsSet * paramsSetPtr) const
protectedpure virtual

Get the observer for a given parameter set.

Implemented in iprmgui::CMultiParamsManagerGuiComp, and iprmgui::CParamsManagerGuiComp.

◆ GetSelectedIndex()

int iprmgui::CParamsManagerGuiCompBase::GetSelectedIndex ( ) const
protected

◆ GetSelectedParamsSetTypeId()

QByteArray iprmgui::CParamsManagerGuiCompBase::GetSelectedParamsSetTypeId ( ) const
protected

◆ InsertNewParamsSet()

void iprmgui::CParamsManagerGuiCompBase::InsertNewParamsSet ( int typeIndex = -1)
protected

◆ on_AddButton_clicked

void iprmgui::CParamsManagerGuiCompBase::on_AddButton_clicked ( )
protectedslot

◆ on_DownButton_clicked

void iprmgui::CParamsManagerGuiCompBase::on_DownButton_clicked ( )
protectedslot

◆ on_LoadParamsButton_clicked

void iprmgui::CParamsManagerGuiCompBase::on_LoadParamsButton_clicked ( )
protectedslot

◆ on_ParamsComboBox_currentIndexChanged

void iprmgui::CParamsManagerGuiCompBase::on_ParamsComboBox_currentIndexChanged ( int index)
protectedslot

◆ on_ParamsComboBox_editTextChanged

void iprmgui::CParamsManagerGuiCompBase::on_ParamsComboBox_editTextChanged ( const QString & text)
protectedslot

◆ on_ParamsTree_itemChanged

void iprmgui::CParamsManagerGuiCompBase::on_ParamsTree_itemChanged ( QTreeWidgetItem * item,
int column )
protectedslot

◆ on_ParamsTree_itemSelectionChanged

void iprmgui::CParamsManagerGuiCompBase::on_ParamsTree_itemSelectionChanged ( )
protectedslot

◆ on_RemoveButton_clicked

void iprmgui::CParamsManagerGuiCompBase::on_RemoveButton_clicked ( )
protectedslot

◆ on_SaveParamsButton_clicked

void iprmgui::CParamsManagerGuiCompBase::on_SaveParamsButton_clicked ( )
protectedslot

◆ on_UpButton_clicked

void iprmgui::CParamsManagerGuiCompBase::on_UpButton_clicked ( )
protectedslot

◆ OnAddMenuOptionClicked

void iprmgui::CParamsManagerGuiCompBase::OnAddMenuOptionClicked ( QAction * action)
protectedslot

◆ OnGuiCreated()

void iprmgui::CParamsManagerGuiCompBase::OnGuiCreated ( )
overrideprotectedvirtual

Called just after GUI is initialized.

Reimplemented from istdgui::CGuiComponentBase.

◆ OnGuiModelAttached()

void iprmgui::CParamsManagerGuiCompBase::OnGuiModelAttached ( )
overrideprotected

◆ OnGuiModelDetached()

void iprmgui::CParamsManagerGuiCompBase::OnGuiModelDetached ( )
overrideprotected

◆ OnParameterSelectionChanged()

virtual void iprmgui::CParamsManagerGuiCompBase::OnParameterSelectionChanged ( )
protectedvirtual

Callback for parameter selection.

◆ RemoveItemsFromScene()

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

Called when items should be removed from specified scene.

Implements i2dgui::IViewExtender.

◆ UpdateActions()

void iprmgui::CParamsManagerGuiCompBase::UpdateActions ( )
protected

◆ UpdateComboBox()

void iprmgui::CParamsManagerGuiCompBase::UpdateComboBox ( )
protected

◆ UpdateGui()

void iprmgui::CParamsManagerGuiCompBase::UpdateGui ( const istd::IChangeable::ChangeSet & changeSet)
overrideprotected

◆ UpdateParamsView()

virtual void iprmgui::CParamsManagerGuiCompBase::UpdateParamsView ( int selectedIndex)
protectedvirtual

◆ UpdateTree()

void iprmgui::CParamsManagerGuiCompBase::UpdateTree ( )
protected

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

© Witold Gantzke and Kirill Lepskiy