Component for providing of application info such as program name, type, copyright text etc. More...

#include <CApplicationInfoComp.h>

Inheritance diagram for ibase::CApplicationInfoComp:

Public Types
typedef icomp::CComponentBase	BaseClass

Public Types inherited from ibase::IApplicationInfo
enum	ApplicationAttribute { AA_COMPANY_NAME , AA_PRODUCT_NAME , AA_PRODUCT_EDITION , AA_APPLICATION_ID , AA_APPLICATION_NAME , AA_APPLICATION_SUBNAME , AA_APPLICATION_TYPE , AA_APPLICATION_PATH , AA_LEGAL_COPYRIGHT , AA_MAIN_VERSION , AA_USER = 100 }

Public Member Functions
virtual QString	GetApplicationAttribute (int attributeId, bool allowTranslation=true) const override
	Get value of application attribute.

virtual int	GetMainVersionId () const override
	Get ID of main module version ID for `iser::IVersionInfo`.

virtual const iser::IVersionInfo &	GetVersionInfo () const override
	Get access to application version info.

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 ()

Protected Member Functions
virtual bool	GetVersionNumber (int versionId, quint32 &result) const override
	Get version of archived stream for specific versioning type.

virtual QString	GetVersionIdDescription (int versionId) const override
	Get description of version ID.

virtual VersionIds	GetVersionIds () const override
	Get list of version ID's.

virtual QString	GetEncodedVersionName (int versionId, quint32 versionNumber) const override
	Encode version number to human readable form.

Protected Member Functions inherited from icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.

virtual void	OnComponentCreated ()

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.

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.

Additional Inherited Members
Protected Types inherited from iser::IVersionInfo
enum	VersionId { AcfVersionId = 0 , QtVersionId = 1023 , UserVersionId = 1024 }
	Type of version. More...

enum	{ UnknownVersion = 0xffffffff }

typedef QSet< int >	VersionIds

Protected 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 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())

Static Protected 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.

Detailed Description

Component for providing of application info such as program name, type, copyright text etc.

Definition at line 18 of file CApplicationInfoComp.h.

Member Typedef Documentation

◆ BaseClass

typedef icomp::CComponentBase ibase::CApplicationInfoComp::BaseClass

Definition at line 24 of file CApplicationInfoComp.h.

Member Function Documentation

◆ GetApplicationAttribute()

virtual QString ibase::CApplicationInfoComp::GetApplicationAttribute	(	int	attributeId,
		bool	allowTranslation = `true`
	)		const

overridevirtual

Get value of application attribute.

Parameters

attributeId ID of application attribute

See also: ApplicationAttribute.

Implements ibase::IApplicationInfo.

◆ GetEncodedVersionName()

virtual QString ibase::CApplicationInfoComp::GetEncodedVersionName	(	int	versionId,
		quint32	versionNumber
	)		const

overrideprotectedvirtual

Encode version number to human readable form.

Implements iser::IVersionInfo.

◆ GetMainVersionId()

virtual int ibase::CApplicationInfoComp::GetMainVersionId ( ) const

overridevirtual

Get ID of main module version ID for iser::IVersionInfo.

This ID is used to identify which module is main application module. The meaning is the same as meaning of versionId parameters in interface iser::IVersionInfo.

Returns: ID of main module, or negative value if it is undefined.

Implements ibase::IApplicationInfo.

◆ GetVersionIdDescription()

virtual QString ibase::CApplicationInfoComp::GetVersionIdDescription ( int versionId ) const

overrideprotectedvirtual

Get description of version ID.

Parameters

versionId versioning type. It allows you to distinguish different version aspects. For example version number of framework cann differ from application version.

See also: VersionId, GetVersionNumber.

Implements iser::IVersionInfo.

◆ GetVersionIds()

virtual VersionIds ibase::CApplicationInfoComp::GetVersionIds ( ) const

overrideprotectedvirtual

Get list of version ID's.

Implements iser::IVersionInfo.

◆ GetVersionInfo()

virtual const iser::IVersionInfo & ibase::CApplicationInfoComp::GetVersionInfo ( ) const

overridevirtual

Get access to application version info.

Implements ibase::IApplicationInfo.

◆ GetVersionNumber()

virtual bool ibase::CApplicationInfoComp::GetVersionNumber	(	int	versionId,
		quint32 &	result
	)		const

overrideprotectedvirtual

Get version of archived stream for specific versioning type.

Parameters

versionId versioning type. It allows you to distinguish different version aspects. For example version number of framework cann differ from application version.

See also: VersionId.

Parameters

result output version number. For unknown version it will be set to bigg number to indicate of using the newest version.

Returns: true, if version is known.

Implements iser::IVersionInfo.

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

Acf/Include/ibase/CApplicationInfoComp.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ GetApplicationAttribute()

◆ GetEncodedVersionName()

◆ GetMainVersionId()

◆ GetVersionIdDescription()

◆ GetVersionIds()

◆ GetVersionInfo()

◆ GetVersionNumber()