KisAnnotation Class Reference

#include <kis_annotation.h>

Inherits TDEShared.

Public Member Functions
	KisAnnotation (const TQString &type, const TQString &description, const TQByteArray &data)
TQString &	type ()
TQString &	description ()
TQByteArray &	annotation ()

Detailed Description

An data extension mechanism for Chalk.

An annotation can be of something like a TQByteArray or a TQString op a more specific datatype that can be attached to an image (or maybe later, if needed, to a layer) and contains data that must be associated with an image for purposes of import/export.

Annotations will be saved to chalk images and may be exported in filetypes that support them.

Examples of annotations are EXIF data and ICC profiles.

Definition at line 43 of file kis_annotation.h.

Constructor & Destructor Documentation

KisAnnotation()

KisAnnotation::KisAnnotation ( const TQString &  type, const TQString &  description, const TQByteArray &  data  )

inline

Creates a new annotation object.

The annotation object cannot be changed later

Parameters

type	a non-localized string identifying the type of the annotation
description	a localized string describing the annotation
data	a binary blob containing the annotation data

Definition at line 55 of file kis_annotation.h.

Member Function Documentation

annotation()

TQByteArray & KisAnnotation::annotation ( )

inline

Returns

a binary blob representation of this annotation

Definition at line 74 of file kis_annotation.h.

description()

TQString & KisAnnotation::description ( )

inline

Returns

a localized string describing the type of the annotations for user interface purposes.

Definition at line 69 of file kis_annotation.h.

type()

TQString & KisAnnotation::type ( )

inline

Returns

a non-localized string identifiying the type of the annotation

Definition at line 63 of file kis_annotation.h.

---

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

• kis_annotation.h