Soprano 2.9.4
Soprano::BackendSetting Class Reference

Wraps one setting for Model creation. More...

#include <Soprano/BackendSetting>

Public Member Functions

 BackendSetting ()
 BackendSetting (BackendOption option)
 BackendSetting (BackendOption s, const QVariant &value_)
 BackendSetting (const QString &userOption, const QVariant &value_)
 BackendSetting (const BackendSetting &other)
 ~BackendSetting ()
BackendSettingoperator= (const BackendSetting &other)
BackendOption option () const
QString userOptionName () const
QVariant value () const
void setValue (const QVariant &value)

(Note that these are not member symbols.)

SOPRANO_EXPORT bool isOptionInSettings (const BackendSettings &settings, BackendOption option, const QString &userOptionName=QString())
SOPRANO_EXPORT BackendSettingsettingInSettings (BackendSettings &settings, BackendOption option, const QString &userOptionName=QString())
SOPRANO_EXPORT BackendSettingsettingInSettings (BackendSettings &settings, const QString &userOptionName)
SOPRANO_EXPORT BackendSetting settingInSettings (const BackendSettings &settings, BackendOption option, const QString &userOptionName=QString())
SOPRANO_EXPORT BackendSetting settingInSettings (const BackendSettings &settings, const QString &userOptionName=QString())
SOPRANO_EXPORT QVariant valueInSettings (const BackendSettings &settings, BackendOption option, const QString &userOptionName=QString())
SOPRANO_EXPORT QVariant valueInSettings (const BackendSettings &settings, const QString &userOptionName, const QVariant &defaultValue=QVariant())
SOPRANO_EXPORT QVariant valueInSettingsWithDefault (const BackendSettings &settings, BackendOption option, const QVariant &defaultValue)

Detailed Description

Wraps one setting for Model creation.

A BackendSetting consists of an option type and an option value. The option type can either be a predefined value from Soprano::BackendOption or a user defined string value that depends on the Backend implementation. In the latter case option has to be set to Soprano::BackendOptionUser.

Author
Sebastian Trueg trueg.nosp@m.@kde.nosp@m..org
See also
Backend::createModel()
BackendSettings

Definition at line 52 of file backend.h.

Constructor & Destructor Documentation

◆ BackendSetting() [1/5]

Soprano::BackendSetting::BackendSetting ( )

Create an empty setting.

See also
Soprano::BackendOptionNone

◆ BackendSetting() [2/5]

Soprano::BackendSetting::BackendSetting ( BackendOption option)

Create a boolean setting with a default true value.

◆ BackendSetting() [3/5]

Soprano::BackendSetting::BackendSetting ( BackendOption s,
const QVariant & value_ )

Create a standard setting with option s and value value_.

◆ BackendSetting() [4/5]

Soprano::BackendSetting::BackendSetting ( const QString & userOption,
const QVariant & value_ )

Create a user setting with user option name userOption and value value_.

◆ BackendSetting() [5/5]

Soprano::BackendSetting::BackendSetting ( const BackendSetting & other)

Copy constructor.

◆ ~BackendSetting()

Soprano::BackendSetting::~BackendSetting ( )

Destructor.

Member Function Documentation

◆ operator=()

BackendSetting & Soprano::BackendSetting::operator= ( const BackendSetting & other)

Copy operator.

◆ option()

BackendOption Soprano::BackendSetting::option ( ) const

The option that this setting sets. If Soprano::BackendOptionUser the option is identified by userOptionName().

◆ userOptionName()

QString Soprano::BackendSetting::userOptionName ( ) const

The name of the user option if option() is Soprano::BackendOptionUser.

◆ value()

QVariant Soprano::BackendSetting::value ( ) const

The value of the setting.

◆ setValue()

void Soprano::BackendSetting::setValue ( const QVariant & value)

Set the value of the Setting.

◆ isOptionInSettings()

SOPRANO_EXPORT bool isOptionInSettings ( const BackendSettings & settings,
BackendOption option,
const QString & userOptionName = QString() )
related

Check if a certain option is defined in a list of BackendSettings.

Parameters
settingsThe list to check.
optionThe option to check.
userOptionNameIf option is Soprano::BackendOptionUser, this defines the user option to be checked.
Returns
true if the option is defined.
Since
2.2

◆ settingInSettings() [1/4]

SOPRANO_EXPORT BackendSetting & settingInSettings ( BackendSettings & settings,
BackendOption option,
const QString & userOptionName = QString() )
related

Get a setting from the set, allowing to modify it.

Parameters
settingsThe list to check.
optionThe option to extract.
userOptionNameIf option is Soprano::BackendOptionUser, this defines the user option to be extracted.
Returns
The extracted setting. An empty setting is added to settings in case the option is not found in settings.
Since
2.2

◆ settingInSettings() [2/4]

SOPRANO_EXPORT BackendSetting & settingInSettings ( BackendSettings & settings,
const QString & userOptionName )
related

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
settingsThe list to check.
userOptionNameThe user option to be extracted.
Returns
The extracted setting. An empty setting is added to settings in case the option is not found in settings.
Since
2.4

◆ settingInSettings() [3/4]

SOPRANO_EXPORT BackendSetting settingInSettings ( const BackendSettings & settings,
BackendOption option,
const QString & userOptionName = QString() )
related

Get a setting from the set.

Parameters
settingsThe list to check.
optionThe option to extract.
userOptionNameIf option is Soprano::BackendOptionUser, this defines the user option to be extracted.
Returns
The extracted setting. If the setting is not found an empty BackendSetting is returned.
Since
2.4

◆ settingInSettings() [4/4]

SOPRANO_EXPORT BackendSetting settingInSettings ( const BackendSettings & settings,
const QString & userOptionName = QString() )
related

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
settingsThe list to check.
userOptionNameThe user option to be extracted.
Returns
The extracted setting. If the setting is not found an empty BackendSetting is returned.
Since
2.4

◆ valueInSettings() [1/2]

SOPRANO_EXPORT QVariant valueInSettings ( const BackendSettings & settings,
BackendOption option,
const QString & userOptionName = QString() )
related

Retrieve the value of an option.

Parameters
settingsThe list to check.
optionThe option to retrieve.
userOptionNameIf option is Soprano::BackendOptionUser, this defines the user option to be retrieved.
Returns
The value of the specified option or an invalid variant if the set does not contain the option.
Since
2.2

◆ valueInSettings() [2/2]

SOPRANO_EXPORT QVariant valueInSettings ( const BackendSettings & settings,
const QString & userOptionName,
const QVariant & defaultValue = QVariant() )
related

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
settingsThe list to check.
userOptionNameThe user option to retrieve.
defaultValueThe default to use if option is not part of settings
Returns
The value of the specified option or default if settings does not contain the option.
Since
2.4

◆ valueInSettingsWithDefault()

SOPRANO_EXPORT QVariant valueInSettingsWithDefault ( const BackendSettings & settings,
BackendOption option,
const QVariant & defaultValue )
related

Retrieve the value of an option with a fallback default.

Parameters
settingsThe list to check.
optionThe option to retrieve.
defaultValueThe default to use if option is not part of settings
Returns
The value of the specified option or default if settings does not contain the option.
Since
2.4

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