iprm::CNameParamComp Class Reference

Component for automatic creation of the Universally Unique Identifier (UUID) More...

#include <CNameParamComp.h>

Inheritance diagram for iprm::CNameParamComp:

Public Types
typedef icomp::CComponentBase	BaseClass
typedef iprm::CNameParam	BaseClass2
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

Public Member Functions
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).
Public Member Functions inherited from icomp::CComponentBase
	CComponentBase ()
	Create component and assign it to specific context.
virtual const icomp::IComponent *	GetParentComponent (bool ownerOnly=false) const override
	Get parent of this component.
virtual void *	GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="") override
	Get access to specified component interface.
virtual IComponentContextSharedPtr	GetComponentContext () const override
	Get access to component context describing all application-specified component information loaded from components registry.
virtual void	SetComponentContext (const IComponentContextSharedPtr &contextPtr, const icomp::IComponent *parentPtr, bool isParentOwner) override
	Set component context of this component.
Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()
Public Member Functions inherited from iprm::CNameParam
virtual const QString &	GetName () const override
	Get the object name.
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.

Protected Member Functions
virtual void	OnComponentCreated () override
Protected Member Functions inherited from icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.
virtual void	OnComponentDestroyed ()
virtual const icomp::IRealComponentStaticInfo &	GetComponentStaticInfo () const =0
	Get access to static info of this component.
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.

Additional Inherited Members
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.
Static Protected Member Functions inherited from icomp::CComponentBase
static const icomp::IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)
static QByteArray	GetComponentId (const icomp::IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
Protected Attributes inherited from iprm::CNameParam
QString	m_name

Detailed Description

Component for automatic creation of the Universally Unique Identifier (UUID)

Definition at line 18 of file CNameParamComp.h.

Member Typedef Documentation

BaseClass

typedef icomp::CComponentBase iprm::CNameParamComp::BaseClass

Definition at line 23 of file CNameParamComp.h.

BaseClass2

typedef iprm::CNameParam iprm::CNameParamComp::BaseClass2

Definition at line 24 of file CNameParamComp.h.

Member Function Documentation

IsNameFixed()

virtual bool iprm::CNameParamComp::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

Reimplemented from iprm::CNameParam.

OnComponentCreated()

virtual void iprm::CNameParamComp::OnComponentCreated ( )

overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

SetName()

virtual void iprm::CNameParamComp::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

Reimplemented from iprm::CNameParam.

---

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

• Acf/Include/iprm/CNameParamComp.h