ICF 3.0.5.47
Technical documentation of ICF Libraries
idocgui::CTextEditorComp Class Reference

#include <CTextEditorComp.h>

Inheritance diagram for idocgui::CTextEditorComp:
Collaboration diagram for idocgui::CTextEditorComp:

Public Types

typedef istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QTextEdit >, imod::TSingleModelObserverBase< idoc::ITextDocument > > BaseClass
 
- Public Types inherited from istdgui::TGuiComponentBase< QTextEdit >
typedef CGuiComponentBase BaseClass
 
- Public Types inherited from istdgui::CGuiComponentBase
typedef ibase::TVisualChangesHandlerWrap< icomp::CComponentBaseBaseClass
 
- Public Types inherited from ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >
typedef icomp::CComponentBase BaseClass
 
- Public Types inherited from imod::TSingleModelObserverBase< idoc::ITextDocument >
typedef CSingleModelObserverBase BaseClass
 
typedef idoc::ITextDocument ModelType
 
- Public Types inherited from imod::CSingleModelObserverBase
typedef imod::IModel ModelType
 
- Public Types inherited from imod::IModelEditor
enum  ChangeFlags { CF_INIT_EDITOR = 0x3720694 }
 Data model change notification flags. More...
 
- Public Types inherited from ibase::ICommandsProvider
enum  ChangeFlags { CF_COMMANDS = 0x62b7e8 }
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ICF_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 , SO_CHANGE_LOCK = 1 << 5
}
 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 Member Functions

 CTextEditorComp ()
 
const ibase::IHierarchicalCommandGetCommands () const override
 Get list of menu commands.
 
- Public Member Functions inherited from istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QTextEdit >, imod::TSingleModelObserverBase< idoc::ITextDocument > >
 TGuiObserverWrap ()
 
bool OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
 
bool OnModelDetached (imod::IModel *modelPtr) override
 
- Public Member Functions inherited from istdgui::TGuiComponentBase< QTextEdit >
 TGuiComponentBase ()
 
virtual QTextEdit * GetQtWidget () const
 
- Public Member Functions inherited from istdgui::CGuiComponentBase
 I_REGISTER_SUBELEMENT_INTERFACE_T (VisualStatus, IVisualStatus, ExtractVisualStatus)
 
 I_REGISTER_SUBELEMENT_INTERFACE_T (VisualStatus, istd::IChangeable, ExtractVisualStatus)
 
 I_REGISTER_SUBELEMENT_INTERFACE_T (VisualStatus, imod::IModel, ExtractVisualStatus)
 
 CGuiComponentBase ()
 
bool IsGuiShown () const
 
bool IsGuiCreated () const override
 Inform if GUI was initilized.
 
bool CreateGui (QWidget *parentPtr) override
 Initialize GUI and connect it to the parent.
 
bool DestroyGui () override
 Release GUI and disconnect it from parent.
 
QWidget * GetWidget () const override
 Get access to internal QWidget object.
 
void OnTryClose (bool *ignoredPtr=nullptr) override
 Called on trying to close application.
 
- Public Member Functions inherited from ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >
 TVisualChangesHandlerWrap (Args &&... args)
 
virtual void EnableVisualChangesHandler (bool enableLocalization=true)
 If enabled, listen to the language change event from the application context.
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context.
 
 CComponentBase (const CComponentBase &)=delete
 
CComponentBaseoperator= (const CComponentBase &)=delete
 
virtual const ICompositeComponentGetParentComponent (bool ownerOnly=false) const
 Get parent of this component.
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
 Get access to specified component interface.
 
virtual const IComponentContextGetComponentContext () const
 Get access to component context describing all application-specified component information loaded from components registry.
 
virtual void SetComponentContext (const IComponentContext *contextPtr, const ICompositeComponent *parentPtr, bool isParentOwner)
 Set component context of this component.
 
