#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 () | |
BackendSetting & | operator= (const BackendSetting &other) |
BackendOption | option () const |
QString | userOptionName () const |
QVariant | value () const |
void | setValue (const QVariant &value) |
Related Functions | |
(Note that these are not member functions.) | |
SOPRANO_EXPORT bool | isOptionInSettings (const BackendSettings &settings, BackendOption option, const QString &userOptionName=QString()) |
SOPRANO_EXPORT BackendSetting & | settingInSettings (BackendSettings &settings, BackendOption option, const QString &userOptionName=QString()) |
SOPRANO_EXPORT QVariant | valueInSettings (const BackendSettings &settings, BackendOption option, const QString &userOptionName=QString()) |
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.
Definition at line 52 of file backend.h.
Soprano::BackendSetting::BackendSetting | ( | ) |
Create an empty setting.
Soprano::BackendSetting::BackendSetting | ( | BackendOption | option | ) |
Create a boolean setting with a default true value.
Soprano::BackendSetting::BackendSetting | ( | BackendOption | s, | |
const QVariant & | value_ | |||
) |
Create a standard setting with option s
and value value_
.
Create a user setting with user option name userOption
and value value_
.
Soprano::BackendSetting::BackendSetting | ( | const BackendSetting & | other | ) |
Copy constructor.
Soprano::BackendSetting::~BackendSetting | ( | ) |
Destructor.
BackendSetting& Soprano::BackendSetting::operator= | ( | const BackendSetting & | other | ) |
Copy operator.
BackendOption Soprano::BackendSetting::option | ( | ) | const |
The option that this setting sets. If Soprano::BackendOptionUser the option is identified by userOptionName().
QString Soprano::BackendSetting::userOptionName | ( | ) | const |
The name of the user option if option() is Soprano::BackendOptionUser.
QVariant Soprano::BackendSetting::value | ( | ) | const |
The value of the setting.
void Soprano::BackendSetting::setValue | ( | const QVariant & | value | ) |
Set the value of the Setting.
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.
settings | The list to check. | |
option | The option to check. | |
userOptionName | If option is Soprano::BackendOptionUser, this defines the user option to be checked. |
true
if the option is defined.SOPRANO_EXPORT BackendSetting & settingInSettings | ( | BackendSettings & | settings, | |
BackendOption | option, | |||
const QString & | userOptionName = QString() | |||
) | [related] |
Get a setting from the set, allowing to modify it.
settings | The list to check. | |
option | The option to extract. | |
userOptionName | If option is Soprano::BackendOptionUser, this defines the user option to be extracted. |
SOPRANO_EXPORT QVariant valueInSettings | ( | const BackendSettings & | settings, | |
BackendOption | option, | |||
const QString & | userOptionName = QString() | |||
) | [related] |
Retrieve the value of an option.
settings | The list to check. | |
option | The option to retrieve. | |
userOptionName | If option is Soprano::BackendOptionUser, this defines the user option to be retrieved. |