KPublicTransport::Manager Class Reference

#include <manager.h>

Inheritance diagram for KPublicTransport::Manager:

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

Signals
void	attributionsChanged ()
void	backendsChanged ()
void	configurationChanged ()

Public Slots
void	reload ()

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
Q_INVOKABLE bool	isBackendEnabled (const QString &backendId) const
JourneyReply *	queryJourney (const JourneyRequest &req) const
LocationReply *	queryLocation (const LocationRequest &req) const
StopoverReply *	queryStopover (const StopoverRequest &req) const
Q_INVOKABLE KPublicTransport::TripReply *	queryTrip (const TripRequest &req) const
VehicleLayoutReply *	queryVehicleLayout (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)
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)
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

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 *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)
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

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 43 of file manager.h.

Property Documentation

allowInsecureBackends

bool KPublicTransport::Manager::allowInsecureBackends

readwrite

Allow usage of insecure backends (default: off).

Definition at line 49 of file manager.h.

attributions

QVariantList KPublicTransport::Manager::attributions

read

QML-compatible access to attributions().

Definition at line 47 of file manager.h.

backends

QVariantList KPublicTransport::Manager::backends

read

QML-compatible access to backends().

Definition at line 59 of file manager.h.

backendsEnabledByDefault

bool KPublicTransport::Manager::backendsEnabledByDefault

readwrite

See also

backendsEnabledByDefault()

Definition at line 56 of file manager.h.

disabledBackends

QStringList KPublicTransport::Manager::disabledBackends

readwrite

See also

disabledBackends()

Definition at line 54 of file manager.h.

enabledBackends

QStringList KPublicTransport::Manager::enabledBackends

readwrite

See also

enabledBackends()

Definition at line 52 of file manager.h.

Constructor & Destructor Documentation

Manager()

Manager::Manager ( QObject * parent = nullptr )

explicit

Definition at line 498 of file manager.cpp.

Member Function Documentation

allowInsecureBackends()

bool Manager::allowInsecureBackends ( ) const

nodiscard

Returns whether access to insecure backends is allowed.

Definition at line 531 of file manager.cpp.

attributions()

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

nodiscard

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

Definition at line 1019 of file manager.cpp.

backends()

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

nodiscard

Returns information about all available backends.

Definition at line 1036 of file manager.cpp.

backendsEnabledByDefault()

bool Manager::backendsEnabledByDefault ( ) const

nodiscard

Returns wheter backends are enabled by default.

Defaults to true.

Definition at line 1108 of file manager.cpp.

disabledBackends()

QStringList Manager::disabledBackends ( ) const

nodiscard

Returns the identifiers of explicitly disabled backends.

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

Definition at line 1095 of file manager.cpp.

enabledBackends()

QStringList Manager::enabledBackends ( ) const

nodiscard

Returns the identifiers of explicitly enabled backends.

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

Definition at line 1082 of file manager.cpp.

isBackendEnabled()

bool Manager::isBackendEnabled ( const QString & backendId ) const

nodiscard

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

Definition at line 1042 of file manager.cpp.

queryJourney()

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

nodiscard

Query a journey.

Definition at line 545 of file manager.cpp.

queryLocation()

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

nodiscard

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

Definition at line 758 of file manager.cpp.

queryStopover()

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

nodiscard

Query arrivals or departures from a specific station.

Definition at line 653 of file manager.cpp.

queryTrip()

TripReply * Manager::queryTrip ( const TripRequest & req ) const

nodiscard

Query trip information.

That is a specific run of a vehicle on a route. When there's a backend supporting trip queries this returns the full trip. For backends not supporting this, this internally falls back to a journey query and thus might return only a subset of the trip, based on the JourneySection used in the request.

Since

25.04

Definition at line 841 of file manager.cpp.

queryVehicleLayout()

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

nodiscard

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 949 of file manager.cpp.

reload

void Manager::reload ( )

slot

Reload backend configuration.

Can be used when on-disk configuration has been changed. Automatically called on language changes.

Definition at line 1009 of file manager.cpp.

setAllowInsecureBackends()

void Manager::setAllowInsecureBackends

(

bool

insecure

)

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

Definition at line 536 of file manager.cpp.

setBackendEnabled()

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 1070 of file manager.cpp.

setBackendsEnabledByDefault()

void Manager::setBackendsEnabledByDefault

(

bool

byDefault

)

Set wheter backends are enabled by default.

Definition at line 1113 of file manager.cpp.

setDisabledBackends()

void Manager::setDisabledBackends

(

const QStringList &

backendIds

)

Sets the explicitly disabled backends.

Use for restoring persisted settings.

Definition at line 1100 of file manager.cpp.

setEnabledBackends()

void Manager::setEnabledBackends

(

const QStringList &

backendIds

)

Sets the explicitly enabled backends.

Use for restoring persisted settings.

Definition at line 1087 of file manager.cpp.

setNetworkAccessManager()

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 518 of file manager.cpp.

---

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

• manager.h
• manager.cpp