idoc::IMultiPageDocumentProvider Class Reference

Common interface for a provider of a multi-page document. More...

#include <IMultiPageDocumentProvider.h>

Inheritance diagram for idoc::IMultiPageDocumentProvider:

Public Member Functions
virtual const IMultiPageDocument *	GetDocument () const =0
	Get multi-page document instance.
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 istd::TUniqueInterfacePtr< istd::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 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.
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...
typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap
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

Common interface for a provider of a multi-page document.

This interface provides access to a multi-page document instance. It's typically implemented by components that manage or contain multi-page documents.

The provider pattern allows separation between document ownership and document access, enabling flexible architectures where documents can be managed by different components.

Usage Example

// Get provider from a component
idoc::IMultiPageDocumentProvider* provider = GetDocumentProvider();
 
// Access the document
const idoc::IMultiPageDocument* doc = provider->GetDocument();
if (doc) {
       qDebug() << "Document has" << doc->GetPagesCount() << "pages";
       
       // Work with the document
       for (int i = 0; i < doc->GetPagesCount(); ++i) {
              const istd::IChangeable& page = doc->GetDocumentPage(i);
              // Process page...
       }
}

See also

IMultiPageDocument

Definition at line 46 of file IMultiPageDocumentProvider.h.

Member Function Documentation

GetDocument()

virtual const IMultiPageDocument * idoc::IMultiPageDocumentProvider::GetDocument ( ) const

pure virtual

Get multi-page document instance.

Returns

Pointer to the multi-page document, or NULL if no document is available.

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

---

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

• Acf/Include/idoc/IMultiPageDocumentProvider.h