ObjFW  Check-in [b5afddbea4]

Overview
Comment:OFINICategory: Documentation fixes
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: b5afddbea478a0ef450b07771105045442925675c4a1b95999790d3992004c7f
User & Date: js on 2021-02-28 23:42:36
Other Links: manifest | tags
Context
2021-03-07
01:53
Remove useless *Value from selector names check-in: b0b5eff396 user: js tags: trunk
2021-02-28
23:42
OFINICategory: Documentation fixes check-in: b5afddbea4 user: js tags: trunk
23:25
OFWindowsRegistryKey: More accurate method names check-in: 7c83502291 user: js tags: trunk
Changes

Modified src/OFINICategory.h from [f40b53851b] to [30849cd33f].

40
41
42
43
44
45
46
47
48


49
50
51
52
53
54
55
56
57
58
59
60


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75


76
77
78
79
80
81
82
83
84
85
86
87
88
89
90


91
92
93
94
95
96
97
98
99
100
101
102
103
104
105


106
107
108
109
110
111
112
113
114
115
116
117
118
119
120


121
122
123
124
125
126
127
40
41
42
43
44
45
46


47
48
49
50
51
52
53
54
55
56
57
58


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88


89
90
91
92
93
94
95
96
97
98
99
100
101
102
103


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118


119
120
121
122
123
124
125
126
127







-
-
+
+










-
-
+
+













-
-
+
+













-
-
+
+













-
-
+
+













-
-
+
+








- (instancetype)init OF_UNAVAILABLE;

/**
 * @brief Returns the string value for the specified key, or `nil` if it does
 *	  not exist.
 *
 * If the specified key is a multi-key (see @ref arrayForKey:), the value of
 * the first key/value pair found is returned.
 * If the specified key is a multi-key (see @ref stringValuesForKey:), the value
 * of the first key/value pair found is returned.
 *
 * @param key The key for which the string value should be returned
 * @return The string value for the specified key, or `nil` if it does not exist
 */
- (nullable OFString *)stringValueForKey: (OFString *)key;

/**
 * @brief Returns the string value for the specified key or the specified
 *	  default value if it does not exist.
 *
 * If the specified key is a multi-key (see @ref arrayForKey:), the value of
 * the first key/value pair found is returned.
 * If the specified key is a multi-key (see @ref stringValuesForKey:), the value
 * of the first key/value pair found is returned.
 *
 * @param key The key for which the string value should be returned
 * @param defaultValue The value to return if the key does not exist
 * @return The string value for the specified key or the specified default
 *	   value if it does not exist
 */
- (nullable OFString *)stringValueForKey: (OFString *)key
			    defaultValue: (nullable OFString *)defaultValue;

/**
 * @brief Returns the long long value for the specified key or the specified
 *	  default value if it does not exist.
 *
 * If the specified key is a multi-key (see @ref arrayForKey:), the value of
 * the first key/value pair found is returned.
 * If the specified key is a multi-key (see @ref stringValuesForKey:), the value
 * of the first key/value pair found is returned.
 *
 * @param key The key for which the long long value should be returned
 * @param defaultValue The value to return if the key does not exist
 * @return The long long value for the specified key or the specified default
 *	   value if it does not exist
 */
- (long long)longLongValueForKey: (OFString *)key
		    defaultValue: (long long)defaultValue;

/**
 * @brief Returns the bool value for the specified key or the specified default
 *	  value if it does not exist.
 *
 * If the specified key is a multi-key (see @ref arrayForKey:), the value of
 * the first key/value pair found is returned.
 * If the specified key is a multi-key (see @ref stringValuesForKey:), the value
 * of the first key/value pair found is returned.
 *
 * @param key The key for which the bool value should be returned
 * @param defaultValue The value to return if the key does not exist
 * @return The bool value for the specified key or the specified default value
 *	   if it does not exist
 */
- (bool)boolValueForKey: (OFString *)key
	   defaultValue: (bool)defaultValue;

