Public Member Functions | List of all members
idoc::IMultiPageDocument Class Referenceabstract

Simple interface for a structured document. More...

#include <IMultiPageDocument.h>

Inheritance diagram for idoc::IMultiPageDocument:
istd::IChangeable istd::IPolymorphic idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument > iimg::CMultiPageBitmapBase iimg::CMultiPageBitmapSequenceComp iimg::CMultiPageBitmapComp iimg::TMultiPageBitmap< BitmapImpl >

Public Member Functions

virtual int GetPagesCount () const =0
 Get number of pages in the document. More...
 
virtual const istd::IChangeableGetDocumentPage (int pageIndex) const =0
 Get the document page. More...
 
virtual const
idoc::IDocumentMetaInfo
GetPageMetaInfo (int pageIndex) const =0
 Get meta info of the given page if exists. More...
 
virtual void ResetPages ()=0
 Remove all pages and their content from the document. More...
 
virtual istd::IChangeableInsertPage (const idoc::IDocumentMetaInfo *pageMetaInfoPtr=NULL, const iprm::IParamsSet *pageParameterPtr=NULL, int position=-1)=0
 Insert a new document page at the given position. More...
 
virtual bool RemovePage (int pageIndex)=0
 Remove the page at the given index. More...
 
virtual const IDocumentMetaInfoGetDocumentMetaInfo () const =0
 Get meta information about the document. More...
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. 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 ()
 

Additional Inherited Members

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

Detailed Description

Simple interface for a structured document.

Document is container of the pages. A page is the owner of the content.

Definition at line 30 of file IMultiPageDocument.h.

Member Function Documentation

virtual const IDocumentMetaInfo& idoc::IMultiPageDocument::GetDocumentMetaInfo ( ) const
pure virtual

Get meta information about the document.

Implemented in idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >.

virtual const istd::IChangeable& idoc::IMultiPageDocument::GetDocumentPage ( int  pageIndex) const
pure virtual
virtual const idoc::IDocumentMetaInfo* idoc::IMultiPageDocument::GetPageMetaInfo ( int  pageIndex) const
pure virtual

Get meta info of the given page if exists.

Implemented in idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >.

Referenced by idoc::TMultiPageDocumentWrap< Base >::CopyFrom().

virtual int idoc::IMultiPageDocument::GetPagesCount ( ) const
pure virtual

Get number of pages in the document.

Implemented in idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >.

Referenced by idoc::TMultiPageDocumentWrap< Base >::CopyFrom().

virtual istd::IChangeable* idoc::IMultiPageDocument::InsertPage ( const idoc::IDocumentMetaInfo pageMetaInfoPtr = NULL,
const iprm::IParamsSet pageParameterPtr = NULL,
int  position = -1 
)
pure 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.

Implemented in iimg::CMultiPageBitmapSequenceComp, and iimg::CMultiPageBitmapBase.

virtual bool idoc::IMultiPageDocument::RemovePage ( int  pageIndex)
pure virtual

Remove the page at the given index.

Implemented in idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >.

virtual void idoc::IMultiPageDocument::ResetPages ( )
pure virtual

Remove all pages and their content from the document.

Implemented in idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy