KPublicTransport::Manager

Search for usage in LXR

KPublicTransport::Manager Class Reference

#include <manager.h>

Inheritance diagram for KPublicTransport::Manager:

Properties

bool allowInsecureBackends
 
QVariantList attributions
 
bool backendsEnabledByDefault
 
QStringList disabledBackends
 
QStringList enabledBackends
 
- Properties inherited from QObject
 objectName
 

Signals

void attributionsChanged ()
 
void configurationChanged ()
 

Public Member Functions

 Manager (QObject *parent=nullptr)
 
bool allowInsecureBackends () const
 
const std::vector< Attribution > & attributions () const
 
const std::vector< Backend > & backends () const
 
bool backendsEnabledByDefault () const
 
QStringList disabledBackends () const
 
QStringList enabledBackends () const
 
bool isBackendEnabled (const QString &backendId) const
 
StopoverReplyqueryDeparture (const StopoverRequest &req) const
 
JourneyReplyqueryJourney (const JourneyRequest &req) const
 
LocationReplyqueryLocation (const LocationRequest &req) const
 
StopoverReplyqueryStopover (const StopoverRequest &req) const
 
VehicleLayoutReplyqueryVehicleLayout (const VehicleLayoutRequest &req) const
 
void setAllowInsecureBackends (bool insecure)
 
void setBackendEnabled (const QString &backendId, bool enabled)
 
void setBackendsEnabledByDefault (bool byDefault)
 
void setDisabledBackends (const QStringList &backendIds)
 
void setEnabledBackends (const QStringList &backendIds)
 
void setNetworkAccessManager (QNetworkAccessManager *nam)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (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
 
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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () 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
 
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)
 
qobject_cast (QObject *object)
 
qobject_cast (const 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)
 
QThreadthread () const const
 

Additional Inherited Members

- 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Entry point for starting public transport queries.

Queries return reply objects, you are responsible for deleting those, typically by calling deleteLater() on them after having retrieved their result (similar to how QNetworkAccessManager works).

Definition at line 41 of file manager.h.

Property Documentation

bool Manager::allowInsecureBackends
readwrite

Allow usage of insecure backends (default: off).

Definition at line 47 of file manager.h.

const std::vector< Attribution > & Manager::attributions
read

QML-compatible access to attributions().

Definition at line 45 of file manager.h.

bool KPublicTransport::Manager::backendsEnabledByDefault
readwrite
See also
backendsEnabledByDefault()

Definition at line 54 of file manager.h.

QStringList Manager::disabledBackends
readwrite
See also
disabledBackends()

Definition at line 52 of file manager.h.

QStringList Manager::enabledBackends
readwrite
See also
enabledBackends()

Definition at line 50 of file manager.h.

Member Function Documentation

bool KPublicTransport::Manager::allowInsecureBackends ( ) const

Returns whether access to insecure backends is allowed.

const std::vector<Attribution>& KPublicTransport::Manager::attributions ( ) const

Returns all static attribution information, as well as all dynamic ones found in the cache or accumulated during the lifetime of this instance.

const std::vector< Backend > & Manager::backends ( ) const

Returns information about all available backends.

Definition at line 765 of file manager.cpp.

bool KPublicTransport::Manager::backendsEnabledByDefault ( ) const

Returns wheter backends are enabled by default.

Defaults to true.

QStringList KPublicTransport::Manager::disabledBackends ( ) const

Returns the identifiers of explicitly disabled backends.

Use this for persisting settings, not for checking for disabled backends.

QStringList KPublicTransport::Manager::enabledBackends ( ) const

Returns the identifiers of explicitly enabled backends.

Use this for persisting the settings, not for checking for enabled backends.

bool Manager::isBackendEnabled ( const QString backendId) const

Returns whether the use of the backend with a given identifier is enabled.

Definition at line 770 of file manager.cpp.

JourneyReply * Manager::queryJourney ( const JourneyRequest req) const

Query a journey.

Definition at line 498 of file manager.cpp.

LocationReply * Manager::queryLocation ( const LocationRequest req) const

Query location information based on coordinates or (parts of) the name.

Definition at line 648 of file manager.cpp.

StopoverReply * Manager::queryStopover ( const StopoverRequest req) const

Query arrivals or departures from a specific station.

Definition at line 572 of file manager.cpp.

VehicleLayoutReply * Manager::queryVehicleLayout ( const VehicleLayoutRequest req) const

Query vehicle and platform layout information.

This is only available for some trains and some operators, so be prepared for empty results.

Definition at line 702 of file manager.cpp.

void Manager::setAllowInsecureBackends ( bool  insecure)

Allow usage of insecure backends, that is services not using transport encryption.

Definition at line 489 of file manager.cpp.

void Manager::setBackendEnabled ( const QString backendId,
bool  enabled 
)

Sets whether the backend with the given identifier should be used.

Note
If allowInsecureBackends() is false, this has precedence.

Definition at line 798 of file manager.cpp.

void KPublicTransport::Manager::setBackendsEnabledByDefault ( bool  byDefault)

Set wheter backends are enabled by default.

Definition at line 841 of file manager.cpp.

void Manager::setDisabledBackends ( const QStringList backendIds)

Sets the explicitly disabled backends.

Use for restoring persisted settings.

Definition at line 828 of file manager.cpp.

void Manager::setEnabledBackends ( const QStringList backendIds)

Sets the explicitly enabled backends.

Use for restoring persisted settings.

Definition at line 815 of file manager.cpp.

void Manager::setNetworkAccessManager ( QNetworkAccessManager nam)

Set the network access manager to use for network operations.

If not set, an instance is created internally. Ownership is not transferred.

Definition at line 467 of file manager.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Mon Sep 27 2021 23:07:33 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.