Class Annotation.

Inherits Garbage

The Annotation class models a single annotation for a message, ie. it has an entr name, a value, an owner and associated data. The Annotation object doesn't register itself or maintain pointers to other objects - it's a simple value. Message::replaceAnnotation() and Message::annotations() are the main functions using Annotation.

Annotation::Annotation( const String & name, const String & value, uint owner )

Constructs a new Annotation with the given name, value, and owner.

Annotation::Annotation()

Constructs an empty Annotation.

Reimplements Garbage::Garbage().

String Annotation::entryName() const

Returns the annotation's entry name, as set by setEntryName().

uint Annotation::ownerId() const

Returns the annotation's owner ID, as set by setOwnerId().

void Annotation::setEntryName( const String & name )

Records that the entry name of this annotation is name. Annotation does not enforce validity.

void Annotation::setOwnerId( uint id )

Records that the user id owning this annotation is id. The initial value is 0, corresponding to a shared annotation.

void Annotation::setValue( const String & v )

Records that the value of this annotation is v. The initial value is an empty string.

String Annotation::value() const

Returns the annotation's value, as set by setValue().

This web page based on source code belonging to Oryx Mail Systems GmbH. All rights reserved.