- Public Member Functions inherited from icomp::IComponent
- Public Member Functions inherited from istdgui::IGuiObject
- Public Member Functions inherited from imod::TSingleModelObserverBase< idoc::ITextDocument >
 TSingleModelObserverBase ()
 
idoc::ITextDocumentGetObservedObject () const
 Get instance of observed object.
 
idoc::ITextDocumentGetObjectPtr () const
 Get instance of observed object.
 
bool AttachOrSetObject (idoc::ITextDocument *objectPtr)
 Attach to model of object or set object pointer, if no connection is possible.
 
bool OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
 This call back function will be called, if an observable object is about to be attached.
 
bool OnModelDetached (imod::IModel *modelPtr) override
 This call back function will be called, if an observable object is about to be detached.
 
- Public Member Functions inherited from imod::CSingleModelObserverBase
 CSingleModelObserverBase ()
 
virtual ~CSingleModelObserverBase ()
 
imod::IModelGetObservedModel () const
 Get access to observed model.
 
imod::IModelGetModelPtr () const
 Get access to observed model.
 
void EnsureModelDetached ()
 Make sure this observer is detached.
 
void SetObservedIds (const istd::IChangeable::ChangeSet &changeMask)
 Set list of ID's beeing observed.
 
bool IsModelAttached (const imod::IModel *modelPtr=nullptr) const override
 Check if specified model is attached.
 
void BeforeModelChange (imod::IModel *modelPtr) override
 This function will be called before update of the observer contents occures.
 
- Public Member Functions inherited from imod::IObserver
- Public Member Functions inherited from imod::IModelEditor
- Public Member Functions inherited from ibase::ICommandsProvider
- 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 std::unique_ptr< 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 QMutex * GetChangesLock () const
 Get mutex beeing locked during changes, if available.
 
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 Slots

void OnSelectionChanged ()
 
void OnTextChanged ()
 
void OnToLowercase ()
 
void OnToUppercase ()
 

Protected Member Functions

void UpdateModel () const override
 Do update of the model to reflect the current contents of GUI.
 
void UpdateGui (const istd::IChangeable::ChangeSet &changeSet) override
 Do update of the GUI to reflect the state of model.
 
void OnGuiCreated () override
 Called just after GUI is initialized.
 
void OnRetranslate () override
 Called when non-GUI elements (like commands) should be retranslated.
 
- Protected Member Functions inherited from istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QTextEdit >, imod::TSingleModelObserverBase< idoc::ITextDocument > >
virtual void OnGuiModelShown ()
 Called when model is attached and GUI is shown.
 
virtual void OnGuiModelHidden ()
 Called when model is detached or GUI is hidden.
 
virtual void OnGuiModelAttached ()
 Called when model is attached and GUI is created.
 
virtual void OnGuiModelDetached ()
 Called when model is detached or GUI is destroyed.
 
bool IsUpdateBlocked () const
 Check if GUI updating is blocked.
 
bool DoUpdateModel () const
 Secure update model.
 
void UpdateEditor (const istd::IChangeable::ChangeSet &changeSet) override
 Updates editor with model data.
 
void UpdateModelFromEditor () const override
 Updates model from editor.
 
void OnGuiShown () override
 
void OnGuiHidden () override
 
void OnGuiRetranslate () override
 
void OnGuiCreated () override
 
void OnGuiDestroyed () override
 
