KGAPI2::People::Name

Search for usage in LXR

Public Member Functions | Static Public Member Functions | List of all members
KGAPI2::People::Name Class Reference

#include <name.h>

Public Member Functions

 Name ()
 
 Name (const Name &)
 
 Name (Name &&) noexcept
 
 ~Name ()
 
void applyToKContactsAddressee (KContacts::Addressee &addressee) const
 
QString displayName () const
 
QString displayNameLastFirst () const
 
QString familyName () const
 
QString givenName () const
 
QString honorificPrefix () const
 
QString honorificSuffix () const
 
FieldMetadata metadata () const
 
QString middleName () const
 
bool operator!= (const Name &) const
 
Name & operator= (const Name &)
 
Name & operator= (Name &&) noexcept
 
bool operator== (const Name &) const
 
QString phoneticFamilyName () const
 
QString phoneticFullName () const
 
QString phoneticGivenName () const
 
QString phoneticHonorificPrefix () const
 
QString phoneticHonorificSuffix () const
 
QString phoneticMiddleName () const
 
void setFamilyName (const QString &value)
 
void setGivenName (const QString &value)
 
void setHonorificPrefix (const QString &value)
 
void setHonorificSuffix (const QString &value)
 
void setMetadata (const FieldMetadata &value)
 
void setMiddleName (const QString &value)
 
void setPhoneticFamilyName (const QString &value)
 
void setPhoneticFullName (const QString &value)
 
void setPhoneticGivenName (const QString &value)
 
void setPhoneticHonorificPrefix (const QString &value)
 
void setPhoneticHonorificSuffix (const QString &value)
 
void setPhoneticMiddleName (const QString &value)
 
void setUnstructuredName (const QString &value)
 
QJsonValue toJSON () const
 
QString unstructuredName () const
 

Static Public Member Functions

static Name fromJSON (const QJsonObject &)
 
static QList< Name > fromJSONArray (const QJsonArray &data)
 
static Name fromKContactsAddressee (const KContacts::Addressee &addressee)
 

Detailed Description

A person's name.

If the name is a mononym, the family name is empty.

See also
https://developers.google.com/people/api/rest/v1/people#name
Since
5.23.0

Definition at line 37 of file name.h.

Constructor & Destructor Documentation

◆ Name()

KGAPI2::People::Name::Name ( )
explicit

Constructs a new Name.

Definition at line 67 of file name.cpp.

◆ ~Name()

KGAPI2::People::Name::~Name ( )
default

Destructor.

Member Function Documentation

◆ applyToKContactsAddressee()

void KGAPI2::People::Name::applyToKContactsAddressee ( KContacts::Addressee & addressee) const

Definition at line 287 of file name.cpp.

◆ displayName()

QString KGAPI2::People::Name::displayName ( ) const

Output only.

The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.

Definition at line 160 of file name.cpp.

◆ displayNameLastFirst()

QString KGAPI2::People::Name::displayNameLastFirst ( ) const

Output only.

The display name with the last name first formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.

Definition at line 164 of file name.cpp.

◆ familyName()

QString KGAPI2::People::Name::familyName ( ) const

The family name.

Definition at line 97 of file name.cpp.

◆ fromJSON()

Name KGAPI2::People::Name::fromJSON ( const QJsonObject & obj)
static

Definition at line 214 of file name.cpp.

◆ fromJSONArray()

QList< Name > KGAPI2::People::Name::fromJSONArray ( const QJsonArray & data)
static

Definition at line 240 of file name.cpp.

◆ fromKContactsAddressee()

Name KGAPI2::People::Name::fromKContactsAddressee ( const KContacts::Addressee & addressee)
static

Definition at line 276 of file name.cpp.

◆ givenName()

QString KGAPI2::People::Name::givenName ( ) const

The given name.

Definition at line 133 of file name.cpp.

◆ honorificPrefix()

QString KGAPI2::People::Name::honorificPrefix ( ) const

The honorific prefixes, such as Mrs.

or Dr.

Definition at line 124 of file name.cpp.

◆ honorificSuffix()

QString KGAPI2::People::Name::honorificSuffix ( ) const

The honorific suffixes, such as Jr.

Definition at line 177 of file name.cpp.

◆ metadata()

FieldMetadata KGAPI2::People::Name::metadata ( ) const

Metadata about the name.

Definition at line 204 of file name.cpp.

◆ middleName()

