ICF 3.0.5.47
Technical documentation of ICF Libraries
iinspgui::CTeachableParamsDecoratorGuiComp Class Reference

#include <CTeachableParamsDecoratorGuiComp.h>

Inheritance diagram for iinspgui::CTeachableParamsDecoratorGuiComp:
Collaboration diagram for iinspgui::CTeachableParamsDecoratorGuiComp:

Public Types

typedef istdgui::TDesignerGuiObserverCompBase< Ui::CTeachableParamsDecoratorGuiComp, iprm::IParamsSetBaseClass
 
- 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::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 Member Functions

void UpdateEditor (const istd::IChangeable::ChangeSet &changeSet) override
 Updates editor with model data.
 
void UpdateModelFromEditor () const override
 Updates model from editor.
 
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.
 
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 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::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.
 
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

Protected Slots

void on_TeachModelButton_clicked ()
 
void on_ResetModelButton_clicked ()
 

Protected Member Functions

void UpdateButtonsState ()
 
void OnGuiCreated () override
 Called just after GUI is initialized.
 
void OnGuiDestroyed () override
 Called just before GUI is released.
 
- 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.
 
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::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)
 
- 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 22 of file CTeachableParamsDecoratorGuiComp.h.

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ IsReadOnly()

bool iinspgui::CTeachableParamsDecoratorGuiComp::IsReadOnly ( ) const
overridevirtual

Returns true if the model data can be changed.

Implements imod::IModelEditor.

◆ on_ResetModelButton_clicked

void iinspgui::CTeachableParamsDecoratorGuiComp::on_ResetModelButton_clicked ( )
protectedslot

◆ on_TeachModelButton_clicked

void iinspgui::CTeachableParamsDecoratorGuiComp::on_TeachModelButton_clicked ( )
protectedslot

◆ OnGuiCreated()

void iinspgui::CTeachableParamsDecoratorGuiComp::OnGuiCreated ( )
overrideprotectedvirtual

Called just after GUI is initialized.

Reimplemented from istdgui::CGuiComponentBase.

◆ OnGuiDestroyed()

void iinspgui::CTeachableParamsDecoratorGuiComp::OnGuiDestroyed ( )
overrideprotectedvirtual

Called just before GUI is released.

Reimplemented from istdgui::CGuiComponentBase.

◆ OnModelAttached()

bool iinspgui::CTeachableParamsDecoratorGuiComp::OnModelAttached ( imod::IModel * modelPtr,
istd::IChangeable::ChangeSet & changeMask )
overridevirtual

This call back function will be called, if an observable object is about to be attached.

This function returns a true, if observable object is accepted by the implementation logic of the observer, otherwise returns false.

Parameters
modelPtrpointer to model object being attached.
changeMaskoutput parameter returning set of change ID's will be accepted. returns a false.

Reimplemented from imod::CSingleModelObserverBase.

◆ OnModelDetached()

bool iinspgui::CTeachableParamsDecoratorGuiComp::OnModelDetached ( imod::IModel * modelPtr)
overridevirtual

This call back function will be called, if an observable object is about to be detached.

Reimplemented from imod::CSingleModelObserverBase.

◆ SetReadOnly()

void iinspgui::CTeachableParamsDecoratorGuiComp::SetReadOnly ( bool state)
overridevirtual

Set flag that the model data can be changed.

Returns
true, if this feature is supported.

Implements imod::IModelEditor.

◆ UpdateButtonsState()

void iinspgui::CTeachableParamsDecoratorGuiComp::UpdateButtonsState ( )
protected

◆ UpdateEditor()

void iinspgui::CTeachableParamsDecoratorGuiComp::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.

◆ UpdateModelFromEditor()

void iinspgui::CTeachableParamsDecoratorGuiComp::UpdateModelFromEditor ( ) const
overridevirtual

Updates model from editor.

This method will be called only if GUI is connected and model is attached.

Implements imod::IModelEditor.


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

© Witold Gantzke and Kirill Lepskiy