Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Properties | Friends | List of all members
QPlaceContactDetail Class Reference

The QPlaceContactDetail class represents a contact detail such as a phone number or website url. More...

#include <qplacecontactdetail.h>

+ Collaboration diagram for QPlaceContactDetail:

Public Member Functions

 QPlaceContactDetail ()
 Constructs a contact detail.
 
 QPlaceContactDetail (const QPlaceContactDetail &other) noexcept
 Creates a copy of other.
 
 QPlaceContactDetail (QPlaceContactDetail &&other) noexcept=default
 
 ~QPlaceContactDetail ()
 Destroys the contact detail.
 
QPlaceContactDetail & operator= (const QPlaceContactDetail &other) noexcept
 Assigns other to this contact detail and returns a reference to this contact detail.
 
void swap (QPlaceContactDetail &other) noexcept
 
QString label () const
 
void setLabel (const QString &label)
 
QString value () const
 
void setValue (const QString &value)
 
void clear ()
 Clears the contact detail.
 

Static Public Attributes

static const QString Phone
 \qmlvaluetype contactDetail \inqmlmodule QtLocation
 
static const QString Email
 \variable QPlaceContactDetail::Email The constant to specify email contact details.
 
static const QString Website
 \variable QPlaceContactDetail::Website The constant used to specify website contact details.
 
static const QString Fax
 \variable QPlaceContactDetail::Fax The constant used to specify fax contact details.
 

Properties

QML_STRUCTURED_VALUEQString label
 \qmlproperty string QtLocation::contactDetail::label
 
QString value
 \qmlproperty string QtLocation::contactDetail::value
 

Friends

bool operator== (const QPlaceContactDetail &lhs, const QPlaceContactDetail &rhs) noexcept
 Returns true if the contact detail lhs is equal to rhs, otherwise returns false.
 
bool operator!= (const QPlaceContactDetail &lhs, const QPlaceContactDetail &rhs) noexcept
 Returns true if the contact detail lhs is not equal to rhs, otherwise returns false.
 

Detailed Description

The QPlaceContactDetail class represents a contact detail such as a phone number or website url.

\inmodule QtLocation

The detail consists of a label and value. The label is a localized string that can be presented to the end user that describes that detail value which is the actual phone number, email address and so on.

Definition at line 19 of file qplacecontactdetail.h.

Constructor & Destructor Documentation

◆ QPlaceContactDetail() [1/3]

QPlaceContactDetail::QPlaceContactDetail ( )

Constructs a contact detail.

Definition at line 105 of file qplacecontactdetail.cpp.

◆ QPlaceContactDetail() [2/3]

QPlaceContactDetail::QPlaceContactDetail ( const QPlaceContactDetail & other)
defaultnoexcept

Creates a copy of other.

◆ QPlaceContactDetail() [3/3]

QPlaceContactDetail::QPlaceContactDetail ( QPlaceContactDetail && other)
defaultnoexcept

◆ ~QPlaceContactDetail()

QPlaceContactDetail::~QPlaceContactDetail ( )
default

Destroys the contact detail.

Member Function Documentation

◆ clear()

void QPlaceContactDetail::clear ( )

Clears the contact detail.

Definition at line 205 of file qplacecontactdetail.cpp.

◆ label()

QString QPlaceContactDetail::label ( ) const

Definition at line 171 of file qplacecontactdetail.cpp.

◆ operator=()

QPlaceContactDetail & QPlaceContactDetail::operator= ( const QPlaceContactDetail & other)
noexcept

Assigns other to this contact detail and returns a reference to this contact detail.

Definition at line 124 of file qplacecontactdetail.cpp.

◆ setLabel()

void QPlaceContactDetail::setLabel ( const QString & label)

Definition at line 176 of file qplacecontactdetail.cpp.

◆ setValue()

void QPlaceContactDetail::setValue ( const QString & value)

Definition at line 197 of file qplacecontactdetail.cpp.

◆ swap()

void QPlaceContactDetail::swap ( QPlaceContactDetail & other)
inlinenoexcept

Definition at line 41 of file qplacecontactdetail.h.

◆ value()

QString QPlaceContactDetail::value ( ) const

Definition at line 192 of file qplacecontactdetail.cpp.

Friends And Related Symbol Documentation

◆ operator!=

bool operator!= ( const QPlaceContactDetail & lhs,
const QPlaceContactDetail & rhs )
friend

Returns true if the contact detail lhs is not equal to rhs, otherwise returns false.

Definition at line 45 of file qplacecontactdetail.h.

◆ operator==

bool operator== ( const QPlaceContactDetail & lhs,
const QPlaceContactDetail & rhs )
friend

Returns true if the contact detail lhs is equal to rhs, otherwise returns false.

Definition at line 43 of file qplacecontactdetail.h.

Member Data Documentation

◆ Email

const QString QPlaceContactDetail::Email
static

\variable QPlaceContactDetail::Email The constant to specify email contact details.

Definition at line 29 of file qplacecontactdetail.h.

◆ Fax

const QString QPlaceContactDetail::Fax
static

\variable QPlaceContactDetail::Fax The constant used to specify fax contact details.

Definition at line 31 of file qplacecontactdetail.h.

◆ Phone

const QString QPlaceContactDetail::Phone
static

\qmlvaluetype contactDetail \inqmlmodule QtLocation

Since
QtLocation 5.5

The contactDetail type holds a contact detail such as a phone number or a website address.

The contactDetail provides a single detail on how one could contact a \l Place. The contactDetail consists of a \l {contactDetail::}{label}, which is a localized string describing the contact method, and a \l {contactDetail::}{value} representing the actual contact detail.

Definition at line 28 of file qplacecontactdetail.h.

◆ Website

const QString QPlaceContactDetail::Website
static

\variable QPlaceContactDetail::Website The constant used to specify website contact details.

Definition at line 30 of file qplacecontactdetail.h.

Property Documentation

◆ label

QML_STRUCTURED_VALUEQString QPlaceContactDetail::label
readwrite

\qmlproperty string QtLocation::contactDetail::label

This property holds a label describing the contact detail.

The label can potentially be localized. The language is dependent on the entity that sets it, typically this is the \l {Plugin}. The \l {Plugin::locales} property defines what language is used.

a label describing the contact detail.

The label can potentially be localized. The language is dependent on the entity that sets it, typically this is the manager from which the places are sourced. The QPlaceManager::locales() field defines what language is used.

Definition at line 24 of file qplacecontactdetail.h.

◆ value

QString QPlaceContactDetail::value
readwrite

\qmlproperty string QtLocation::contactDetail::value

This property holds the value of the contact detail which may be a phone number, an email address, a website url and so on.

the value of the contact detail.

Definition at line 25 of file qplacecontactdetail.h.

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