MAKLogger::DtLgrAnnotationDefinition Class Reference

An Annotation definition allows annotation types to be defined which is necessary for generic instantiation. More...

Collaboration diagram for MAKLogger::DtLgrAnnotationDefinition:

Public Types
typedef DtLgrAnnotation *(*	AnnotationCreator )(QWidget *, DtLgrGuiModel *)
	Annotation Creator function.
typedef void(*	AnnotationModifier )(QWidget *, DtLgrAnnotation *, DtLgrGuiModel *)
	Annotation modifier function.
typedef DtLgrAnnotation *(*	AnnotationLoader )(const DtEnvObject *object)
	Annotation loader function.
typedef DtLgrAnnotationSliderBar *(*	AnnotationBarCreator )(DtLgrAnnotation *annotation)
	Create a sliderBar for the annotation.
typedef DtLgrAnnotation *(*	AnnotationConvertor )(const DtLgrAnnotation *annotation)
	Convert an annotation.

Public Member Functions
	DtLgrAnnotationDefinition ()
	DtLgrAnnotationDefinition (QString guiTypeName, QString accelerator, QString icon, DtString type, AnnotationCreator creator, AnnotationModifier modifier, AnnotationLoader loader, AnnotationBarCreator barCreator)
	DtLgrAnnotationDefinition (const DtLgrAnnotationDefinition &copy)
	Copy CTOR.
DtLgrAnnotationDefinition &	operator= (const DtLgrAnnotationDefinition &copy)
	Assignment operator.
	~DtLgrAnnotationDefinition ()

Public Attributes
QString	myGuiTypeName
	The type name to be used in the GUI.
QString	myGuiAccelerator
	The accelerator which will bring up the creation dialog.
QString	myGuiIcon
	The string which indicates the name of the icon to use.
DtString	myType
	The unique string identifier for the type.
AnnotationCreator	myCreator
	The create function for the type.
AnnotationModifier	myModifier
	The create modifier for the type.
AnnotationLoader	myLoader
	The loader function for the type.
AnnotationBarCreator	myBarCreator
	The drawing function for the type.

Detailed Description

An Annotation definition allows annotation types to be defined which is necessary for generic instantiation.

Member Typedef Documentation

typedef DtLgrAnnotationSliderBar*(* MAKLogger::DtLgrAnnotationDefinition::AnnotationBarCreator)(DtLgrAnnotation *annotation)

Create a sliderBar for the annotation.

typedef DtLgrAnnotation*(* MAKLogger::DtLgrAnnotationDefinition::AnnotationConvertor)(const DtLgrAnnotation *annotation)

Convert an annotation.

typedef DtLgrAnnotation*(* MAKLogger::DtLgrAnnotationDefinition::AnnotationCreator)(QWidget *, DtLgrGuiModel *)

Annotation Creator function.

This must return 0 if no annotation was create i.e. creation was canceled.

typedef DtLgrAnnotation*(* MAKLogger::DtLgrAnnotationDefinition::AnnotationLoader)(const DtEnvObject *object)

Annotation loader function.

Which loads the annotation from a envObject.

typedef void(* MAKLogger::DtLgrAnnotationDefinition::AnnotationModifier)(QWidget *, DtLgrAnnotation *, DtLgrGuiModel *)

Annotation modifier function.

Constructor & Destructor Documentation

MAKLogger::DtLgrAnnotationDefinition::DtLgrAnnotationDefinition

(

)

MAKLogger::DtLgrAnnotationDefinition::DtLgrAnnotationDefinition	(	QString	guiTypeName,
		QString	accelerator,
		QString	icon,
		DtString	type,
		AnnotationCreator	creator,
		AnnotationModifier	modifier,
		AnnotationLoader	loader,
		AnnotationBarCreator	barCreator
	)

MAKLogger::DtLgrAnnotationDefinition::DtLgrAnnotationDefinition

(

const DtLgrAnnotationDefinition &

copy

)

Copy CTOR.

MAKLogger::DtLgrAnnotationDefinition::~DtLgrAnnotationDefinition

(

)

Member Function Documentation

DtLgrAnnotationDefinition& MAKLogger::DtLgrAnnotationDefinition::operator=

(

const DtLgrAnnotationDefinition &

copy

)

Assignment operator.

Member Data Documentation

AnnotationBarCreator MAKLogger::DtLgrAnnotationDefinition::myBarCreator

The drawing function for the type.

AnnotationCreator MAKLogger::DtLgrAnnotationDefinition::myCreator

The create function for the type.

QString MAKLogger::DtLgrAnnotationDefinition::myGuiAccelerator

The accelerator which will bring up the creation dialog.

QString MAKLogger::DtLgrAnnotationDefinition::myGuiIcon

The string which indicates the name of the icon to use.

QString MAKLogger::DtLgrAnnotationDefinition::myGuiTypeName

The type name to be used in the GUI.

This should be a translated string.

AnnotationLoader MAKLogger::DtLgrAnnotationDefinition::myLoader

The loader function for the type.

AnnotationModifier MAKLogger::DtLgrAnnotationDefinition::myModifier

The create modifier for the type.

DtString MAKLogger::DtLgrAnnotationDefinition::myType

The unique string identifier for the type.

---

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

• lgrAnnotationFactory.h