Public Types | Public Member Functions | Protected Member Functions | List of all members
iimg::CMultiPageBitmapBase Class Referenceabstract

Definition of a multi-page bitmap document. More...

#include <CMultiPageBitmapBase.h>

Inheritance diagram for iimg::CMultiPageBitmapBase:
idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument > iimg::IMultiPageBitmapController idoc::IMultiPageDocument idoc::CStandardDocumentMetaInfo iprm::IOptionsList iimg::IMultiBitmapProvider istd::IChangeable idoc::IDocumentMetaInfo iser::ISerializable istd::IChangeable istd::IChangeable istd::IPolymorphic istd::IChangeable istd::IChangeable istd::IPolymorphic istd::IPolymorphic istd::IPolymorphic istd::IPolymorphic iimg::CMultiPageBitmapComp iimg::TMultiPageBitmap< BitmapImpl >

Public Types

typedef
idoc::CMultiPageDocumentBase 
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...
 
- 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_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 control constraints behavior. More...
 

Public Member Functions

virtual istd::IChangeableInsertPage (const idoc::IDocumentMetaInfo *pageMetaInfoPtr=NULL, const iprm::IParamsSet *pageParameterPtr=NULL, int position=-1)
 Insert a new document page at the given position. More...
 
virtual const iprm::IOptionsListGetBitmapListInfo () const
 Get optional information about bitmaps in form of section constraints. More...
 
virtual int GetBitmapsCount () const
 Get number of produced bitmaps. More...
 
virtual const iimg::IBitmapGetBitmap (int bitmapIndex) const
 Get access to produced bitmap object. More...
 
virtual iimg::IBitmapInsertBitmap (iimg::IBitmap::PixelFormat pixelFormat, const istd::CIndex2d &size)
 Inserts a new bitmap. More...
 
virtual iimg::IBitmapInsertBitmap (iimg::IBitmap::PixelFormat pixelFormat, const istd::CIndex2d &size, void *dataPtr, bool releaseFlag, int linesDifference=0)
 Inserts a new bitmap. More...
 
virtual void RemoveBitmap (int index)
 Removes the bitmap at the given index. More...
 
virtual bool CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
- Public Member Functions inherited from idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >
virtual int GetPagesCount () const
 
virtual const istd::IChangeableGetDocumentPage (int pageIndex) const
 
virtual const
idoc::IDocumentMetaInfo
GetPageMetaInfo (int pageIndex) const
 
virtual void ResetPages ()
 
virtual bool RemovePage (int pageIndex)
 
virtual const IDocumentMetaInfoGetDocumentMetaInfo () const
 
virtual int GetOptionsFlags () const
 Get constraints flags. More...
 
virtual int GetOptionsCount () const
 Get number of managed options. More...
 
virtual QString GetOptionName (int index) const
 Get name of specified option. More...
 
virtual QString GetOptionDescription (int index) const
 Get human readable description for a option with the index index. More...
 
virtual QByteArray GetOptionId (int index) const
 Get option ID. More...
 
virtual bool IsOptionEnabled (int index) const
 Return true if the option is enabled and can be selected. More...
 
virtual bool Serialize (iser::IArchive &archive)
 Load or store state of this object as a archive stream. More...
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction. More...
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction. More...
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes. More...
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from idoc::CStandardDocumentMetaInfo
virtual MetaInfoTypes GetMetaInfoTypes (bool allowReadOnly=true) const
 Get list of contained meta info types. More...
 
virtual QVariant GetMetaInfo (int metaInfoType) const
 Get document's meta info. More...
 
virtual bool SetMetaInfo (int metaInfoType, const QVariant &metaInfo)
 Set new document's meta information for a given meta type. More...
 
virtual QString GetMetaInfoName (int metaInfoType) const
 Get a human readable name for a given meta information type. More...
 
virtual QString GetMetaInfoDescription (int metaInfoType) const
 Get a human readable description for a given meta information type. More...
 
