iprm::CTextParam Class Reference

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

#include <CTextParam.h>

Inheritance diagram for iprm::CTextParam:

Public Member Functions
virtual QString	GetText () const override
	Get the text value.
virtual void	SetText (const QString &text) override
	Set the text value.
virtual bool	IsReadOnly () const override
	Return true if the text is read-only.
virtual bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.
virtual int	GetSupportedOperations () const override
	Get set of flags for supported operations.
virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
virtual bool	IsEqual (const IChangeable &object) const override
virtual istd::TUniqueInterfacePtr< istd::IChangeable >	CloneMe (istd::IChangeable::CompatibilityMode mode=istd::IChangeable::CM_WITHOUT_REFS) const override
	Make a copy of this object.
virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
	Reset data to its default state.
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 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.
Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Protected Attributes
QString	m_text

Additional Inherited Members
Public Types inherited from istd::IChangeable
enum	ChangeFlags {   CF_ACF_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 }
	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...
typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap
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 16 of file CTextParam.h.

Member Function Documentation

CloneMe()

virtual istd::TUniqueInterfacePtr< istd::IChangeable > iprm::CTextParam::CloneMe ( istd::IChangeable::CompatibilityMode  mode = istd::IChangeable::CM_WITHOUT_REFS ) const

overridevirtual

Make a copy of this object.

Returns

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

Reimplemented from istd::IChangeable.

CopyFrom()

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

overridevirtual

GetSupportedOperations()

virtual int iprm::CTextParam::GetSupportedOperations ( ) const

overridevirtual

Get set of flags for supported operations.

See also

SupportedOperations

Reimplemented from istd::IChangeable.

GetText()

virtual QString iprm::CTextParam::GetText ( ) const

overridevirtual

Get the text value.

Returns

The current text content as QString.

QString text = textParam.GetText();
qDebug() << "Current text:" << text;

See also

SetText

Implements iprm::ITextParam.

IsEqual()

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

overridevirtual

IsReadOnly()

virtual bool iprm::CTextParam::IsReadOnly ( ) const

overridevirtual

Return true if the text is read-only.

Indicates whether the text can be modified by the user or application. Read-only parameters are typically used for calculated values or display-only information.

Returns

true if text cannot be modified, false if text is editable.

if (!textParam.IsReadOnly())
{
    textParam.SetText("Editable value");
}
else
{
    qDebug() << "This parameter is read-only";
}

See also

SetText

Implements iprm::ITextParam.

Reimplemented in iprm::CTextParamComp.

ResetData()

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

overridevirtual

Reset data to its default state.

Default implementation in istd::IChangeable does nothing.

Returns

true if the operation was successful, and false otherwise.

Reimplemented from istd::IChangeable.

Serialize()

virtual 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.

Reimplemented in iprm::CTextParamComp.

SetText()

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

overridevirtual

Set the text value.

Changes the text content of this parameter.

Parameters

text	New text value to set. Can be empty string.

Note

If the parameter is read-only (IsReadOnly() returns true), the behavior may be implementation-dependent.

textParam.SetText("New value");
 
// Clear text
textParam.SetText(QString());
 
// Set multiline text
textParam.SetText("Line 1\nLine 2\nLine 3");

See also

GetText, IsReadOnly

Implements iprm::ITextParam.

Reimplemented in iprm::CTextParamComp.

Member Data Documentation

m_text

QString iprm::CTextParam::m_text

protected

Definition at line 35 of file CTextParam.h.

---

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

• Acf/Include/iprm/CTextParam.h