Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
idoc::TMultiPageDocumentWrap< Base > Class Template Reference

Generic implementation of IMultiPageDocument interface. More...

#include <TMultiPageDocumentWrap.h>

Inheritance diagram for idoc::TMultiPageDocumentWrap< Base >:
idoc::CStandardDocumentMetaInfo iprm::IOptionsList idoc::IDocumentMetaInfo iser::ISerializable istd::IChangeable istd::IChangeable istd::IChangeable istd::IPolymorphic istd::IPolymorphic istd::IPolymorphic

Classes

struct  Page
 

Public Types

typedef Base BaseClass
 
typedef CStandardDocumentMetaInfo BaseClass2
 
- 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 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 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 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...
 
virtual bool CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool ResetData (CompatibilityMode mode)
 Reset data to its default state. More...
 
- 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 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 iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data. More...
 

Protected Types

typedef QList< PagePages
 

Protected Member Functions

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

Protected Attributes

Pages m_documentPages
 

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

Detailed Description

template<class Base>
class idoc::TMultiPageDocumentWrap< Base >

Generic implementation of IMultiPageDocument interface.

Definition at line 27 of file TMultiPageDocumentWrap.h.

Member Typedef Documentation

template<class Base>
typedef Base idoc::TMultiPageDocumentWrap< Base >::BaseClass

Definition at line 33 of file TMultiPageDocumentWrap.h.

template<class Base>
typedef CStandardDocumentMetaInfo idoc::TMultiPageDocumentWrap< Base >::BaseClass2

Definition at line 34 of file TMultiPageDocumentWrap.h.

template<class Base>
typedef QList<Page> idoc::TMultiPageDocumentWrap< Base >::Pages
protected

Definition at line 73 of file TMultiPageDocumentWrap.h.

Member Function Documentation

template<class Base >
bool idoc::TMultiPageDocumentWrap< Base >::CopyFrom ( const istd::IChangeable object,
CompatibilityMode  mode = CM_WITHOUT_REFS 
)
virtual
template<class Base >
const IDocumentMetaInfo & idoc::TMultiPageDocumentWrap< Base >::GetDocumentMetaInfo ( ) const
virtual

Definition at line 135 of file TMultiPageDocumentWrap.h.

template<class Base >
const istd::IChangeable & idoc::TMultiPageDocumentWrap< Base >::GetDocumentPage ( int  pageIndex) const
virtual

Definition at line 91 of file TMultiPageDocumentWrap.h.

template<class Base >
QString idoc::TMultiPageDocumentWrap< Base >::GetOptionDescription ( int  index) const
virtual

Get human readable description for a option with the index index.

Implements iprm::IOptionsList.

Definition at line 168 of file TMultiPageDocumentWrap.h.

template<class Base >
QByteArray idoc::TMultiPageDocumentWrap< Base >::GetOptionId ( int  index) const
virtual

Get option ID.

The option ID must be unique, if flag SCF_SUPPORT_UNIQUE_ID is set.

See Also
OptionsFlags

Implements iprm::IOptionsList.

Definition at line 175 of file TMultiPageDocumentWrap.h.

template<class Base >
QString idoc::TMultiPageDocumentWrap< Base >::GetOptionName ( int  index) const
virtual

Get name of specified option.

Implements iprm::IOptionsList.

Definition at line 158 of file TMultiPageDocumentWrap.h.

References idoc::IDocumentMetaInfo::MIT_TITLE.

template<class Base >
int idoc::TMultiPageDocumentWrap< Base >::GetOptionsCount ( ) const
virtual

Get number of managed options.

Implements iprm::IOptionsList.

Definition at line 151 of file TMultiPageDocumentWrap.h.

template<class Base >
int idoc::TMultiPageDocumentWrap< Base >::GetOptionsFlags ( ) const
virtual

Get constraints flags.

The flags describes how the constraints object mantainance

Implements iprm::IOptionsList.

Definition at line 144 of file TMultiPageDocumentWrap.h.

template<class Base >
const idoc::IDocumentMetaInfo * idoc::TMultiPageDocumentWrap< Base >::GetPageMetaInfo ( int  pageIndex) const
virtual

Definition at line 102 of file TMultiPageDocumentWrap.h.

template<class Base >
int idoc::TMultiPageDocumentWrap< Base >::GetPagesCount ( ) const
virtual

Definition at line 84 of file TMultiPageDocumentWrap.h.

template<class Base >
bool idoc::TMultiPageDocumentWrap< Base >::IsOptionEnabled ( int  index) const
virtual

Return true if the option is enabled and can be selected.

Implements iprm::IOptionsList.

Definition at line 182 of file TMultiPageDocumentWrap.h.

template<class Base >
bool idoc::TMultiPageDocumentWrap< Base >::RemovePage ( int  pageIndex)
virtual

Definition at line 121 of file TMultiPageDocumentWrap.h.

template<class Base >
bool idoc::TMultiPageDocumentWrap< Base >::ResetData ( CompatibilityMode  mode)
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 istd::IChangeable.

Reimplemented in iimg::CMultiPageBitmapBase.

Definition at line 320 of file TMultiPageDocumentWrap.h.

template<class Base >
void idoc::TMultiPageDocumentWrap< Base >::ResetPages ( )
virtual

Definition at line 112 of file TMultiPageDocumentWrap.h.

template<class Base >
bool idoc::TMultiPageDocumentWrap< Base >::Serialize ( iser::IArchive archive)
virtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See Also
iser::IArchive

Reimplemented from idoc::CStandardDocumentMetaInfo.

Definition at line 191 of file TMultiPageDocumentWrap.h.

References iser::IArchive::BeginMultiTag(), iser::IArchive::BeginTag(), iser::IArchive::EndTag(), iser::IArchive::IsStoring(), NULL, iser::CArchiveTag::TT_GROUP, and iser::CArchiveTag::TT_MULTIPLE.

template<class Base >
bool idoc::TMultiPageDocumentWrap< Base >::SerializePage ( iser::IArchive archive,
Page pageItem 
)
protectedvirtual

Member Data Documentation

template<class Base>
Pages idoc::TMultiPageDocumentWrap< Base >::m_documentPages
protected

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

© 2007-2017 Witold Gantzke and Kirill Lepskiy