Contents

KUserFeedback::AbstractDataSource Class

class KUserFeedback::AbstractDataSource

Base class for data sources for telemetry data. More...

Header: #include <KUserFeedback/AbstractDataSource>
CMake: find_package(KF6 REQUIRED COMPONENTS UserFeedbackCore)
target_link_libraries(mytarget PRIVATE KF6::UserFeedbackCore)
Inherited By:

KUserFeedback::ApplicationVersionSource, KUserFeedback::CompilerInfoSource, KUserFeedback::CpuInfoSource, KUserFeedback::LocaleInfoSource, KUserFeedback::OpenGLInfoSource, KUserFeedback::PlatformInfoSource, KUserFeedback::PropertyRatioSource, KUserFeedback::QPAInfoSource, KUserFeedback::QtVersionSource, KUserFeedback::ScreenInfoSource, KUserFeedback::SelectionRatioSource, KUserFeedback::StartCountSource, KUserFeedback::StyleInfoSource, and KUserFeedback::UsageTimeSource

Public Functions

virtual QVariant data() = 0
virtual QString description() const = 0
QString id() const
bool isActive() const
void load(QSettings *settings)
virtual QString name() const
void reset(QSettings *settings)
void setActive(bool active)
void setTelemetryMode(KUserFeedback::Provider::TelemetryMode mode)
void store(QSettings *settings)
KUserFeedback::Provider::TelemetryMode telemetryMode() const

Protected Functions

AbstractDataSource(const QString &id, KUserFeedback::Provider::TelemetryMode mode = Provider::DetailedUsageStatistics)
AbstractDataSource(const QString &id, KUserFeedback::Provider::TelemetryMode mode, KUserFeedback::AbstractDataSourcePrivate *dd)
virtual void loadImpl(QSettings *settings)
virtual void resetImpl(QSettings *settings)
void setId(const QString &id)
virtual void storeImpl(QSettings *settings)

Detailed Description

Member Function Documentation

[explicit protected] AbstractDataSource::AbstractDataSource(const QString &id, KUserFeedback::Provider::TelemetryMode mode = Provider::DetailedUsageStatistics)

Create a new data source named name.

The name of the data source must match the corresponding product schema entry.

id Must not be empty.

mode The default telemetry mode.

[explicit protected] AbstractDataSource::AbstractDataSource(const QString &id, KUserFeedback::Provider::TelemetryMode mode, KUserFeedback::AbstractDataSourcePrivate *dd)

[pure virtual] QVariant AbstractDataSource::data()

Returns the data gathered by this source.

Implement this to return the data provided by this source. One of the three following formats are expected:

The innermost QAssociativeIterable must only contain one of the following base types (which has to match the corresponding schema entry element):

All keys must be strings.

Returns a variant complying with the above requirements.

[pure virtual] QString AbstractDataSource::description() const

Returns a human-readable, translated description of what this source provides.

Returns a translated, human-readable string.

See also id().

QString AbstractDataSource::id() const

Returns the ID of this data source. This is used as identifier towards the server and should not be shown to the user.

Returns the data source identifier configured on the feedback server.

See also setId() and description().

bool AbstractDataSource::isActive() const

Checks whether this data source is active or not

If the data source is not active, then collected data neither will be sent to a server nor appeared in the audit log.

Data source is active by default.

Returns true if active, false otherwise

void AbstractDataSource::load(QSettings *settings)

Load persistent state for this data source.

settings A QSettings object opened in a dedicated group for loading persistent data.

[virtual protected] void AbstractDataSource::loadImpl(QSettings *settings)

Invoked by load() in order to load individual settings of this data source.

settings A QSettings object opened in a dedicated group for loading persistent data.

See also load(), description, for, further, and details.

[virtual] QString AbstractDataSource::name() const

Returns a short name of this data source.

Can be empty if short name is meaningless for this data source.

Returns a translated, human-readable string.

void AbstractDataSource::reset(QSettings *settings)

Reset the persistent state of this data source.

This is called after a successful submission of data, and can be used by sources that track differential rather than absolute data to reset their counters.

settings A QSettings object opened in the dedicated group of this data source.

[virtual protected] void AbstractDataSource::resetImpl(QSettings *settings)

Invoked by reset() in order to reset individual settings of this data source.

See reset() description for further details.

settings A QSettings object opened in a dedicated group for loading persistent data.

void AbstractDataSource::setActive(bool active)

Changes active state of the data source

active The new active state for this data source

See also isActive().

[protected] void AbstractDataSource::setId(const QString &id)

Set the ID of this data source.

The ID should not change at runtime, this is only provided for enabling QML API for generic sources.

See also id().

void AbstractDataSource::setTelemetryMode(KUserFeedback::Provider::TelemetryMode mode)

Sets which telemetry colleciton mode this data source belongs to.

mode The data collection mode of this source.

Provider::NoTelemetry is not allowed here.

See also telemetryMode().

void AbstractDataSource::store(QSettings *settings)

Store persistent state for this data source.

settings A QSettings object opened in a dedicated group for storing persistent data.

[virtual protected] void AbstractDataSource::storeImpl(QSettings *settings)

Invoked by store() in order to store individual settings of this data source.

settings A QSettings object opened in a dedicated group for loading persistent data.

See also store(), description, for, further, and details.

KUserFeedback::Provider::TelemetryMode AbstractDataSource::telemetryMode() const

Returns which telemetry colleciton mode this data source belongs to.

See also setTelemetryMode().