QContactActionTarget Class

The QContactActionTarget class provides information about the target of an action. It may be either a contact, a contact and a detail of that contact, or a contact and a list of the details of the contact, which together should be used by the action. More...

Header: #include <QContactActionTarget>

Public Types

enum Type { Invalid, WholeContact, SingleDetail, MultipleDetails }

Public Functions

QContactActionTarget(const QContact & contact = QContact(), const QList<QContactDetail> & details = QList<QContactDetail> ())
QContactActionTarget(const QContact & contact, const QContactDetail & detail)
QContactActionTarget(const QContactActionTarget & other)
~QContactActionTarget()
QContact contact() const
QList<QContactDetail> details() const
bool isValid() const
void setContact(const QContact & contact)
void setDetails(const QList<QContactDetail> & details)
Type type() const
bool operator!=(const QContactActionTarget & other) const
QContactActionTarget & operator=(const QContactActionTarget & other)
bool operator==(const QContactActionTarget & other) const

Detailed Description

The QContactActionTarget class provides information about the target of an action. It may be either a contact, a contact and a detail of that contact, or a contact and a list of the details of the contact, which together should be used by the action.

Member Type Documentation

enum QContactActionTarget::Type

This enumerator defines the type of a QContactActionTarget.

ConstantValueDescription
QContactActionTarget::Invalid0The type is invalid.
QContactActionTarget::WholeContact1The type is a complete contact.
QContactActionTarget::SingleDetail2The type is only a single detail.
QContactActionTarget::MultipleDetails3The type contains multiple details.

Member Function Documentation

QContactActionTarget::QContactActionTarget(const QContact & contact = QContact(), const QList<QContactDetail> & details = QList<QContactDetail> ())

Constructs a new action target from the given contact and the given list of that contact's details. If no contact is specified, the target will be invalid. If a contact but no details are specified, the target will be valid, but the action which operates on the target may fail (for example, if it requires a certain detail to be specified in order to perform the action).

QContactActionTarget::QContactActionTarget(const QContact & contact, const QContactDetail & detail)

Constructs a new action target from the given contact and a specific detail of that contact

QContactActionTarget::QContactActionTarget(const QContactActionTarget & other)

Constructs a copy of the other action target

QContactActionTarget::~QContactActionTarget()

Cleans up any memory in use by the action target

QContact QContactActionTarget::contact() const

Returns the contact that this action target will operate on.

See also setContact() and details().

QList<QContactDetail> QContactActionTarget::details() const

Returns the details that this action target will operate on.

See also setDetails() and contact().

bool QContactActionTarget::isValid() const

Returns true if the target contact is not the default constructed contact. The validity of any specified details is not checked by this function.

void QContactActionTarget::setContact(const QContact & contact)

Sets the contact that this action target will operate on to contact.

See also contact() and setDetails().

void QContactActionTarget::setDetails(const QList<QContactDetail> & details)

Sets the details that this action target will operate on to details.

See also details() and setContact().

Type QContactActionTarget::type() const

Returns the type of this action target.

The type is determined by the properties that have been set on this target.

bool QContactActionTarget::operator!=(const QContactActionTarget & other) const

Returns true if the contacts or details specified by this action target are different to that specified by other

QContactActionTarget & QContactActionTarget::operator=(const QContactActionTarget & other)

Assigns this action target to be equal to other

bool QContactActionTarget::operator==(const QContactActionTarget & other) const

Returns true if the contacts and details specified by this action target are equal to those specified by other