Pages

API Documentation

• User Documentation
• Developer Documentation
• API Documentation

Search API documentation

On this page

KUserFeedback::FeedbackConfigUiController Class

Logic/behavior of the feedback configuration UI. More...

• Header: #include <KUserFeedback/FeedbackConfigUiController>
• CMake: find_package(KF6 REQUIRED COMPONENTS UserFeedbackCore)
target_link_libraries(mytarget PRIVATE KF6::UserFeedbackCore)
• Inherits: QObject

List of all members, including inherited members

#Properties

• applicationName : QString
• feedbackProvider : KUserFeedback::Provider*
• [read-only] surveyModeCount : const int
• [read-only] telemetryModeCount : int

#Public Functions

• FeedbackConfigUiController(QObject *parent = nullptr)
• QString applicationName() const
• KUserFeedback::Provider *feedbackProvider() const
• void setApplicationName(const QString &appName)
• void setFeedbackProvider(KUserFeedback::Provider *provider)
• int surveyIndexToInterval(int index) const
• int surveyIntervalToIndex(int interval) const
• int surveyModeCount() const
• QString surveyModeDescription(int surveyIndex) const
• QString telemetryDescription(KUserFeedback::Provider::TelemetryMode mode) const
• KUserFeedback::Provider::TelemetryMode telemetryIndexToMode(int index) const
• int telemetryModeCount() const
• QString telemetryModeDescription(int telemetryIndex) const
• QString telemetryModeDetails(int telemetryIndex) const
• QString telemetryModeName(int telemetryIndex) const
• int telemetryModeToIndex(KUserFeedback::Provider::TelemetryMode mode) const
• QString telemetryName(KUserFeedback::Provider::TelemetryMode mode) const

#Signals

• void applicationNameChanged(const QString &applicationName)
• void providerChanged()

#Detailed Description

This is available for use in e.g. QtQuick-based UIs.

See also KUserFeedback::FeedbackConfigWidget

#Property Documentation

#applicationName : QString

Name of the application that will appear on descriptions. By default it will use QGuiApplication::applicationDisplayName()

Access functions:

• QString applicationName() const
• void setApplicationName(const QString &appName)

Notifier signal:

• void applicationNameChanged(const QString &applicationName)

#feedbackProvider : KUserFeedback::Provider*

The Provider instance we are configuring.

Access functions:

• KUserFeedback::Provider *feedbackProvider() const
• void setFeedbackProvider(KUserFeedback::Provider *provider)

Notifier signal:

• void providerChanged()

#[read-only] surveyModeCount : const int

Amount of supported survey modes.

Access functions:

• int surveyModeCount() const

#[read-only] telemetryModeCount : int

Amount of telemetry modes supported by the provider.

Access functions:

• int telemetryModeCount() const

Notifier signal:

• void providerChanged()

#Member Function Documentation

#[explicit] FeedbackConfigUiController::FeedbackConfigUiController(QObject *parent = nullptr)

#QString FeedbackConfigUiController::applicationName() const

Note: Getter function for property applicationName.

See also setApplicationName()

#[signal] void FeedbackConfigUiController::applicationNameChanged(const QString &applicationName)

Note: Notifier signal for property applicationName.

#KUserFeedback::Provider *FeedbackConfigUiController::feedbackProvider() const

Returns the feedback provider to be configured.

Note: Getter function for property feedbackProvider.

See also setFeedbackProvider()

#[signal] void FeedbackConfigUiController::providerChanged()

A provider-related setting has changed.

Note: Notifier signal for properties feedbackProvider and telemetryModeCount.

#void FeedbackConfigUiController::setApplicationName(const QString &appName)

Note: Setter function for property applicationName.

See also applicationName()

#void FeedbackConfigUiController::setFeedbackProvider(KUserFeedback::Provider *provider)

Set the feedback provider to configure.

Note: Setter function for property feedbackProvider.

See also feedbackProvider()

#[invokable] int FeedbackConfigUiController::surveyIndexToInterval(int index) const

Convert slider index to survey interval.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

#[invokable] int FeedbackConfigUiController::surveyIntervalToIndex(int interval) const

Convert survey interval to slider index.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

#int FeedbackConfigUiController::surveyModeCount() const

Amount of supported survey modes.

Note: Getter function for property surveyModeCount.

#[invokable] QString FeedbackConfigUiController::surveyModeDescription(int surveyIndex) const

Survey mode explanation text.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

#[invokable] QString FeedbackConfigUiController::telemetryDescription(KUserFeedback::Provider::TelemetryMode mode) const

Telemetry mode explanation text.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

#[invokable] KUserFeedback::Provider::TelemetryMode FeedbackConfigUiController::telemetryIndexToMode(int index) const

Convert slider index to telemetry mode.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

#int FeedbackConfigUiController::telemetryModeCount() const

Amount of supported telemetry modes. This depends on what type of sources the provider actually has.

Note: Getter function for property telemetryModeCount.

#[invokable] QString FeedbackConfigUiController::telemetryModeDescription(int telemetryIndex) const

Telemetry mode explanation text.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

#[invokable] QString FeedbackConfigUiController::telemetryModeDetails(int telemetryIndex) const

Detailed information about the data sources of the given telemetry mode index.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

#[invokable] QString FeedbackConfigUiController::telemetryModeName(int telemetryIndex) const

Telemetry mode short name.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

#[invokable] int FeedbackConfigUiController::telemetryModeToIndex(KUserFeedback::Provider::TelemetryMode mode) const

Convert telemetry mode to slider index.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

#[invokable] QString FeedbackConfigUiController::telemetryName(KUserFeedback::Provider::TelemetryMode mode) const

Telemetry mode short name.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.