void AfterModelChange (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
 
bool IsReadOnly () const override
 Returns true if the model data can be changed.
 
void SetReadOnly (bool state) override
 Set flag that the model data can be changed.
 
void SetDisableUiIfReadOnly (bool state)
 Control if GUI should be disaled for read-only editors.
 
- Protected Member Functions inherited from istdgui::TGuiComponentBase< QTextEdit >
virtual QWidget * CreateQtWidget (QWidget *parentPtr)
 Create slave widget object.
 
- Protected Member Functions inherited from istdgui::CGuiComponentBase
virtual bool OnKeyPressed (QKeyEvent *event)
 Called from widget event filter when key is pressed.
 
void SetStatusIcon (const QIcon &icon)
 Set status icon;.
 
void SetStatusText (const QString &text)
 Set status text;.
 
void OnLanguageChanged () override
 
void OnDesignSchemaChanged () override
 
bool eventFilter (QObject *sourcePtr, QEvent *eventPtr) override
 
void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
- Protected Member Functions inherited from ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active.
 
virtual const IRealComponentStaticInfoGetComponentStaticInfo () const =0
 Get access to static info of this component.
 
- Protected Member Functions inherited from imod::TSingleModelObserverBase< idoc::ITextDocument >
virtual idoc::ITextDocumentCastFromModel (imod::IModel *modelPtr) const
 
- Protected Member Functions inherited from imod::CSingleModelObserverBase
void SetModelPtr (imod::IModel *modelPtr)
 Set internal model pointer to specified value.
 
virtual void OnUpdate (const istd::IChangeable::ChangeSet &changeSet)
 Called on update of observed model.
 
- 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 istdgui::CGuiComponentBase
static void MakeAutoSlotConnection (const QWidget &widget, QObject &object)
 
- 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 IRealComponentStaticInfoInitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 
- Protected Attributes inherited from istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QTextEdit >, imod::TSingleModelObserverBase< idoc::ITextDocument > >
bool m_isReadOnly
 
- Protected Attributes inherited from istdgui::CGuiComponentBase
istd::CMainThreadCaller m_updateGuiCaller
 
imod::TModelWrap< VisualStatusm_visualStatus
 

Detailed Description

Definition at line 26 of file CTextEditorComp.h.

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CTextEditorComp()

idocgui::CTextEditorComp::CTextEditorComp ( )

Member Function Documentation

◆ GetCommands()

const ibase::IHierarchicalCommand * idocgui::CTextEditorComp::GetCommands ( ) const
overridevirtual

Get list of menu commands.

These commands will be integrated in global menu system, independent from actual selected view. For support of normal pull down menu, depth of this tree structure should be at least 3.

Reimplemented from ibase::ICommandsProvider.

◆ OnGuiCreated()

void idocgui::CTextEditorComp::OnGuiCreated ( )
overrideprotectedvirtual

Called just after GUI is initialized.

Reimplemented from istdgui::CGuiComponentBase.

◆ OnRetranslate()

void idocgui::CTextEditorComp::OnRetranslate ( )
overrideprotectedvirtual

Called when non-GUI elements (like commands) should be retranslated.

Reimplemented from istdgui::CGuiComponentBase.

◆ OnSelectionChanged

void idocgui::CTextEditorComp::OnSelectionChanged ( )
protectedslot

◆ OnTextChanged

void idocgui::CTextEditorComp::OnTextChanged ( )
protectedslot

◆ OnToLowercase

void idocgui::CTextEditorComp::OnToLowercase ( )
protectedslot

◆ OnToUppercase

void idocgui::CTextEditorComp::OnToUppercase ( )
protectedslot

◆ UpdateGui()

void idocgui::CTextEditorComp::UpdateGui ( const istd::IChangeable::ChangeSet & changeSet)
overrideprotectedvirtual

Do update of the GUI to reflect the state of model.

This method should be implemented by derived classes instead of imod::IModelEditor::UpdateEditor().

Reimplemented from istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QTextEdit >, imod::TSingleModelObserverBase< idoc::ITextDocument > >.

◆ UpdateModel()

void idocgui::CTextEditorComp::UpdateModel ( ) const
overrideprotectedvirtual

Do update of the model to reflect the current contents of GUI.

This method should be implmented by derived classes instead of imod::IModelEditor::UpdateModelFromEditor().

Reimplemented from istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QTextEdit >, imod::TSingleModelObserverBase< idoc::ITextDocument > >.


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

© Witold Gantzke and Kirill Lepskiy