/**
 * @brief Returns the float value for the specified key or the specified
 *	  default value if it does not exist.
 *
 * If the specified key is a multi-key (see @ref arrayForKey:), the value of
 * the first key/value pair found is returned.
 * If the specified key is a multi-key (see @ref stringValuesForKey:), the value
 * of the first key/value pair found is returned.
 *
 * @param key The key for which the float value should be returned
 * @param defaultValue The value to return if the key does not exist
 * @return The float value for the specified key or the specified default value
 *	   if it does not exist
 */
- (float)floatValueForKey: (OFString *)key
	     defaultValue: (float)defaultValue;

/**
 * @brief Returns the double value for the specified key or the specified
 *	  default value if it does not exist.
 *
 * If the specified key is a multi-key (see @ref arrayForKey:), the value of
 * the first key/value pair found is returned.
 * If the specified key is a multi-key (see @ref stringValuesForKey:), the value
 * of the first key/value pair found is returned.
 *
 * @param key The key for which the double value should be returned
 * @param defaultValue The value to return if the key does not exist
 * @return The double value for the specified key or the specified default
 *	   value if it does not exist
 */
- (double)doubleValueForKey: (OFString *)key
139
140
141
142
143
144
145
146
147


148
149
150
151
152
153
154
155
156

157
158
159


160
161
162
163
164
165
166
139
140
141
142
143
144
145


146
147
148
149
150
151
152
153
154
155

156
157


158
159
160
161
162
163
164
165
166







-
-
+
+








-
+

-
-
+
+







 *	   exist
 */
- (OFArray OF_GENERIC(OFString *) *)stringValuesForKey: (OFString *)key;

/**
 * @brief Sets the value of the specified key to the specified string.
 *
 * If the specified key is a multi-key (see @ref arrayForKey:), the value of
 * the first key/value pair found is changed.
 * If the specified key is a multi-key (see @ref stringValuesForKey:), the
 * value of the first key/value pair found is changed.
 *
 * @param stringValue The string value to which the key should be set
 * @param key The key for which the new value should be set
 */
- (void)setStringValue: (OFString *)stringValue
		forKey: (OFString *)key;

/**
 * @brief Sets the value of the specified key to the specified integer.
 * @brief Sets the value of the specified key to the specified long long.
 *
 * If the specified key is a multi-key (see @ref arrayForKey:), the value of
 * the first key/value pair found is changed.
 * If the specified key is a multi-key (see @ref stringValuesForKey:), the value
 * of the first key/value pair found is changed.
 *
 * @param longLongValue The long long value to which the key should be set
 * @param key The key for which the new value should be set
 */
- (void)setLongLongValue: (long long)longLongValue
		  forKey: (OFString *)key;

187
188
189
190
191
192
193
194
195


196
197
198
199
200
201
202
187
188
189
190
191
192
193


194
195
196
197
198
199
200
201
202







-
-
+
+







 */
- (void)setFloatValue: (float)floatValue
	       forKey: (OFString *)key;

/**
 * @brief Sets the value of the specified key to the specified double.
 *
 * If the specified key is a multi-key (see @ref stringValuesForKey:), the
 * value of the first key/value pair found is changed.
 * If the specified key is a multi-key (see @ref stringValuesForKey:), the value
 * of the first key/value pair found is changed.
 *
 * @param doubleValue The double value to which the key should be set
 * @param key The key for which the new value should be set
 */
- (void)setDoubleValue: (double)doubleValue
		forKey: (OFString *)key;

214
215
216
217
218
219
220
221
222


223
224
225
226
227
228
229
214
215
216
217
218
219
220


221
222
223
224
225
226
227
228
229







-
-
+
+







 */
- (void)setStringValues: (OFArray OF_GENERIC(OFString *) *)stringValues
		 forKey: (OFString *)key;

/**
 * @brief Removes the value for the specified key
 *
 * If the specified key is a multi-key (see @ref arrayForKey:), all key/value
 * pairs matching the specified key are removed.
 * If the specified key is a multi-key (see @ref stringValuesForKey:), all
 * key/value pairs matching the specified key are removed.
 *
 * @param key The key of the value to remove
 */
- (void)removeValueForKey: (OFString *)key;
@end

OF_ASSUME_NONNULL_END