#include <TCommonSupplierGuiCompBase.h>

Inheritance diagram for iinspgui::TCommonSupplierGuiCompBase< UI >:

Collaboration diagram for iinspgui::TCommonSupplierGuiCompBase< UI >:

Classes
class	ParamsObserver

class	StatusObserver

Public Types
typedef istdgui::TDesignerGuiObserverCompBase< UI, iinsp::ISupplier >	BaseClass

Public Types inherited from istdgui::TDesignerGuiObserverCompBase< UI, iinsp::ISupplier >
typedef ibase::TModelObserverCompBaseWrap< istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< iinsp::ISupplier > > >	BaseClass

Public Types inherited from ibase::TModelObserverCompBaseWrap< istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< iinsp::ISupplier > > >
typedef istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< iinsp::ISupplier > >	BaseClass

Public Types inherited from istdgui::TDesignerGuiCompBase< UI, QWidget >
typedef TGuiComponentBase< QWidget >	BaseClass

Public Types inherited from istdgui::TGuiComponentBase< QWidget >
typedef 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 Types inherited from imod::TSingleModelObserverBase< iinsp::ISupplier >
typedef CSingleModelObserverBase	BaseClass

typedef iinsp::ISupplier	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 Member Functions
	TCommonSupplierGuiCompBase ()

Public Member Functions inherited from istdgui::TDesignerGuiObserverCompBase< UI, iinsp::ISupplier >
void	SetReadOnly (bool state) override
	Set flag that the model data can be changed.

Public Member Functions inherited from istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< iinsp::ISupplier > >
	TGuiObserverWrap ()

bool	OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override

bool	OnModelDetached (imod::IModel *modelPtr) override

Public Member Functions inherited from istdgui::TDesignerGuiCompBase< UI, QWidget >
virtual QWidget *	CreateQtWidget (QWidget *parentPtr)
	Create slave widget object.

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

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
Public Member Functions inherited from imod::TSingleModelObserverBase< iinsp::ISupplier >
	TSingleModelObserverBase ()

iinsp::ISupplier *	GetObservedObject () const
	Get instance of observed object.

iinsp::ISupplier *	GetObjectPtr () const
	Get instance of observed object.

