iimg::IMultiPageBitmapController Class Reference

Interface of a controller for handling multi-page bitmaps. More...

#include <IMultiPageBitmapController.h>

Inheritance diagram for iimg::IMultiPageBitmapController:

Collaboration diagram for iimg::IMultiPageBitmapController:

Public Member Functions
virtual iimg::IBitmap *	InsertBitmap (iimg::IBitmap::PixelFormat pixelFormat, const istd::CIndex2d &size, const idoc::IDocumentMetaInfo *metaInfoPtr=nullptr)=0
	Inserts a new bitmap.
virtual iimg::IBitmap *	InsertBitmap (iimg::IBitmap::PixelFormat pixelFormat, const istd::CIndex2d &size, istd::COptMemory &&data, int linesDifference=0, const idoc::IDocumentMetaInfo *metaInfoPtr=nullptr)=0
	Inserts a new bitmap.
virtual void	RemoveBitmap (int index)=0
	Removes the bitmap at the given index.
Public Member Functions inherited from iimg::IMultiBitmapProvider
virtual const iprm::IOptionsList *	GetBitmapListInfo () const =0
	Get optional information about bitmaps in form of section constraints.
virtual int	GetBitmapsCount () const =0
	Get number of produced bitmaps.
virtual const iimg::IBitmap *	GetBitmap (int bitmapIndex) const =0
	Get access to produced bitmap object.
Public Member Functions inherited from istd::IChangeable
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 std::unique_ptr< 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 QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.
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
Public Types inherited from istd::IChangeable
enum	ChangeFlags {   CF_ICF_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 , SO_CHANGE_LOCK = 1 << 5 }
	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...
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

Interface of a controller for handling multi-page bitmaps.

Definition at line 23 of file IMultiPageBitmapController.h.

Member Function Documentation

InsertBitmap() [1/2]

virtual iimg::IBitmap * iimg::IMultiPageBitmapController::InsertBitmap ( iimg::IBitmap::PixelFormat pixelFormat, const istd::CIndex2d & size, const idoc::IDocumentMetaInfo * metaInfoPtr = nullptr )

pure virtual

Inserts a new bitmap.

Parameters

pixelFormat	The pixel format.
size	Size of the page bitmap.

Returns

null if it fails, else a pointer to the inserted bitmap.

Implemented in iimg::CMultiPageBitmapBase.

InsertBitmap() [2/2]

virtual iimg::IBitmap * iimg::IMultiPageBitmapController::InsertBitmap ( iimg::IBitmap::PixelFormat pixelFormat, const istd::CIndex2d & size, istd::COptMemory && data, int linesDifference = 0, const idoc::IDocumentMetaInfo * metaInfoPtr = nullptr )

pure virtual

Inserts a new bitmap.

Parameters

	pixelFormat	pixel format.
	size	size of the page bitmap.
[in,out]	data	external image buffer.
	linesDifference	distance between adjacent lines in bytes.

Returns

null if it fails, else a pointer to the inserted bitmap.

Implemented in iimg::CMultiPageBitmapBase.

RemoveBitmap()

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

pure virtual

Removes the bitmap at the given index.

Parameters

index

Index of the bitmap page.

Implemented in iimg::CMultiPageBitmapBase.

---

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

• iimg/IMultiPageBitmapController.h