KPkPass::Pass

Search for usage in LXR

Public Types | Properties | Public Member Functions | Static Public Member Functions | List of all members
KPkPass::Pass Class Reference

#include <pass.h>

Inheritance diagram for KPkPass::Pass:
Inheritance graph
[legend]

Public Types

enum  Type {
  BoardingPass , Coupon , EventTicket , Generic ,
  StoreCard
}
 

Properties

QList< KPkPass::Field > auxiliaryFields
 
QList< KPkPass::Field > backFields
 
QColor backgroundColor
 
QList< KPkPass::Barcode > barcodes
 
QString description
 
QDateTime expirationDate
 
QVariantMap field
 
QColor foregroundColor
 
QString groupingIdentifier
 
bool hasBackground
 
bool hasFooter
 
bool hasIcon
 
bool hasLogo
 
bool hasStrip
 
bool hasThumbnail
 
QList< KPkPass::Field > headerFields
 
bool isVoided
 
QColor labelColor
 
QList< KPkPass::Location > locations
 
QString logoText
 
QString organizationName
 
QString passTypeIdentifier
 
QList< KPkPass::Field > primaryFields
 
QDateTime relevantDate
 
QList< KPkPass::Field > secondaryFields
 
QString serialNumber
 
Type type
 
- Properties inherited from QObject
 objectName
 

Public Member Functions

QString authenticationToken () const
 
QList< Field > auxiliaryFields () const
 
QList< Field > backFields () const
 
Q_INVOKABLE QImage background (unsigned int devicePixelRatio=1) const
 
QColor backgroundColor () const
 
QList< Barcode > barcodes () const
 
QString description () const
 
QDateTime expirationDate () const
 
Field field (const QString &key) const
 
QList< Field > fields () const
 
Q_INVOKABLE QImage footer (unsigned int devicePixelRatio=1) const
 
QColor foregroundColor () const
 
QString groupingIdentifier () const
 
bool hasBackground () const
 
bool hasFooter () const
 
bool hasIcon () const
 
bool hasImage (const QString &baseName) const
 
bool hasLogo () const
 
bool hasStrip () const
 
bool hasThumbnail () const
 
QList< Field > headerFields () const
 
Q_INVOKABLE QImage icon (unsigned int devicePixelRatio=1) const
 
QImage image (const QString &baseName, unsigned int devicePixelRatio=1) const
 
bool isVoided () const
 
QColor labelColor () const
 
QList< Location > locations () const
 
Q_INVOKABLE QImage logo (unsigned int devicePixelRatio=1) const
 
QString logoText () const
 
int maximumDistance () const
 
QString organizationName () const
 
QString passTypeIdentifier () const
 
QUrl passUpdateUrl () const
 
QList< Field > primaryFields () const
 
QByteArray rawData () const
 
QDateTime relevantDate () const
 
QList< Field > secondaryFields () const
 
QString serialNumber () const
 
Q_INVOKABLE QImage strip (unsigned int devicePixelRatio=1) const
 
Q_INVOKABLE QImage thumbnail (unsigned int devicePixelRatio=1) const
 
Type type () const
 
QUrl webServiceUrl () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QString > bindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectList & children () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArray > dynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObject * parent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
T qobject_cast (const QObject *object)
 
T qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThread * thread () const const
 

Static Public Member Functions

static Pass * fromData (const QByteArray &data, QObject *parent=nullptr)
 
static Pass * fromFile (const QString &fileName, QObject *parent=nullptr)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObject * sender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Base class for a pkpass file.

See also
https://developer.apple.com/library/archive/documentation/UserExperience/Conceptual/PassKit_PG/index.html
https://developer.apple.com/library/content/documentation/UserExperience/Reference/PassKit_Bundle/Chapters/TopLevel.html

Definition at line 34 of file pass.h.

Member Enumeration Documentation

◆ Type

enum KPkPass::Pass::Type

Type of the pass.

Definition at line 76 of file pass.h.

Property Documentation

◆ auxiliaryFields

QList<KPkPass::Field> KPkPass::Pass::auxiliaryFields
read

Definition at line 64 of file pass.h.

◆ backFields

QList<KPkPass::Field> KPkPass::Pass::backFields
read

Definition at line 65 of file pass.h.

◆ backgroundColor

QColor KPkPass::Pass::backgroundColor
read

Definition at line 49 of file pass.h.

◆ barcodes

QList<KPkPass::Barcode> KPkPass::Pass::barcodes
read

Definition at line 63 of file pass.h.

◆ description

QString KPkPass::Pass::description
read

Definition at line 39 of file pass.h.

◆ expirationDate

QDateTime KPkPass::Pass::expirationDate
read

