A class for storing and retrieving settings. More...

#import <ObjFW/OFSettings.h>

Inheritance diagram for OFSettings:

Instance Methods
(id)	- initWithApplicationName:
	Initializes an already allocated OFSettings instance with the specified application name. More...

(OFString *)	- applicationName
	Returns the name of the application whose settings are accessed by the instance. More...

(void)	- setString:forPath:
	Sets the specified path to the specified string. More...

(void)	- setInteger:forPath:
	Sets the specified path to the specified integer. More...

(void)	- setBool:forPath:
	Sets the specified path to the specified bool. More...

(void)	- setFloat:forPath:
	Sets the specified path to the specified float. More...

(void)	- setDouble:forPath:
	Sets the specified path to the specified double. More...

(void)	- setArray:forPath:
	Sets the specified path to the specified array of strings. More...

(nullable OFString *)	- stringForPath:
	Returns the string for the specified path, or nil if the path does not exist. More...

(nullable OFString *)	- stringForPath:defaultValue:
	Returns the string for the specified path, or the default value if the path does not exist. More...

(intmax_t)	- integerForPath:defaultValue:
	Returns the integer for the specified path, or the default value if the path does not exist. More...

(bool)	- boolForPath:defaultValue:
	Returns the bool for the specified path, or the default value if the path does not exist. More...

(float)	- floatForPath:defaultValue:
	Returns the float for the specified path, or the default value if the path does not exist. More...

(double)	- doubleForPath:defaultValue:
	Returns the double for the specified path, or the default value if the path does not exist. More...

