ACF $AcfVersion:0$
Public Types | Public Member Functions | Protected Member Functions | List of all members
imod::CModelBase Class Referenceabstract

Basic implementation of a model. More...

#include <CModelBase.h>

Inheritance diagram for imod::CModelBase:
imod::IModel istd::IPolymorphic imod::TModelWrap< ibase::ICommandsProvider > imod::TModelWrap< TExtMessage< Element > > imod::TModelWrap< iprm::CSelectionParam > imod::TModelWrap< RuntimeStatus > imod::TModelWrap< ibase::TContainer > imod::TModelWrap< DocumentInfo > imod::TModelWrap< CurrentFile > imod::TModelWrap< iprm::CEnableableParam > imod::TModelWrap< iprm::CParamsManagerCompBase::SelectedParams > imod::TModelWrap< iimg::CBitmap > imod::TModelWrap< DocumentSelectionInfo > imod::TModelWrap< CommandsProvider > imod::TModelWrap< iqtgui::CGuiComponentBase::VisualStatus > imod::TModelWrap< PageModel > imod::TModelWrap< VisibleWindowsManager > imod::TModelWrap< Base >

Public Types

typedef QSet< IObserver * > Observers
 

Public Member Functions

 CModelBase ()
 
virtual ~CModelBase ()
 
virtual int GetObserverCount () const
 Returns count of connected observers.
 
virtual Observers GetObservers () const
 Returns set of all observers.
 
istd::IChangeable::ChangeSet GetCumulatedChanges () const
 
virtual bool AttachObserver (imod::IObserver *observerPtr) override
 Attaches model object to observer observerPtr.
 
virtual void DetachObserver (imod::IObserver *observerPtr) override
 Detaches model object from observer observerPtr.
 
virtual void DetachAllObservers () override
 Detaches all attached observers.
 
virtual bool IsAttached (const imod::IObserver *observerPtr) const override
 Returns true if observer observer is attached to this model object.
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Protected Member Functions

void NotifyBeforeChange (const istd::IChangeable::ChangeSet &changeSet, bool isGroup)
 Called before each change.
 
void NotifyAfterChange (const istd::IChangeable::ChangeSet &changeSet)
 Called after each change.
 
virtual void OnBeginGlobalChanges ()=0
 Called before global changes will be started.
 
virtual void OnEndGlobalChanges (const istd::IChangeable::ChangeSet &changeSet)=0
 Called after global changes are finished.
 

Detailed Description

Basic implementation of a model.

Definition at line 24 of file CModelBase.h.

Member Typedef Documentation

◆ Observers

Definition at line 27 of file CModelBase.h.

Constructor & Destructor Documentation

◆ CModelBase()

imod::CModelBase::CModelBase ( )

◆ ~CModelBase()

virtual imod::CModelBase::~CModelBase ( )
virtual

Member Function Documentation

◆ AttachObserver()

virtual bool imod::CModelBase::AttachObserver ( imod::IObserver observerPtr)
overridevirtual

Attaches model object to observer observerPtr.

Warning
Please note, that double call of this function for the same observer will cause an assertion.
Parameters
observerPtrobserver, cannot be NULL.

Implements imod::IModel.

◆ DetachAllObservers()

virtual void imod::CModelBase::DetachAllObservers ( )
overridevirtual

Detaches all attached observers.

Implements imod::IModel.

Referenced by icomp::TModelCompWrap< Base >::OnComponentDestroyed().

◆ DetachObserver()

virtual void imod::CModelBase::DetachObserver ( imod::IObserver observerPtr)
overridevirtual

Detaches model object from observer observerPtr.

Warning
Please note, that call of this function for the observer which is not attached to the observer observer will cause an assertion. To prevent this, you can use the isAttached() function.

Implements imod::IModel.

◆ GetCumulatedChanges()

istd::IChangeable::ChangeSet imod::CModelBase::GetCumulatedChanges ( ) const
inline

Definition at line 129 of file CModelBase.h.

◆ GetObserverCount()

virtual int imod::CModelBase::GetObserverCount ( ) const
virtual

Returns count of connected observers.

◆ GetObservers()

virtual Observers imod::CModelBase::GetObservers ( ) const
virtual

Returns set of all observers.

◆ IsAttached()

virtual bool imod::CModelBase::IsAttached ( const imod::IObserver observerPtr) const
overridevirtual

Returns true if observer observer is attached to this model object.

Implements imod::IModel.

◆ NotifyAfterChange()

void imod::CModelBase::NotifyAfterChange ( const istd::IChangeable::ChangeSet changeSet)
protected

Called after each change.

Returns
true, if end notification was done.

◆ NotifyBeforeChange()

void imod::CModelBase::NotifyBeforeChange ( const istd::IChangeable::ChangeSet changeSet,
bool  isGroup 
)
protected

Called before each change.

Returns
true, if some notification was done.

◆ OnBeginGlobalChanges()

virtual void imod::CModelBase::OnBeginGlobalChanges ( )
protectedpure virtual

◆ OnEndGlobalChanges()

virtual void imod::CModelBase::OnEndGlobalChanges ( const istd::IChangeable::ChangeSet changeSet)
protectedpure virtual

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