iprm::CTextParam Class Reference

Implementation of the text value over iprm::ITextParam interface. More...

#include <CTextParam.h>

Inheritance diagram for iprm::CTextParam:

Collaboration diagram for iprm::CTextParam:

Public Member Functions
QString	GetText () const override
	Get the text.
void	SetText (const QString &text) override
	Set the text.
bool	IsReadOnly () const override
	Return true, if the text is readonly.
bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.
int	GetSupportedOperations () const override
	Get set of flags for supported operations.
bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
bool	IsEqual (const IChangeable &object) const override
std::unique_ptr< istd::IChangeable >	CloneMe (istd::IChangeable::CompatibilityMode mode=istd::IChangeable::CM_WITHOUT_REFS) const override
	Make a copy of this object.
bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
	Reset data to its default state.
Public Member Functions inherited from iprm::ITextParam
Public Member Functions inherited from iser::ISerializable
virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.
Public Member Functions inherited from istd::IChangeable
virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.
virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.
virtual QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.
virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.
virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.
virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.
virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Protected Attributes
QString	m_text

Additional Inherited Members
Public Types inherited from istd::IChangeable
enum	ChangeFlags {   CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING ,   CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...
enum	SupportedOperations {   SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 ,   SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5 }
	Flags for supported operations. More...
enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...
Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.
static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.
static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.
static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.
Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.
virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Detailed Description

Implementation of the text value over iprm::ITextParam interface.

Definition at line 21 of file CTextParam.h.

Member Function Documentation

CloneMe()

std::unique_ptr< istd::IChangeable > iprm::CTextParam::CloneMe ( istd::IChangeable::CompatibilityMode mode = istd::IChangeable::CM_WITHOUT_REFS ) const

overridevirtual

Make a copy of this object.

You may check, if this functionality is supported over GetSupportedOperations().

Returns

new instance or nullptr, if this operation is not supported.

Reimplemented from istd::IChangeable.

CopyFrom()

bool iprm::CTextParam::CopyFrom ( const IChangeable & object, CompatibilityMode mode = CM_WITHOUT_REFS )

override

GetSupportedOperations()

int iprm::CTextParam::GetSupportedOperations ( ) const

overridevirtual

Get set of flags for supported operations.

See also

SupportedOperations

Reimplemented from istd::IChangeable.

GetText()

QString iprm::CTextParam::GetText ( ) const

overridevirtual

Get the text.

Implements iprm::ITextParam.

IsEqual()

bool iprm::CTextParam::IsEqual ( const IChangeable & object ) const

override

IsReadOnly()

bool iprm::CTextParam::IsReadOnly ( ) const

overridevirtual

Return true, if the text is readonly.

Implements iprm::ITextParam.

Reimplemented in iprm::CTextParamComp.

ResetData()

bool iprm::CTextParam::ResetData ( CompatibilityMode mode = CM_WITHOUT_REFS )

overridevirtual

Reset data to its default state.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Returns

true if the operation was successful, and false otherwise.

Reimplemented from istd::IChangeable.

Serialize()

bool iprm::CTextParam::Serialize ( iser::IArchive & archive )

overridevirtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also

iser::IArchive

Implements iser::ISerializable.

SetText()

void iprm::CTextParam::SetText ( const QString & text )

overridevirtual

Set the text.

Implements iprm::ITextParam.

Reimplemented in iprm::CTextParamComp.

Member Data Documentation

m_text

QString iprm::CTextParam::m_text

protected

Definition at line 40 of file CTextParam.h.

---

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

• iprm/CTextParam.h