Definition at line 44 of file pass.h.

◆ field

QVariantMap KPkPass::Pass::field
read

Definition at line 70 of file pass.h.

◆ foregroundColor

QColor KPkPass::Pass::foregroundColor
read

Definition at line 50 of file pass.h.

◆ groupingIdentifier

QString KPkPass::Pass::groupingIdentifier
read

Definition at line 51 of file pass.h.

◆ hasBackground

bool KPkPass::Pass::hasBackground
read

Definition at line 58 of file pass.h.

◆ hasFooter

bool KPkPass::Pass::hasFooter
read

Definition at line 59 of file pass.h.

◆ hasIcon

bool KPkPass::Pass::hasIcon
read

Definition at line 55 of file pass.h.

◆ hasLogo

bool KPkPass::Pass::hasLogo
read

Definition at line 56 of file pass.h.

◆ hasStrip

bool KPkPass::Pass::hasStrip
read

Definition at line 57 of file pass.h.

◆ hasThumbnail

bool KPkPass::Pass::hasThumbnail
read

Definition at line 60 of file pass.h.

◆ headerFields

QList<KPkPass::Field> KPkPass::Pass::headerFields
read

Definition at line 66 of file pass.h.

◆ isVoided

bool KPkPass::Pass::isVoided
read

Definition at line 45 of file pass.h.

◆ labelColor

QColor KPkPass::Pass::labelColor
read

Definition at line 52 of file pass.h.

◆ locations

QList<KPkPass::Location> KPkPass::Pass::locations
read

Definition at line 69 of file pass.h.

◆ logoText

QString KPkPass::Pass::logoText
read

Definition at line 53 of file pass.h.

◆ organizationName

QString KPkPass::Pass::organizationName
read

Definition at line 40 of file pass.h.

◆ passTypeIdentifier

QString KPkPass::Pass::passTypeIdentifier
read

Definition at line 41 of file pass.h.

◆ primaryFields

QList<KPkPass::Field> KPkPass::Pass::primaryFields
read

Definition at line 67 of file pass.h.

◆ relevantDate

QDateTime KPkPass::Pass::relevantDate
read

Definition at line 47 of file pass.h.

◆ secondaryFields

QList<KPkPass::Field> KPkPass::Pass::secondaryFields
read

Definition at line 68 of file pass.h.

◆ serialNumber

QString KPkPass::Pass::serialNumber
read

Definition at line 42 of file pass.h.

◆ type

Type KPkPass::Pass::type
read

Definition at line 37 of file pass.h.

Member Function Documentation

◆ authenticationToken()

QString Pass::authenticationToken ( ) const
nodiscard

Definition at line 460 of file pass.cpp.

◆ auxiliaryFields()

QList< Field > Pass::auxiliaryFields ( ) const

Definition at line 503 of file pass.cpp.

◆ backFields()

QList< Field > Pass::backFields ( ) const

Definition at line 508 of file pass.cpp.

◆ background()

QImage Pass::background ( unsigned int devicePixelRatio = 1) const
nodiscard

Returns the background image if present.

Definition at line 445 of file pass.cpp.

◆ backgroundColor()

QColor Pass::backgroundColor ( ) const
nodiscard

Definition at line 320 of file pass.cpp.

◆ barcodes()

QList< Barcode > Pass::barcodes ( ) const
nodiscard

Returns all barcodes defined in the pass.

Definition at line 480 of file pass.cpp.

◆ description()

QString Pass::description ( ) const
nodiscard

Definition at line 257 of file pass.cpp.

◆ expirationDate()

QDateTime Pass::expirationDate ( ) const
nodiscard

Definition at line 277 of file pass.cpp.

◆ field()

Field Pass::field ( const QString & key) const

Returns the field with key key.

Definition at line 528 of file pass.cpp.

◆ fields()

QList< Field > Pass::fields ( ) const

Returns all fields found in this pass.

Definition at line 541 of file pass.cpp.

◆ footer()

QImage Pass::footer ( unsigned int devicePixelRatio = 1) const
nodiscard

Returns the footer image if present.

Definition at line 450 of file pass.cpp.

◆ foregroundColor()

QColor Pass::foregroundColor ( ) const
nodiscard

Definition at line 325 of file pass.cpp.

◆ fromData()

Pass * Pass::fromData ( const QByteArray & data,
QObject * parent = nullptr )
static

Create a appropriate sub-class based on the pkpass file type.

Definition at line 550 of file pass.cpp.

◆ fromFile()

Pass * Pass::fromFile ( const QString & fileName,
QObject * parent = nullptr )
static

Create a appropriate sub-class based on the pkpass file type.

