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

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

Public Member Functions

QString authenticationToken () const
 
QVector< Field > auxiliaryFields () const
 
QVector< Field > backFields () const
 
QImage background (unsigned int devicePixelRatio=1) const
 
QColor backgroundColor () const
 
QVector< Barcode > barcodes () const
 
QString description () const
 
QDateTime expirationDate () const
 
Field field (const QString &key) const
 
QVector< Field > fields () const
 
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
 
QVector< Field > headerFields () const
 
QImage icon (unsigned int devicePixelRatio=1) const
 
QImage image (const QString &baseName, unsigned int devicePixelRatio=1) const
 
bool isVoided () const
 
QColor labelColor () const
 
QVector< Location > locations () const
 
QImage logo (unsigned int devicePixelRatio=1) const
 
QString logoText () const
 
int maximumDistance () const
 
QString organizationName () const
 
QString passTypeIdentifier () const
 
QUrl passUpdateUrl () const
 
QVector< Field > primaryFields () const
 
QByteArray rawData () const
 
QDateTime relevantDate () const
 
QVector< Field > secondaryFields () const
 
QString serialNumber () const
 
QImage strip (unsigned int devicePixelRatio=1) const
 
QImage thumbnail (unsigned int devicePixelRatio=1) const
 
Type type () const
 
QUrl webServiceUrl () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
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 QRegExp &regExp, 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
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
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_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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 qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
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 setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, 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)
 
QString trUtf8 (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.

Member Function Documentation

◆ background()

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

Returns the background image if present.

Definition at line 425 of file pass.cpp.

◆ barcodes()

QVector<Barcode> KPkPass::Pass::barcodes ( ) const

Returns all barcodes defined in the pass.

◆ field()

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

Returns the field with key key.

Definition at line 508 of file pass.cpp.

◆ fields()

QVector< Field > Pass::fields ( ) const

Returns all fields found in this pass.

Definition at line 521 of file pass.cpp.

◆ footer()

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

Returns the footer image if present.

Definition at line 430 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 530 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 538 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.

◆ icon()

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

Returns the pass icon.

Definition at line 410 of file pass.cpp.

◆ image()

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

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.

◆ locations()

QVector<Location> KPkPass::Pass::locations ( ) const

Locations associated with this pass.

◆ logo()

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

Returns the pass logo.

Definition at line 415 of file pass.cpp.

◆ maximumDistance()

int Pass::maximumDistance ( ) const

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

Definition at line 299 of file pass.cpp.

◆ passUpdateUrl()

QUrl Pass::passUpdateUrl ( ) const

Pass update URL.

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

Definition at line 450 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 604 of file pass.cpp.

◆ strip()

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

Returns the strip image if present.

Definition at line 420 of file pass.cpp.

◆ thumbnail()

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

Returns the thumbnail image if present.

Definition at line 435 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-2023 The KDE developers.
Generated on Mon May 8 2023 04:00:43 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.