ACF $AcfVersion:0$
Public Types | Public Member Functions | Protected Member Functions | List of all members
idoc::CTextDocumentComp Class Reference

Simple implementation of a text document model. More...

#include <CTextDocumentComp.h>

Inheritance diagram for idoc::CTextDocumentComp:
icomp::CComponentBase idoc::ITextDocument icomp::IComponent iser::ISerializable istd::IPolymorphic istd::IChangeable istd::IPolymorphic

Public Types

typedef icomp::CComponentBase BaseClass
 
- 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
 

Public Member Functions

virtual QString GetText () const override
 Get document text.
 
virtual void SetText (const QString &text) override
 Set document text.
 
virtual bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context.
 
virtual const icomp::IComponentGetParentComponent (bool ownerOnly=false) const override
 Get parent of this component.
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="") override
 Get access to specified component interface.
 
virtual IComponentContextSharedPtr GetComponentContext () const override
 Get access to component context describing all application-specified component information loaded from components registry.
 
virtual void SetComponentContext (const IComponentContextSharedPtr &contextPtr, const icomp::IComponent *parentPtr, bool isParentOwner) override
 Set component context of this component.
 
- 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.
 
- 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::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 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 Member Functions

virtual void OnComponentCreated () override
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active.
 
virtual void OnComponentDestroyed ()
 
virtual const icomp::IRealComponentStaticInfoGetComponentStaticInfo () const =0
 Get access to static info of this component.
 
- 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.
 

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 icomp::IRealComponentStaticInfoInitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const icomp::IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 

Detailed Description

Simple implementation of a text document model.

This component provides a complete implementation of the ITextDocument interface, storing plain text content. It supports serialization and can be used as the document model in text editing applications.

Component Attributes
  • DefaultText - Initial text content when document is created (default: "Hallo World!")
Registered Interfaces
Configuration Example
DefaultText = "Type your text here..."
}
Simple implementation of a text document model.
Usage with Document Template
DocumentTypeId = "TextDocument"
DocumentFactory = CTextDocumentComp {
DefaultText = "New Document"
}
ViewFactory = TextEditorView
DocumentLoader = CTextFileLoaderComp
}
Document template component supporting only one type of the provided document.
Persistence component for files containing plain text.
See also
ITextDocument, CTextFileLoaderComp

Definition at line 53 of file CTextDocumentComp.h.

Member Typedef Documentation

◆ BaseClass

Definition at line 56 of file CTextDocumentComp.h.

Member Function Documentation

◆ GetText()

virtual QString idoc::CTextDocumentComp::GetText ( ) const
overridevirtual

Get document text.

Returns
The complete text content of the document.

Implements idoc::ITextDocument.

◆ OnComponentCreated()

virtual void idoc::CTextDocumentComp::OnComponentCreated ( )
overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ Serialize()

virtual bool idoc::CTextDocumentComp::Serialize ( iser::IArchive archive)
overridevirtual

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

Type of operation is depending on archive type.

See also
iser::IArchive

Implements iser::ISerializable.

◆ SetText()

virtual void idoc::CTextDocumentComp::SetText ( const QString &  text)
overridevirtual

Set document text.

Parameters
textThe new text content for the document.

This replaces all existing content with the new text.

Implements idoc::ITextDocument.


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