QString KGAPI2::People::Name::middleName ( ) const

The middle name(s).

Definition at line 115 of file name.cpp.

◆ operator!=()

bool KGAPI2::People::Name::operator!= ( const Name & other) const

Definition at line 83 of file name.cpp.

◆ operator==()

bool KGAPI2::People::Name::operator== ( const Name & other) const

Definition at line 78 of file name.cpp.

◆ phoneticFamilyName()

QString KGAPI2::People::Name::phoneticFamilyName ( ) const

The family name spelled as it sounds.

Definition at line 168 of file name.cpp.

◆ phoneticFullName()

QString KGAPI2::People::Name::phoneticFullName ( ) const

The full name spelled as it sounds.

Definition at line 195 of file name.cpp.

◆ phoneticGivenName()

QString KGAPI2::People::Name::phoneticGivenName ( ) const

The given name spelled as it sounds.

Definition at line 142 of file name.cpp.

◆ phoneticHonorificPrefix()

QString KGAPI2::People::Name::phoneticHonorificPrefix ( ) const

The honorific prefixes spelled as they sound.

Definition at line 151 of file name.cpp.

◆ phoneticHonorificSuffix()

QString KGAPI2::People::Name::phoneticHonorificSuffix ( ) const

The honorific suffixes spelled as they sound.

Definition at line 186 of file name.cpp.

◆ phoneticMiddleName()

QString KGAPI2::People::Name::phoneticMiddleName ( ) const

The middle name(s) spelled as they sound.

Definition at line 106 of file name.cpp.

◆ setFamilyName()

void KGAPI2::People::Name::setFamilyName ( const QString & value)

Sets value of the familyName property.

Definition at line 102 of file name.cpp.

◆ setGivenName()

void KGAPI2::People::Name::setGivenName ( const QString & value)

Sets value of the givenName property.

Definition at line 138 of file name.cpp.

◆ setHonorificPrefix()

void KGAPI2::People::Name::setHonorificPrefix ( const QString & value)

Sets value of the honorificPrefix property.

Definition at line 129 of file name.cpp.

◆ setHonorificSuffix()

void KGAPI2::People::Name::setHonorificSuffix ( const QString & value)

Sets value of the honorificSuffix property.

Definition at line 182 of file name.cpp.

◆ setMetadata()

void KGAPI2::People::Name::setMetadata ( const FieldMetadata & value)

Sets value of the metadata property.

Definition at line 209 of file name.cpp.

◆ setMiddleName()

void KGAPI2::People::Name::setMiddleName ( const QString & value)

Sets value of the middleName property.

Definition at line 120 of file name.cpp.

◆ setPhoneticFamilyName()

void KGAPI2::People::Name::setPhoneticFamilyName ( const QString & value)

Sets value of the phoneticFamilyName property.

Definition at line 173 of file name.cpp.

◆ setPhoneticFullName()

void KGAPI2::People::Name::setPhoneticFullName ( const QString & value)

Sets value of the phoneticFullName property.

Definition at line 200 of file name.cpp.

◆ setPhoneticGivenName()

void KGAPI2::People::Name::setPhoneticGivenName ( const QString & value)

Sets value of the phoneticGivenName property.

Definition at line 147 of file name.cpp.

◆ setPhoneticHonorificPrefix()

void KGAPI2::People::Name::setPhoneticHonorificPrefix ( const QString & value)

Sets value of the phoneticHonorificPrefix property.

Definition at line 156 of file name.cpp.

◆ setPhoneticHonorificSuffix()

void KGAPI2::People::Name::setPhoneticHonorificSuffix ( const QString & value)

Sets value of the phoneticHonorificSuffix property.

Definition at line 191 of file name.cpp.

◆ setPhoneticMiddleName()

void KGAPI2::People::Name::setPhoneticMiddleName ( const QString & value)

Sets value of the phoneticMiddleName property.

Definition at line 111 of file name.cpp.

◆ setUnstructuredName()

void KGAPI2::People::Name::setUnstructuredName ( const QString & value)

Sets value of the unstructuredName property.

Definition at line 93 of file name.cpp.

◆ toJSON()

QJsonValue KGAPI2::People::Name::toJSON ( ) const

Definition at line 254 of file name.cpp.

◆ unstructuredName()

QString KGAPI2::People::Name::unstructuredName ( ) const

The free form name value.

Definition at line 88 of file name.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 3 2024 11:50:42 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.