Poco::OSP

class Preferences

Library: OSP
Package: PreferencesService
Header: Poco/OSP/Preferences.h

Description

Preferences objects are used by bundles to access their stored preferences.

Inheritance

Direct Base Classes: Poco::Util::AbstractConfiguration

All Base Classes: Poco::RefCountedObject, Poco::Util::AbstractConfiguration

Member Summary

Member Functions: enumerate, getRaw, removeRaw, save, setRaw

Inherited Functions: createView, duplicate, enableEvents, enumerate, eventsEnabled, expand, getBool, getDouble, getInt, getInt64, getRaw, getRawString, getString, getUInt, getUInt64, has, hasOption, hasProperty, keys, parseBool, parseInt, parseInt64, parseUInt, parseUInt64, referenceCount, release, remove, removeRaw, setBool, setDouble, setInt, setInt64, setRaw, setRawWithEvent, setString, setUInt, setUInt64

Types

ConstPtr

typedef const Ptr ConstPtr;

Ptr

typedef Poco::AutoPtr < Preferences > Ptr;

Constructors

Preferences

Preferences(
    const std::string & path
);

Creates the Preferences, using the given path.

Destructor

~Preferences protected virtual

~Preferences();

Member Functions

save

void save();

Saves the preferences to the file system.

enumerate protected virtual

void enumerate(
    const std::string & key,
    Keys & range
) const;

getRaw protected virtual

bool getRaw(
    const std::string & key,
    std::string & value
) const;

removeRaw protected virtual

void removeRaw(
    const std::string & key
);

setRaw protected virtual

void setRaw(
    const std::string & key,
    const std::string & value
);

Variables

propertyChanged

Poco::BasicEvent < PreferencesEvent > propertyChanged;

Fired whenever a property is about to be changed.