iprm::CNameParam Class Reference

Implementation of a named object over iprm::INameParam interface. More...

#include <CNameParam.h>

Inheritance diagram for iprm::CNameParam:

Public Member Functions
virtual const QString &	GetName () const override
	Get the object name.
virtual void	SetName (const QString &name) override
	Set the object name.
virtual bool	IsNameFixed () const override
	Return true if the name is fixed (non-editable).
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 istd::IChangeableUniquePtr	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.
virtual bool	IsEqual (const IChangeable &object) const override
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_name

Additional Inherited Members
Public Types inherited from iprm::INameParam
enum	ChangeFlags { CF_RENAME = 0x15345e0 }
	Data model change notification flags. More...
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 a named object over iprm::INameParam interface.

Definition at line 16 of file CNameParam.h.

Member Function Documentation

CloneMe()

virtual istd::IChangeableUniquePtr iprm::CNameParam::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.

Reimplemented in iqtgui::CHierarchicalCommand.

CopyFrom()

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

overridevirtual

GetName()

virtual const QString & iprm::CNameParam::GetName ( ) const

overridevirtual

Get the object name.

Returns

Reference to the current name as QString.

const QString& name = nameParam.GetName();
qDebug() << "Name:" << name;

See also

SetName

Implements iprm::INameParam.

Referenced by iqtgui::CCommandTools::CreateMenu().

GetSupportedOperations()

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

overridevirtual

Get set of flags for supported operations.

See also

SupportedOperations

Reimplemented from istd::IChangeable.

Reimplemented in iqtgui::CHierarchicalCommand.

IsEqual()

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

overridevirtual

IsNameFixed()

virtual bool iprm::CNameParam::IsNameFixed ( ) const

overridevirtual

Return true if the name is fixed (non-editable).

Indicates whether the name can be changed by users. Fixed names are typically used for system-defined or read-only objects.

Returns

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

bool canRename = !nameParam.IsNameFixed();
if (canRename)
{
    // Allow user to edit name
    nameParam.SetName(userInput);
}

See also

SetName

Implements iprm::INameParam.

Reimplemented in iprm::CNameParamComp.

ResetData()

virtual bool iprm::CNameParam::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::CNameParam::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 iqtgui::CHierarchicalCommand.

SetName()

virtual void iprm::CNameParam::SetName ( const QString &  name )

overridevirtual

Set the object name.

Changes the name of this parameter.

Parameters

name	New name value.

Note

If IsNameFixed() returns true, setting the name may be restricted.

Triggers CF_RENAME notification on change.

if (!nameParam.IsNameFixed())
{
    nameParam.SetName("New Name");
}

See also

GetName, IsNameFixed, CF_RENAME

Implements iprm::INameParam.

Reimplemented in iprm::CNameParamComp, and iqtgui::CHierarchicalCommand.

Member Data Documentation

m_name

QString iprm::CNameParam::m_name

protected

Definition at line 35 of file CNameParam.h.

---

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

• Acf/Include/iprm/CNameParam.h