Realization of the multi-page bitmap sequence used the component factory for the instatiation of the single sequence frame. More...

#include <CMultiPageBitmapSequenceComp.h>

Inheritance diagram for iimg::CMultiPageBitmapSequenceComp:

Public Types
typedef icomp::CComponentBase	BaseClass

Public Types inherited from idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >
typedef idoc::IMultiPageDocument	BaseClass

typedef CStandardDocumentMetaInfo	BaseClass2

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 Types inherited from idoc::IDocumentMetaInfo
enum	ChangeFlags { CF_METAINFO = 0xd83067d }
	Data model change notification flags. More...

enum	MetaInfoType { MIT_TITLE , MIT_AUTHOR , MIT_CREATOR , MIT_DESCRIPTION , MIT_CREATION_TIME , MIT_MODIFICATION_TIME , MIT_CREATOR_VERSION , MIT_DOCUMENT_VERSION , MIT_CONTENT_CHECKSUM , MIT_USER = 1024 }
	Type of the meta information. More...

typedef QSet< int >	MetaInfoTypes

Public Types inherited from iprm::IOptionsList
enum	ChangeFlags { CF_OPTIONS_CHANGED = 0x8263d86 , CF_OPTION_RENAMED }
	Flags for changes related to this interface. More...

enum	OptionsFlags { SCF_NONE = 0 , SCF_SUPPORT_UNIQUE_ID = 256 , SFC_DISABLE_ALLOWED = 32 }
	Flags for controlling constraints behavior. More...

Protected Member Functions
virtual istd::IChangeable *	InsertPage (const idoc::IDocumentMetaInfo pageMetaInfoPtr=NULL, const iprm::IParamsSet pageParameterPtr=NULL, int position=-1) override
	Insert a new document page at the given position.

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 idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >
virtual bool	SerializePage (iser::IArchive &archive, Page &pageItem)
	Serialize a single page item into or from the archive.

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
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 idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >
virtual int	GetPagesCount () const override

virtual const istd::IChangeable &	GetDocumentPage (int pageIndex) const override

virtual const idoc::IDocumentMetaInfo *	GetPageMetaInfo (int pageIndex) const override

virtual void	ResetPages () override

virtual bool	RemovePage (int pageIndex) override

virtual const IDocumentMetaInfo &	GetDocumentMetaInfo () const override

virtual int	GetOptionsFlags () const override
	Get constraints flags.

virtual int	GetOptionsCount () const override
	Get number of managed options.

virtual QString	GetOptionName (int index) const override
	Get name of specified option.

virtual QString	GetOptionDescription (int index) const override
	Get human-readable description for an option.

virtual QByteArray	GetOptionId (int index) const override
	Get option ID.

virtual bool	IsOptionEnabled (int index) const override
	Return true if the option is enabled and can be selected.

virtual bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.

virtual bool	CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
	Copy this object from another one.

virtual bool	ResetData (CompatibilityMode mode) override
	Reset data to its default state.

Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

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 idoc::CStandardDocumentMetaInfo
virtual MetaInfoTypes	GetMetaInfoTypes (bool allowReadOnly=true) const override
	Get list of contained meta info types.

virtual QVariant	GetMetaInfo (int metaInfoType) const override
	Get document's meta info.

virtual bool	SetMetaInfo (int metaInfoType, const QVariant &metaInfo) override
	Set new document's meta information for a given meta type.

virtual void	RemoveMetaInfo (int metaInfoType) override
	Remove document's meta information for a given meta type.

virtual QByteArray	GetMetaInfoId (int metaInfoType) const override
	Get an unique ID of the meta information.

virtual QString	GetMetaInfoName (int metaInfoType) const override
	Get a human readable name for a given meta information type.

virtual QString	GetMetaInfoDescription (int metaInfoType) const override
	Get a human readable description for a given meta information type.

virtual bool	IsMetaInfoWritable (int metaInfoType) const override
	Check if meta information can be changed.

virtual bool	IsEqual (const IChangeable &object) const override

virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override

virtual istd::TUniqueInterfacePtr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const override
	Make a copy of this object.

Public Member Functions inherited from iser::ISerializable
virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.

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 Public Member Functions inherited from idoc::IDocumentMetaInfo
template<class T >
static std::optional< T >	GetMetaInfoT (const idoc::IDocumentMetaInfo &metaInfo, int key)
	Type-safe retrieval of metadata values.

Protected Types inherited from idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >
typedef QList< Page >	Pages

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 idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >
Pages	m_documentPages

Detailed Description

Realization of the multi-page bitmap sequence used the component factory for the instatiation of the single sequence frame.

Definition at line 21 of file CMultiPageBitmapSequenceComp.h.

Member Typedef Documentation

◆ BaseClass

typedef icomp::CComponentBase iimg::CMultiPageBitmapSequenceComp::BaseClass

Definition at line 26 of file CMultiPageBitmapSequenceComp.h.

Member Function Documentation

◆ InsertPage()

virtual istd::IChangeable * iimg::CMultiPageBitmapSequenceComp::InsertPage	(	const idoc::IDocumentMetaInfo *	pageMetaInfoPtr = `NULL`,
		const iprm::IParamsSet *	pageParameterPtr = `NULL`,
		int	position = `-1`
	)

overrideprotectedvirtual

Insert a new document page at the given position.

Parameters

pageMetaInfoPtr	Optional meta-information for the new page.
pageParameterPtr	Optional parameters for page creation.
position	Insertion position in the page container. If negative, the new page will be inserted after the last page.

Returns: Pointer to the object representing the contents of the new page.

Example: // Add page at the end

istd::IChangeable* newPage = mpDoc->InsertPage(nullptr, nullptr, -1);

// Insert page at the beginning

istd::IChangeable* firstPage = mpDoc->InsertPage(nullptr, nullptr, 0);

istd::IChangeable
Common interface for data model objects, which can be changed.
Definition IChangeable.h:28

Implements idoc::IMultiPageDocument.

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

Acf/Include/iimg/CMultiPageBitmapSequenceComp.h

Public Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ InsertPage()