Class sh::scripting::api::ApiSetting

class sh::scripting::api::ApiSetting : public sh::settings::Setting

Public Functions

ApiSetting(QString name, QString description, sh::settings::SettingGroup group, bool isAdvancedSetting, bool isGlobal, bool isPerFileview)

QString name()

Gets the internal name.

QString description()

Gets the description text.

sh::settings::SettingGroup group()

Gets the group;.

bool isAdvancedSetting()

Is this an advanced setting?

void setValue(QString value)

Called from Shallot core when the value was set (for a not-per-fileview setting).

void setValue(sh::ui::FileView *filelist, QString value)

Called from Shallot core when the value was set (for a per-fileview setting).

QString getValue(sh::ui::FileView *filelist)

Get the currently set value.

bool isGlobal()

Does this setting apply globally or just for a certain subtree of nodes?

bool isPerFileview()

Does this setting apply for each fileview individually or for the complete main window?

QString valueDescription(QString value)

Gets a human readable description text for a value.

Public Members

std::function<void(QString)> _setValue1

std::function<void(int, QString)> _setValue2

std::function<QString(int)> _getValue

std::function<QString(QString)> _valueDescription

QString _name

QString _description

sh::settings::SettingGroup _group

bool _isAdvancedSetting

bool _isGlobal

bool _isPerFileview

Public Static Functions

QString getGroupDescription(int g)

Low-level function which gets the description text of a group.