KPublicTransport::Manager Class Reference

#include <manager.h>

Inheritance diagram for KPublicTransport::Manager:

Properties
bool	allowInsecureBackends
QVariantList	attributions
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
QStringList	disabledBackends () const
QStringList	enabledBackends () const
bool	isBackendEnabled (const QString &backendId) const
DepartureReply *	queryDeparture (const DepartureRequest &req) const
JourneyReply *	queryJourney (const JourneyRequest &req) const
LocationReply *	queryLocation (const LocationRequest &req) const
void	setAllowInsecureBackends (bool insecure)
void	setBackendEnabled (const QString &backendId, bool enabled)
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 QObjectList &	children () const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const
bool	disconnect (const QObject *receiver, const char *method) const
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
bool	inherits (const char *className) const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const
bool	isWindowType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
QString	objectName () const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const
QVariant	property (const char *name) const
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval, Qt::TimerType timerType)
QThread *	thread () 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)
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
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () 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 50 of file manager.h.

Property Documentation

bool Manager::allowInsecureBackends

readwrite

Allow usage of insecure backends (default: off).

Definition at line 56 of file manager.h.

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

read

QML-compatible access to attributions().

Definition at line 54 of file manager.h.

QStringList Manager::disabledBackends

readwrite

See also

disabledBackends()

Definition at line 61 of file manager.h.

QStringList Manager::enabledBackends

readwrite

See also

enabledBackends()

Definition at line 59 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 602 of file manager.cpp.

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

DepartureReply * Manager::queryDeparture

(

const DepartureRequest &

req

)

const

Query departures from a specific station.

Definition at line 509 of file manager.cpp.

JourneyReply * Manager::queryJourney

(

const JourneyRequest &

req

)

const

Query a journey.

Definition at line 460 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 551 of file manager.cpp.

void Manager::setAllowInsecureBackends

(

bool

insecure

)

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

Definition at line 451 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 635 of file manager.cpp.

void Manager::setDisabledBackends

(

const QStringList &

backendIds

)

Sets the explicitly disabled backends.

Use for restoring persisted settings.

Definition at line 665 of file manager.cpp.

void Manager::setEnabledBackends

(

const QStringList &

backendIds

)

Sets the explicitly enabled backends.

Use for restoring persisted settings.

Definition at line 652 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 433 of file manager.cpp.

---

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

• manager.h
• manager.cpp