bool	AttachOrSetObject (iinsp::ISupplier *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::IModel *	GetObservedModel () const
	Get access to observed model.

imod::IModel *	GetModelPtr () 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

Protected Member Functions
bool	AreParamsEditable () const
	Check, if parameters are correct connected to GUI and can be editable.

bool	IsLoadParamsSupported () const
	Check if parameter loading is supported.

bool	IsSaveParamsSupported () const
	Check if parameter storing is supported.

bool	LoadParams ()
	Load parameters from external source (file).

bool	SaveParams ()
	Save parameters for example to file.

bool	DoTest ()
	Do inspection test.

virtual void	UpdateVisualStatus ()
	Update visual status of supplier state.

virtual void	OnSupplierParamsChanged ()
	Method will be called every time if the parameter set of the supplier has been changed.

virtual void	BeforeSupplierGuiUpdated ()
	This method will be called after the supplier's output has been changed and new results are available.

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	AfterModelChange (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
	This function will be called after update of the observer contents occures.

virtual QWidget *	GetParamsWidget () const =0
	Get parameters widget object.

Protected Member Functions inherited from istdgui::TDesignerGuiObserverCompBase< UI, iinsp::ISupplier >
void	OnGuiCreated () override
	Called just after GUI is initialized.

void	OnComponentCreated () override

Protected Member Functions inherited from ibase::TModelObserverCompBaseWrap< istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< iinsp::ISupplier > > >
void	OnComponentCreated () override

void	OnComponentDestroyed () override

Protected Member Functions inherited from istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< iinsp::ISupplier > >
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	UpdateModel () const
	Do update of the model to reflect the current contents of GUI.

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::TDesignerGuiCompBase< UI, QWidget >
Protected Member Functions inherited from istdgui::TGuiComponentBase< QWidget >
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 IRealComponentStaticInfo &	GetComponentStaticInfo () const =0
	Get access to static info of this component.

Protected Member Functions inherited from imod::TSingleModelObserverBase< iinsp::ISupplier >
virtual iinsp::ISupplier *	CastFromModel (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.

Protected Attributes
ParamsObserver	m_paramsObserver

StatusObserver	m_statusObserver

Protected Attributes inherited from istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< iinsp::ISupplier > >
bool	m_isReadOnly

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

template<class UI>
class iinspgui::TCommonSupplierGuiCompBase< UI >

Definition at line 32 of file TCommonSupplierGuiCompBase.h.

Member Typedef Documentation

◆ BaseClass

template<class UI >

istdgui::TDesignerGuiObserverCompBase<UI, iinsp::ISupplier> iinspgui::TCommonSupplierGuiCompBase< UI >::BaseClass

Definition at line 35 of file TCommonSupplierGuiCompBase.h.

Constructor & Destructor Documentation

◆ TCommonSupplierGuiCompBase()

template<class UI >

iinspgui::TCommonSupplierGuiCompBase< UI >::TCommonSupplierGuiCompBase ( )

Definition at line 163 of file TCommonSupplierGuiCompBase.h.

References istdgui::CGuiComponentBase::SetStatusIcon(), and istdgui::CGuiComponentBase::SetStatusText().

Member Function Documentation

◆ AfterModelChange()

template<class UI >

void iinspgui::TCommonSupplierGuiCompBase< UI >::AfterModelChange	(	imod::IModel *	modelPtr,
		const istd::IChangeable::ChangeSet &	changeSet )

overrideprotectedvirtual

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

Reimplemented from imod::CSingleModelObserverBase.

Definition at line 447 of file TCommonSupplierGuiCompBase.h.

References istd::IChangeable::CF_DESTROYING, and istd::IChangeable::ChangeSet::ContainsExplicit().

◆ AreParamsEditable()

template<class UI >

bool iinspgui::TCommonSupplierGuiCompBase< UI >::AreParamsEditable ( ) const

protected

Check, if parameters are correct connected to GUI and can be editable.

Definition at line 176 of file TCommonSupplierGuiCompBase.h.

◆ BeforeSupplierGuiUpdated()

template<class UI >

void iinspgui::TCommonSupplierGuiCompBase< UI >::BeforeSupplierGuiUpdated ( )

protectedvirtual

This method will be called after the supplier's output has been changed and new results are available.

Reimplemented in iinspgui::TSupplierGuiCompBase< UI >.

Definition at line 363 of file TCommonSupplierGuiCompBase.h.

◆ DoTest()

template<class UI >

bool iinspgui::TCommonSupplierGuiCompBase< UI >::DoTest ( )

protected

Do inspection test.

Definition at line 271 of file TCommonSupplierGuiCompBase.h.

References iinsp::ISupplier::EnsureWorkFinished(), iinsp::ISupplier::EnsureWorkInitialized(), iinsp::ISupplier::GetWorkStatus(), iinsp::ISupplier::InvalidateSupplier(), and iinsp::ISupplier::WS_FAILED.

◆ GetParamsWidget()

template<class UI >

virtual QWidget * iinspgui::TCommonSupplierGuiCompBase< UI >::GetParamsWidget ( ) const

protectedpure virtual

Get parameters widget object.

Extern paremeters GUI will attach to this widget. This widget should have some layout.

◆ IsLoadParamsSupported()

template<class UI >

bool iinspgui::TCommonSupplierGuiCompBase< UI >::IsLoadParamsSupported ( ) const

protected

Check if parameter loading is supported.

Definition at line 183 of file TCommonSupplierGuiCompBase.h.

References iinsp::ISupplier::GetModelParametersSet(), ifile::IFileTypeInfo::QF_ANONYMOUS, and ifile::IFileTypeInfo::QF_LOAD.

◆ IsSaveParamsSupported()

template<class UI >

bool iinspgui::TCommonSupplierGuiCompBase< UI >::IsSaveParamsSupported ( ) const

protected

Check if parameter storing is supported.

Definition at line 203 of file TCommonSupplierGuiCompBase.h.

References iinsp::ISupplier::GetModelParametersSet(), ifile::IFileTypeInfo::QF_ANONYMOUS, and ifile::IFileTypeInfo::QF_SAVE.

◆ LoadParams()

template<class UI >

bool iinspgui::TCommonSupplierGuiCompBase< UI >::LoadParams ( )

protected

Load parameters from external source (file).

Definition at line 223 of file TCommonSupplierGuiCompBase.h.

References iinsp::ISupplier::GetModelParametersSet().

◆ OnGuiModelAttached()

template<class UI >

void iinspgui::TCommonSupplierGuiCompBase< UI >::OnGuiModelAttached ( )

overrideprotectedvirtual

Called when model is attached and GUI is created.

Reimplemented from istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< iinsp::ISupplier > >.

Definition at line 371 of file TCommonSupplierGuiCompBase.h.

References imod::IModel::AttachObserver(), iinsp::ISupplier::GetModelParametersSet(), and iinsp::ISupplier::GetWorkStatusModel().

◆ OnGuiModelDetached()

template<class UI >

void iinspgui::TCommonSupplierGuiCompBase< UI >::OnGuiModelDetached ( )

overrideprotectedvirtual

Called when model is detached or GUI is destroyed.

Reimplemented from istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< iinsp::ISupplier > >.

Definition at line 416 of file TCommonSupplierGuiCompBase.h.

References imod::IModel::DetachObserver(), iinsp::ISupplier::GetModelParametersSet(), and imod::IModel::IsAttached().

◆ OnSupplierParamsChanged()

template<class UI >

void iinspgui::TCommonSupplierGuiCompBase< UI >::OnSupplierParamsChanged ( )

protectedvirtual

Method will be called every time if the parameter set of the supplier has been changed.

Default implementation does nothing.

Definition at line 357 of file TCommonSupplierGuiCompBase.h.

◆ SaveParams()

template<class UI >

bool iinspgui::TCommonSupplierGuiCompBase< UI >::SaveParams ( )

protected

Save parameters for example to file.

Definition at line 247 of file TCommonSupplierGuiCompBase.h.

References iinsp::ISupplier::GetModelParametersSet().

◆ UpdateVisualStatus()

template<class UI >

void iinspgui::TCommonSupplierGuiCompBase< UI >::UpdateVisualStatus ( )

protectedvirtual

Update visual status of supplier state.

Definition at line 289 of file TCommonSupplierGuiCompBase.h.

References CompCastPtr(), istd::IInformationProvider::GetInformationCategory(), iinsp::ISupplier::GetWorkStatus(), istd::IInformationProvider::IC_ERROR, istd::IInformationProvider::IC_INFO, istd::IInformationProvider::IC_WARNING, iinsp::ISupplier::WS_CANCELED, iinsp::ISupplier::WS_FAILED, iinsp::ISupplier::WS_LOCKED, and iinsp::ISupplier::WS_OK.

Member Data Documentation

◆ m_paramsObserver

template<class UI >

ParamsObserver iinspgui::TCommonSupplierGuiCompBase< UI >::m_paramsObserver

protected

Definition at line 141 of file TCommonSupplierGuiCompBase.h.

◆ m_statusObserver

template<class UI >

StatusObserver iinspgui::TCommonSupplierGuiCompBase< UI >::m_statusObserver

protected

Definition at line 142 of file TCommonSupplierGuiCompBase.h.

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

iinspgui/TCommonSupplierGuiCompBase.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ TCommonSupplierGuiCompBase()

Member Function Documentation

◆ AfterModelChange()

◆ AreParamsEditable()

◆ BeforeSupplierGuiUpdated()

◆ DoTest()

◆ GetParamsWidget()

◆ IsLoadParamsSupported()

◆ IsSaveParamsSupported()

◆ LoadParams()

◆ OnGuiModelAttached()

◆ OnGuiModelDetached()

◆ OnSupplierParamsChanged()

◆ SaveParams()

◆ UpdateVisualStatus()

Member Data Documentation

◆ m_paramsObserver

◆ m_statusObserver