Definition at line 558 of file pass.cpp.

◆ groupingIdentifier()

QString Pass::groupingIdentifier ( ) const
nodiscard

Definition at line 330 of file pass.cpp.

◆ hasBackground()

bool Pass::hasBackground ( ) const

Definition at line 377 of file pass.cpp.

◆ hasFooter()

bool Pass::hasFooter ( ) const

Definition at line 382 of file pass.cpp.

◆ hasIcon()

bool Pass::hasIcon ( ) const

Definition at line 362 of file pass.cpp.

◆ hasImage()

bool Pass::hasImage ( const QString & baseName) const

Returns true if an image asset with the given base name exists.

Parameters
baseNameThe name of the asset, without the file type and high dpi extensions.
Since
5.20.41

Definition at line 349 of file pass.cpp.

◆ hasLogo()

bool Pass::hasLogo ( ) const

Definition at line 367 of file pass.cpp.

◆ hasStrip()

bool Pass::hasStrip ( ) const

Definition at line 372 of file pass.cpp.

◆ hasThumbnail()

bool Pass::hasThumbnail ( ) const

Definition at line 387 of file pass.cpp.

◆ headerFields()

QList< Field > Pass::headerFields ( ) const

Definition at line 513 of file pass.cpp.

◆ icon()

QImage Pass::icon ( unsigned int devicePixelRatio = 1) const
nodiscard

Returns the pass icon.

Definition at line 430 of file pass.cpp.

◆ image()

QImage Pass::image ( const QString & baseName,
unsigned int devicePixelRatio = 1 ) const
nodiscard

Returns an image asset of this pass.

Parameters
baseNameThe name of the asset, without the file name extension.
devicePixelRatioThe device pixel ration, for loading highdpi assets.

Definition at line 392 of file pass.cpp.

◆ isVoided()

bool Pass::isVoided ( ) const
nodiscard

Definition at line 282 of file pass.cpp.

◆ labelColor()

QColor Pass::labelColor ( ) const
nodiscard

Definition at line 335 of file pass.cpp.

◆ locations()

QList< Location > Pass::locations ( ) const
nodiscard

Locations associated with this pass.

Definition at line 287 of file pass.cpp.

◆ logo()

QImage Pass::logo ( unsigned int devicePixelRatio = 1) const
nodiscard

Returns the pass logo.

Definition at line 435 of file pass.cpp.

◆ logoText()

QString Pass::logoText ( ) const
nodiscard

Definition at line 344 of file pass.cpp.

◆ maximumDistance()

int Pass::maximumDistance ( ) const
nodiscard

Distance in meters to any of the pass locations before this pass becomes relevant.

Definition at line 299 of file pass.cpp.

◆ organizationName()

QString Pass::organizationName ( ) const
nodiscard

Definition at line 262 of file pass.cpp.

◆ passTypeIdentifier()

QString Pass::passTypeIdentifier ( ) const
nodiscard

Definition at line 267 of file pass.cpp.

◆ passUpdateUrl()

QUrl Pass::passUpdateUrl ( ) const
nodiscard

Pass update URL.

See also
https://developer.apple.com/library/content/documentation/PassKit/Reference/PassKit_WebService/WebService.html

Definition at line 470 of file pass.cpp.

◆ primaryFields()

QList< Field > Pass::primaryFields ( ) const

Definition at line 518 of file pass.cpp.

◆ rawData()

QByteArray Pass::rawData ( ) const

The raw data of this pass.

That is the binary representation of the ZIP archive which contains all the pass data.

Since
5.20.41

Definition at line 578 of file pass.cpp.

◆ relevantDate()

QDateTime Pass::relevantDate ( ) const
nodiscard

Definition at line 304 of file pass.cpp.

◆ secondaryFields()

QList< Field > Pass::secondaryFields ( ) const

Definition at line 523 of file pass.cpp.

◆ serialNumber()

QString Pass::serialNumber ( ) const
nodiscard

Definition at line 272 of file pass.cpp.

◆ strip()

QImage Pass::strip ( unsigned int devicePixelRatio = 1) const
nodiscard

Returns the strip image if present.

Definition at line 440 of file pass.cpp.

◆ thumbnail()

QImage Pass::thumbnail ( unsigned int devicePixelRatio = 1) const
nodiscard

Returns the thumbnail image if present.

Definition at line 455 of file pass.cpp.

◆ type()

Pass::Type Pass::type ( ) const
nodiscard

Definition at line 252 of file pass.cpp.

◆ webServiceUrl()

QUrl Pass::webServiceUrl ( ) const
nodiscard

Definition at line 465 of file pass.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri May 2 2025 11:52:12 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.