Scribus
Open source desktop publishing at your fingertips
Public Slots | Public Member Functions | List of all members
PreferencesAPI Class Reference
Inheritance diagram for PreferencesAPI:
Inheritance graph
[legend]
Collaboration diagram for PreferencesAPI:
Collaboration graph
[legend]

Public Slots

bool contains (const QString &context, const QString &key)
 
QString getString (const QString &context, const QString &key)
 
void setString (const QString &context, const QString &, const QString &value)
 
int getInt (const QString &context, const QString &key)
 
void setInt (const QString &context, const QString &key, int value)
 
double getDouble (const QString &context, const QString &key)
 
void setDouble (const QString &context, const QString &key, double value)
 
bool getBool (const QString &context, const QString &key)
 
void setBool (const QString &context, const QString &key, bool value)
 

Public Member Functions

PrefsContext * prefs (const QString &context)
 

Member Function Documentation

bool PreferencesAPI::contains ( const QString &  context,
const QString &  key 
)
slot

Scripter.preferences.contains(context, key) context is a string of a plug-in context, e.g. "scripter" key is a string

Use this to check if a preference is currently set.

bool PreferencesAPI::getBool ( const QString &  context,
const QString &  key 
)
slot

Scripter.preferences.getBool(context, key) context is string key is string returns value of key as bool or False if key not found

Use ->Scripter.preferences.contains(context, key) if you don't know if the key exists.

double PreferencesAPI::getDouble ( const QString &  context,
const QString &  key 
)
slot

Scripter.preferences.getDouble(context, key) context is string key is string returns value of key as double of -1 if key not found

int PreferencesAPI::getInt ( const QString &  context,
const QString &  key 
)
slot

Scripter.preferences.getInt(context, key) context is string key is string returns value of key as int or -1 if key not found

QString PreferencesAPI::getString ( const QString &  context,
const QString &  key 
)
slot

Scripter.preferences.getString(context, key) context is a string key is a string returns value of key as string or "" if key not found

void PreferencesAPI::setBool ( const QString &  context,
const QString &  key,
bool  value 
)
slot

Scripter.preferences.setBool(context, key, value) context ist string key is string value is bool

void PreferencesAPI::setDouble ( const QString &  context,
const QString &  key,
double  value 
)
slot

Scripter.preferences.setDouble(context, key, value) context is string key is string value is double

void PreferencesAPI::setInt ( const QString &  context,
const QString &  key,
int  value 
)
slot

Scripter.preferences.setInt(context, key, value) context is string key is string value is int

void PreferencesAPI::setString ( const QString &  context,
const QString &  key,
const QString &  value 
)
slot

Scripter.preferences.setString(context, key, value) context is string key is string value is string

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