File Information
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: createLocalView, createView, duplicate, enableEvents, enumerate, eventsEnabled, expand, getBool, getDouble, getInt, getInt16, getInt32, getInt64, getRaw, getRawString, getString, getUInt, getUInt16, getUInt32, getUInt64, has, hasOption, hasProperty, keys, parseBool, parseInt, parseInt16, parseInt64, parseUInt, parseUInt16, parseUInt64, referenceCount, release, remove, removeRaw, setBool, setDouble, setInt, setInt16, setInt32, setInt64, setRaw, setRawWithEvent, setString, setUInt, setUInt16, setUInt32, setUInt64
Types Aliases
ConstPtr
Ptr
using Ptr = Poco::AutoPtr < Preferences >;
Constructors
Preferences
Preferences(
const std::string & path
);
Creates the Preferences, using the given path.
Destructor
~Preferences
~Preferences();
Member Functions
save
void save();
Saves the preferences to the file system.
enumerate
void enumerate(
const std::string & key,
Keys & range
) const;
getRaw
bool getRaw(
const std::string & key,
std::string & value
) const;
removeRaw
void removeRaw(
const std::string & key
);
setRaw
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.