krita

KisAnnotation Class Reference

#include <kis_annotation.h>

Inherits KShared.

List of all members.


Detailed Description

An data extension mechanism for Krita.

An annotation can be of something like a QByteArray or a QString 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 krita 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.


Public Member Functions

 KisAnnotation (const QString &type, const QString &description, const QByteArray &data)
QString & type ()
QString & description ()
QByteArray & annotation ()

Constructor & Destructor Documentation

KisAnnotation::KisAnnotation ( const QString &  type,
const QString &  description,
const QByteArray &  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

QString& KisAnnotation::type (  )  [inline]

Returns:
a non-localized string identifiying the type of the annotation

Definition at line 63 of file kis_annotation.h.

QString& 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.

QByteArray& KisAnnotation::annotation (  )  [inline]

Returns:
a binary blob representation of this annotation

Definition at line 74 of file kis_annotation.h.


The documentation for this class was generated from the following file:
KDE Home | KDE Accessibility Home | Description of Access Keys