(OFArray OF_GENERIC(OFString *)	- arrayForPath:
	Returns the array of strings for the specified path, or an empty array if the path does not exist. More...

(void)	- removeValueForPath:
	Removes the value for the specified path. More...

(void)	- save
	Saves the settings to disk. More...

Instance Methods inherited from OFObject
(id)	- init
	Initializes an already allocated object. More...

(OFString *)	- className
	Returns the name of the object's class. More...

(OFString *)	- description
	Returns a description for the object. More...

(void *)	- allocMemoryWithSize:
	Allocates memory and stores it in the object's memory pool. More...

(void *)	- allocMemoryWithSize:count:
	Allocates memory for the specified number of items and stores it in the object's memory pool. More...

(nullable void *)	- resizeMemory:size:
	Resizes memory in the object's memory pool to the specified size. More...

(nullable void *)	- resizeMemory:size:count:
	Resizes memory in the object's memory pool to the specific number of items of the specified size. More...

(void)	- freeMemory:
	Frees allocated memory and removes it from the object's memory pool. More...

(void)	- dealloc
	Deallocates the object. More...

(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay. More...

(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay. More...

(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay. More...

(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread. More...

(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object. More...

(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects. More...

(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread. More...

(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object. More...

(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects. More...

(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay. More...

(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay. More...

(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay. More...

(nullable id)	- forwardingTargetForSelector:
	This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded. More...

(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver. More...

(OFString *)	- stringBySerializing
	Creates a string by serializing the receiver. More...

Instance Methods inherited from <OFObject>
(bool)	- isKindOfClass:
	Returns a boolean whether the object of the specified kind. More...

(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class. More...

(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector. More...

(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector. More...

(nullable const char *)	- typeEncodingForSelector:
	Returns the type encoding for the specified selector. More...

(nullable id)	- performSelector:
	Performs the specified selector. More...

(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object. More...

(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects. More...

(bool)	- isEqual:
	Checks two objects for equality. More...

(uint32_t)	- hash
	Calculates a hash for the object. More...

(id)	- retain
	Increases the retain count. More...

(unsigned int)	- retainCount
	Returns the retain count. More...

(void)	- release
	Decreases the retain count. More...

(id)	- autorelease
	Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack. More...

(id)	- self
	Returns the receiver. More...

(bool)	- isProxy
	Returns whether the object is a proxy object. More...

Class Methods
(instancetype)	+ settingsWithApplicationName:
	Create a new OFSettings instance for the application with the specified name. More...

Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime. More...

(void)	+ unload
	A method which is called when the class is unloaded from the runtime. More...

(void)	+ initialize
	A method which is called the moment before the first call to the class is being made. More...

(id)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object. More...

(id)	+ new
	Allocates memory for a new instance and calls init on it. More...

(Class)	+ class
	Returns the class. More...

(OFString *)	+ className
	Returns the name of the class as a string. More...

(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class. More...

(Class)	+ superclass
	Returns the superclass of the class. More...

(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector. More...

(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol. More...

(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector. More...

(nullable const char *)	+ typeEncodingForInstanceSelector:
	Returns the type encoding of the instance method for the specified selector. More...

(OFString *)	+ description
	Returns a description for the class, which is usually the class name. More...

(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class. More...

(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class. More...

(nullable IMP)	+ replaceClassMethod:withImplementation:typeEncoding:
	Replaces or adds a class method. More...

(nullable IMP)	+ replaceInstanceMethod:withImplementation:typeEncoding:
	Replaces or adds an instance method. More...

(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver. More...

(bool)	+ resolveClassMethod:
	Try to resolve the specified class method. More...

(bool)	+ resolveInstanceMethod:
	Try to resolve the specified instance method. More...

(id)	+ copy
	Returns the class. More...

Detailed Description

A class for storing and retrieving settings.

Paths are delimited by dots, for example category.subcategory.key.

Note: The behaviour when accessing a path with a different type than it has been accessed with before is undefined! If you want to change the type for a path, remove it and then set it with the new type.

Method Documentation

- (OFString*) applicationName

Returns the name of the application whose settings are accessed by the instance.

Returns: The name of the application whose settings are accessed by the instance

- (OFArray *) arrayForPath: (OFString*) path

Returns the array of strings for the specified path, or an empty array if the path does not exist.

Parameters

path	The path for which the array of strings should be returned

Returns: The array of strings of the specified path

- (bool) boolForPath:	(OFString*)	path
defaultValue:	(bool)	defaultValue

Returns the bool for the specified path, or the default value if the path does not exist.

Parameters

path	The path for which the bool value should be returned
defaultValue	The default value to return if the path does not exist

Returns: The bool value of the specified path

- (double) doubleForPath:	(OFString*)	path
defaultValue:	(double)	defaultValue

Returns the double for the specified path, or the default value if the path does not exist.

Parameters

path	The path for which the double value should be returned
defaultValue	The default value to return if the path does not exist

Returns: The double value of the specified path

- (float) floatForPath:	(OFString*)	path
defaultValue:	(float)	defaultValue

Returns the float for the specified path, or the default value if the path does not exist.

Parameters

path	The path for which the float value should be returned
defaultValue	The default value to return if the path does not exist

Returns: The float value of the specified path

- (id) initWithApplicationName: (OFString*) applicationName

Initializes an already allocated OFSettings instance with the specified application name.

Parameters

applicationName The name of the application whose settings should be accessed

Returns: An initialized OFSettings instance

- (intmax_t) integerForPath:	(OFString*)	path
defaultValue:	(intmax_t)	defaultValue

Returns the integer for the specified path, or the default value if the path does not exist.

Parameters

path	The path for which the integer value should be returned
defaultValue	The default value to return if the path does not exist

Returns: The integer value of the specified path

- (void) removeValueForPath: (OFString*) path

Removes the value for the specified path.

Parameters

path	The path for which the value should be removed

- (void) save

Saves the settings to disk.

Warning: Some backends might save the settings instantly, others might not save them before calling this method for performance reasons. You should always call this method after doing a bunch of changes, no matter which backend is used!

- (void) setArray:	(OFArray OF_GENERIC(OFString ))	array
forPath:	(OFString *)	path

Sets the specified path to the specified array of strings.

Parameters

array	The array of strings to set
path	The path to store the array of strings at

- (void) setBool:	(bool)	bool_
forPath:	(OFString*)	path

Sets the specified path to the specified bool.

Parameters

bool_	The bool to set
path	The path to store the bool at

- (void) setDouble:	(double)	double_
forPath:	(OFString*)	path

Sets the specified path to the specified double.

Parameters

double_	The double to set
path	The path to store the double at

- (void) setFloat:	(float)	float_
forPath:	(OFString*)	path

Sets the specified path to the specified float.

Parameters

float_	The float to set
path	The path to store the float at

- (void) setInteger:	(intmax_t)	integer
forPath:	(OFString*)	path

Sets the specified path to the specified integer.

Parameters

integer	The integer to set
path	The path to store the integer at

- (void) setString:	(OFString*)	string
forPath:	(OFString*)	path

Sets the specified path to the specified string.

Parameters

string	The string to set
path	The path to store the string at

+ (instancetype) settingsWithApplicationName: (OFString*) applicationName

Create a new OFSettings instance for the application with the specified name.

Parameters

applicationName The name of the application whose settings should be accessed

Returns: A new, autoreleased OFSettings instance

- (OFString *) stringForPath: (OFString*) path

Returns the string for the specified path, or nil if the path does not exist.

Parameters

path	The path for which the string value should be returned

Returns: The string value of the specified path

- (nullable OFString*) stringForPath:	(OFString *)	path
defaultValue:	(nullable OFString *)	defaultValue

Returns the string for the specified path, or the default value if the path does not exist.

Parameters

path	The path for which the string value should be returned
defaultValue	The default value to return if the path does not exist

Returns: The string value of the specified path

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

src/OFSettings.h
src/OFSettings.m

Instance Methods

Class Methods

Detailed Description

Method Documentation