ICF 3.1.1.10
Technical documentation of ICF Libraries
idocproc::CRenderedDocumentPreviewGeneratorComp Class Reference

#include <CRenderedDocumentPreviewGeneratorComp.h>

Inheritance diagram for idocproc::CRenderedDocumentPreviewGeneratorComp:
Collaboration diagram for idocproc::CRenderedDocumentPreviewGeneratorComp:

Public Types

typedef icomp::CComponentBase BaseClass
 
typedef imod::TSingleModelObserverBase< idoc::IMultiPageDocumentBaseClass2
 
- Public Types inherited from imod::TSingleModelObserverBase< idoc::IMultiPageDocument >
typedef CSingleModelObserverBase BaseClass
 
typedef idoc::IMultiPageDocument ModelType
 
- Public Types inherited from imod::CSingleModelObserverBase
typedef imod::IModel ModelType
 
- 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...
 

Public Member Functions

const iprm::IOptionsListGetBitmapListInfo () const override
 Get optional information about bitmaps in form of section constraints.
 
int GetBitmapsCount () const override
 Get number of produced bitmaps.
 
const iimg::IBitmapGetBitmap (int bitmapIndex) const override
 Get access to produced bitmap object.
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context.
 
 CComponentBase (const CComponentBase &)=delete
 
CComponentBaseoperator= (const CComponentBase &)=delete
 
virtual const ICompositeComponentGetParentComponent (bool ownerOnly=false) const
 Get parent of this component.
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
 Get access to specified component interface.
 
virtual const IComponentContextGetComponentContext () const
 Get access to component context describing all application-specified component information loaded from components registry.
 
virtual void SetComponentContext (const IComponentContext *contextPtr, const ICompositeComponent *parentPtr, bool isParentOwner)
 Set component context of this component.
 
- Public Member Functions inherited from icomp::IComponent
- Public Member Functions inherited from imod::TSingleModelObserverBase< idoc::IMultiPageDocument >
 TSingleModelObserverBase ()
 
idoc::IMultiPageDocumentGetObservedObject () const
 Get instance of observed object.
 
idoc::IMultiPageDocumentGetObjectPtr () const
 Get instance of observed object.
 
bool AttachOrSetObject (idoc::IMultiPageDocument *objectPtr)
 Attach to model of object or set object pointer, if no connection is possible.
 
bool OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
 This call back function will be called, if an observable object is about to be attached.
 
bool OnModelDetached (imod::IModel *modelPtr) override
 This call back function will be called, if an observable object is about to be detached.
 
- Public Member Functions inherited from imod::CSingleModelObserverBase
 CSingleModelObserverBase ()
 
virtual ~CSingleModelObserverBase ()
 
imod::IModelGetObservedModel () const
 Get access to observed model.
 
imod::IModelGetModelPtr () const
 Get access to observed model.
 
void EnsureModelDetached ()
 Make sure this observer is detached.
 
void SetObservedIds (const istd::IChangeable::ChangeSet &changeMask)
 Set list of ID's beeing observed.
 
bool IsModelAttached (const imod::IModel *modelPtr=nullptr) const override
 Check if specified model is attached.
 
void BeforeModelChange (imod::IModel *modelPtr) override
 This function will be called before update of the observer contents occures.
 
void AfterModelChange (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
 This function will be called after update of the observer contents occures.
 
- Public Member Functions inherited from imod::IObserver
- Public Member Functions inherited from iimg::IMultiBitmapProvider
- 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< IChangeableCloneMe (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.
 

Protected Types

typedef istd::TPointerVector< iimg::IBitmapPreviewBitmaps
 

Protected Member Functions

virtual void EnsurePreviewGenerated ()
 
bool OnModelDetached (imod::IModel *modelPtr) override
 This call back function will be called, if an observable object is about to be detached.
 
void OnUpdate (const istd::IChangeable::ChangeSet &changeSet) override
 Called on update of observed model.
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active.
 
virtual void OnComponentCreated ()
 
virtual void OnComponentDestroyed ()
 
virtual const IRealComponentStaticInfoGetComponentStaticInfo () const =0
 Get access to static info of this component.
 
- Protected Member Functions inherited from imod::TSingleModelObserverBase< idoc::IMultiPageDocument >
virtual idoc::IMultiPageDocumentCastFromModel (imod::IModel *modelPtr) const
 
- Protected Member Functions inherited from imod::CSingleModelObserverBase
void SetModelPtr (imod::IModel *modelPtr)
 Set internal model pointer to specified value.
 
- 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.
 

Protected Attributes

PreviewBitmaps m_previewBitmaps
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 
- Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfoInitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 

Detailed Description

Definition at line 24 of file CRenderedDocumentPreviewGeneratorComp.h.

Member Typedef Documentation

◆ BaseClass

◆ BaseClass2

◆ PreviewBitmaps

Member Function Documentation

◆ EnsurePreviewGenerated()

virtual void idocproc::CRenderedDocumentPreviewGeneratorComp::EnsurePreviewGenerated ( )
protectedvirtual

◆ GetBitmap()

const iimg::IBitmap * idocproc::CRenderedDocumentPreviewGeneratorComp::GetBitmap ( int bitmapIndex) const
overridevirtual

Get access to produced bitmap object.

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

Implements iimg::IMultiBitmapProvider.

◆ GetBitmapListInfo()

const iprm::IOptionsList * idocproc::CRenderedDocumentPreviewGeneratorComp::GetBitmapListInfo ( ) const
overridevirtual

Get optional information about bitmaps in form of section constraints.

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

Implements iimg::IMultiBitmapProvider.

◆ GetBitmapsCount()

int idocproc::CRenderedDocumentPreviewGeneratorComp::GetBitmapsCount ( ) const
overridevirtual

Get number of produced bitmaps.

Implements iimg::IMultiBitmapProvider.

◆ OnModelDetached()

bool idocproc::CRenderedDocumentPreviewGeneratorComp::OnModelDetached ( imod::IModel * modelPtr)
overrideprotectedvirtual

This call back function will be called, if an observable object is about to be detached.

Implements imod::IObserver.

◆ OnUpdate()

void idocproc::CRenderedDocumentPreviewGeneratorComp::OnUpdate ( const istd::IChangeable::ChangeSet & changeSet)
overrideprotectedvirtual

Called on update of observed model.

This method is designed to be overload by derrived classes.

Reimplemented from imod::CSingleModelObserverBase.

Member Data Documentation

◆ m_previewBitmaps

PreviewBitmaps idocproc::CRenderedDocumentPreviewGeneratorComp::m_previewBitmaps
protected

Definition at line 64 of file CRenderedDocumentPreviewGeneratorComp.h.


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

© Witold Gantzke and Kirill Lepskiy