idoc::ITextDocument Class Reference

Simple interface for a text document. More...

#include <ITextDocument.h>

Inheritance diagram for idoc::ITextDocument:

Public Member Functions
virtual QString	GetText () const =0
	Get document text.
virtual void	SetText (const QString &text)=0
	Set document text.
Public Member Functions inherited from iser::ISerializable
virtual bool	Serialize (IArchive &archive)=0
	Load or store state of this object as a archive stream.
virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.
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

Simple interface for a text document.

Provides a minimal interface for documents that store plain text content. This is one of the simplest document types in the ACF framework and serves as a good starting point for understanding the document/view architecture.

The document inherits from ISerializable, allowing it to be saved and loaded through the ACF serialization framework.

Usage Example

// Create or get a text document
idoc::ITextDocument* textDoc = GetTextDocument();
 
// Set document content
textDoc->SetText("Hello World!\nThis is a text document.");
 
// Get document content
QString content = textDoc->GetText();
qDebug() << "Document has" << content.length() << "characters";
 
// Save document using serialization
iser::CXmlArchive archive;
if (archive.OpenForWrite("/path/to/document.xml")) {
       textDoc->Serialize(archive);
       archive.Close();
}
 
// Load document using serialization
if (archive.OpenForRead("/path/to/document.xml")) {
       textDoc->Serialize(archive);
       archive.Close();
}

See also

CTextDocumentComp, CTextFileLoaderComp

Definition at line 55 of file ITextDocument.h.

Member Function Documentation

GetText()

virtual QString idoc::ITextDocument::GetText ( ) const

pure virtual

Get document text.

Returns

The complete text content of the document.

Implemented in idoc::CTextDocumentComp.

SetText()

virtual void idoc::ITextDocument::SetText ( const QString &  text )

pure virtual

Set document text.

Parameters

text	The new text content for the document.

This replaces all existing content with the new text.

Implemented in idoc::CTextDocumentComp.

---

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

• Acf/Include/idoc/ITextDocument.h