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

#include <ObjFW/OFSettings.h>

Inheritance diagram for OFSettings:

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

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

(void)	- setLongLong:forPath:
	Sets the specified path to the specified long long.

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

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

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

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

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

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

(long long)	- longLongForPath:defaultValue:
	Returns the long long for the specified path, or the default value if the path does not exist.

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

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

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

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

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

(void)	- save
	Saves the settings to disk.

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

(nullable OFMethodSignature *)	- methodSignatureForSelector:
	Returns the method signature for the specified selector.

(void)	- dealloc
	Deallocates the object.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

(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.

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

Instance Methods inherited from <OFObject>
(unsigned long)	- hash
	Returns a hash for the object.

(unsigned int)	- retainCount
	Returns the retain count.

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

(bool)	- isKindOfClass:
	Returns a boolean whether the object is of the specified kind.

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

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

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

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

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

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

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

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

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

(instancetype)	- retain
	Increases the retain count.

(void)	- release
	Decreases the retain count.

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

(instancetype)	- self
	Returns the receiver.

(bool)	- allowsWeakReference
	Returns whether the object allows a weak reference.

(bool)	- retainWeakReference
	Retain a weak reference to this object.

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

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

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

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

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

(Class)	+ class
	Returns the class.

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

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

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

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

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

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

(nullable OFMethodSignature *)	+ instanceMethodSignatureForSelector:
	Returns the method signature of the instance method for the specified selector.

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

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

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

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

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

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

(id)	+ copy
	Returns the class.

Properties
OFString *	applicationName
	The name of the application whose settings are accessed by the instance.

Properties inherited from OFObject
OFString *	className
	The name of the object's class.

OFString *	description
	A description for the object.

Detailed Description

A class for storing and retrieving settings.

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

Note: The behavior 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

◆ boolForPath:defaultValue:

- (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 should be returned
defaultValue	The default value to return if the path does not exist

Returns: The bool of the specified path

◆ doubleForPath:defaultValue:

- (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 should be returned
defaultValue	The default value to return if the path does not exist

Returns: The double of the specified path

◆ floatForPath:defaultValue:

- (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 should be returned
defaultValue	The default value to return if the path does not exist

Returns: The float of the specified path

◆ initWithApplicationName:

- (instancetype) 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

◆ longLongForPath:defaultValue:

- (long long) longLongForPath:		(OFString *)	path
defaultValue:		(long long)	defaultValue

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

Parameters

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

Returns: The long long of the specified path

◆ removeValueForPath:

- (void) removeValueForPath: (OFString *) path

Removes the value for the specified path.

Parameters

path	The path for which the value should be removed

◆ save

- (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!

◆ setBool:forPath:

- (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

◆ setDouble:forPath:

- (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

◆ setFloat:forPath:

- (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

◆ setLongLong:forPath:

- (void) setLongLong:		(long long)	longLong
forPath:		(OFString *)	path

Sets the specified path to the specified long long.

Parameters

longLong	The long long to set
path	The path to store the long long at

◆ setString:forPath:

- (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

◆ setStringArray:forPath:

- (void) setStringArray:		(OFArray *)	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 string at

◆ settingsWithApplicationName:

+ (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

◆ stringArrayForPath:

- (OFArray *) stringArrayForPath: (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 string values of the specified path

◆ stringForPath:

- (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 should be returned

Returns: The string of the specified path

◆ stringForPath:defaultValue:

- (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 should be returned
defaultValue	The default value to return if the path does not exist

Returns: The string 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

Properties

Detailed Description

Method Documentation

◆ boolForPath:defaultValue:

◆ doubleForPath:defaultValue:

◆ floatForPath:defaultValue:

◆ initWithApplicationName:

◆ longLongForPath:defaultValue:

◆ removeValueForPath:

◆ save

◆ setBool:forPath:

◆ setDouble:forPath:

◆ setFloat:forPath:

◆ setLongLong:forPath:

◆ setString:forPath:

◆ setStringArray:forPath:

◆ settingsWithApplicationName:

◆ stringArrayForPath:

◆ stringForPath:

◆ stringForPath:defaultValue: