iprm::ITextParam Class Reference

Interface for an object containing simple text. More...

#include <ITextParam.h>

Inheritance diagram for iprm::ITextParam:

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

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

Interface for an object containing simple text.

ITextParam provides a basic text parameter interface for storing and retrieving string values. It supports read-only and editable modes, making it suitable for both input parameters and calculated/display-only values.

Usage Example

#include <iprm/CTextParam.h>
 
// Create a text parameter
iprm::CTextParam textParam;
 
// Set text value
textParam.SetText("Hello, World!");
 
// Get text value
QString text = textParam.GetText();
qDebug() << "Text:" << text;
 
// Check if read-only
bool isReadOnly = textParam.IsReadOnly();
if (!isReadOnly)
{
    textParam.SetText("New value");
}
 
// Clear text
textParam.SetText(QString());

Serialization Example

#include <iser/CMemoryReadArchive.h>
#include <iser/CMemoryWriteArchive.h>
 
iprm::CTextParam param;
param.SetText("Important data");
 
// Save to archive
iser::CMemoryWriteArchive writeArchive(nullptr);
param.Serialize(writeArchive);
 
// Load from archive
iprm::CTextParam loadedParam;
iser::CMemoryReadArchive readArchive(writeArchive);
loadedParam.Serialize(readArchive);
 
QString restoredText = loadedParam.GetText();  // "Important data"

Note

Inherits from iser::ISerializable for persistence support.

Supports standard IChangeable operations (clone, copy, compare, reset).

See also

CTextParam, IIdParam, INameParam

Definition at line 75 of file ITextParam.h.

Member Function Documentation

GetText()

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

pure virtual

Get the text value.

Returns

The current text content as QString.

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

See also

SetText

Implemented in iprm::CTextParam.

IsReadOnly()

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

pure virtual

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

Implemented in iprm::CTextParam, and iprm::CTextParamComp.

SetText()

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

pure virtual

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

Implemented in iprm::CTextParamComp, and iprm::CTextParam.

---

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

• Acf/Include/iprm/ITextParam.h