virtual bool IsMetaInfoWritable (int metaInfoType) const
 Check if meta information can be changed. More...
 
virtual bool IsEqual (const IChangeable &object) const
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 
virtual istd::IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data. More...
 

Protected Member Functions

virtual IBitmapCreateBitmap () const =0
 
- 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. More...
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event. More...
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes. More...
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set. More...
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set. More...
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set. More...
 
- Protected Types inherited from idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >
typedef QList< Page > Pages
 
- Protected Attributes inherited from idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >
Pages m_documentPages
 

Detailed Description

Definition of a multi-page bitmap document.

Definition at line 19 of file CMultiPageBitmapBase.h.

Member Typedef Documentation

Definition at line 24 of file CMultiPageBitmapBase.h.

Member Function Documentation

virtual bool iimg::CMultiPageBitmapBase::CopyFrom ( const istd::IChangeable object,
CompatibilityMode  mode = CM_WITHOUT_REFS 
)
virtual

Copy this object from another one.

Default implementation in istd::IChangeable does nothing.

Reimplemented from idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >.

virtual IBitmap* iimg::CMultiPageBitmapBase::CreateBitmap ( ) const
protectedpure virtual
virtual const iimg::IBitmap* iimg::CMultiPageBitmapBase::GetBitmap ( int  bitmapIndex) const
virtual

Get access to produced bitmap object.

Returns
pointer to bitmap instance if this bitmap is accessible, or NULL.

Implements iimg::IMultiBitmapProvider.

virtual const iprm::IOptionsList* iimg::CMultiPageBitmapBase::GetBitmapListInfo ( ) const
virtual

Get optional information about bitmaps in form of section constraints.

It allows to get name and description of each bitmap channel.

Implements iimg::IMultiBitmapProvider.

virtual int iimg::CMultiPageBitmapBase::GetBitmapsCount ( ) const
virtual

Get number of produced bitmaps.

Implements iimg::IMultiBitmapProvider.

virtual iimg::IBitmap* iimg::CMultiPageBitmapBase::InsertBitmap ( iimg::IBitmap::PixelFormat  pixelFormat,
const istd::CIndex2d size 
)
virtual

Inserts a new bitmap.

Parameters
pixelFormatThe pixel format.
sizeSize of the page bitmap.
Returns
null if it fails, else a pointer to the inserted bitmap.

Implements iimg::IMultiPageBitmapController.

virtual iimg::IBitmap* iimg::CMultiPageBitmapBase::InsertBitmap ( iimg::IBitmap::PixelFormat  pixelFormat,
const istd::CIndex2d size,
void *  dataPtr,
bool  releaseFlag,
int  linesDifference = 0 
)
virtual

Inserts a new bitmap.

Parameters
pixelFormatThe pixel format.
sizeThe size of the page bitmap.
[in,out]dataPtrIf non-null, the bitmap data pointer.
releaseFlagMemory controlling flag.
linesDifference(Optional) The distance between adjacent lines in bytes.
Returns
null if it fails, else a pointer to the inserted bitmap.

Implements iimg::IMultiPageBitmapController.

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

Insert a new document page at the given position.

Parameters
pageMetaInfoPtrMeta-information of the document.
pageParameterPtrOptionally given parameters for the page creation.
positionInsertion position in the page container. If this value is negative, the new page will be inserted after the last page of the document.
Returns
The method returns the object, which represents the contents of the page.

Implements idoc::IMultiPageDocument.

virtual void iimg::CMultiPageBitmapBase::RemoveBitmap ( int  index)
virtual

Removes the bitmap at the given index.

Parameters
indexIndex of the bitmap page.

Implements iimg::IMultiPageBitmapController.

virtual bool iimg::CMultiPageBitmapBase::ResetData ( CompatibilityMode  mode = CM_WITHOUT_REFS)
virtual

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


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy