Public Types | Public Member Functions | List of all members
icmpstr::IComponentNoteController Class Referenceabstract

Interface for management of notes in the component registry. More...

#include <IComponentNoteController.h>

Inheritance diagram for icmpstr::IComponentNoteController:
istd::IChangeable istd::IPolymorphic icmpstr::CVisualRegistry

Public Types

enum  ChangeFlags { CF_NOTE_CHANGED = 0xb6f0c34 }
 Data model change notification flags. More...
 

Public Member Functions

virtual QString GetComponentNote (const QByteArray &componentName)=0
 Get the note text to the component with the given name componentName. More...
 
virtual void SetComponentNote (const QByteArray &componentName, const QString &componentNote)=0
 Add a note componentNote to the component with the given name componentName. More...
 

Detailed Description

Interface for management of notes in the component registry.

A note is a user defined description of the component in the diagram context. Using of notes make it easier for non-authors to understand, what is the meaning of the given component in the concrete context.

Definition at line 19 of file IComponentNoteController.h.

Member Enumeration Documentation

Data model change notification flags.

Enumerator
CF_NOTE_CHANGED 

Definition at line 25 of file IComponentNoteController.h.

Member Function Documentation

virtual QString icmpstr::IComponentNoteController::GetComponentNote ( const QByteArray &  componentName)
pure virtual

Get the note text to the component with the given name componentName.

Implemented in icmpstr::CVisualRegistry.

virtual void icmpstr::IComponentNoteController::SetComponentNote ( const QByteArray &  componentName,
const QString &  componentNote 
)
pure virtual

Add a note componentNote to the component with the given name componentName.

Implemented in icmpstr::CVisualRegistry.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy