Home

Location Class Reference
(QMailMessagePartContainer::Location)

The Location class contains a specification of the location of a message part with the message that contains it. More...

    #include <QMailMessagePartContainer>

This class is under development and is subject to change.

• List of all members, including inherited members

Public Functions

Detailed Description

The Location class contains a specification of the location of a message part with the message that contains it.

A Location object is used to refer to a single part within a multi-part message. The location can be used to reference a part within a QMailMessage object, via the partAt function.

Member Function Documentation

Location::Location ()

Creates an empty part location object.

Location::Location ( const QString & description )

Creates a part location object referring to the location given by description.

See also toString().

Location::Location ( const Location & other )

Creates a part location object containing a copy of other.

QMailMessageId Location::containingMessageId () const

Returns the identifier of the message that contains the part with this location.

See also setContainingMessageId().

bool Location::isValid ( bool extended = true ) const

Returns true if the location object contains the location of a valid message part. If extended is true, the location must also contain a valid message identifier.

void Location::setContainingMessageId ( const QMailMessageId & id )

Sets the identifier of the message that contains the part with this location to id.

See also containingMessageId().

QString Location::toString ( bool extended ) const

Returns a textual representation of the part location. If extended is true, the representation contains the identifier of the containing message.

bool Location::operator== ( const QMailMessagePartContainer::Location & other ) const

Returns true if other is referring to the same location