Lines Matching full:var

706 @deftypefun void config_init (@w{config_t * @var{config}})
707 @deftypefunx void config_destroy (@w{config_t * @var{config}})
709 These functions initialize and destroy the configuration object @var{config}.
712 @var{config} as a new, empty configuration.
714 @code{config_destroy()} destroys the configuration @var{config},
720 @deftypefun void config_clear (@w{config_t * @var{config}})
724 This function clears the configuration @var{config}. All child settings of the
730 @deftypefun int config_read (@w{config_t * @var{config}}, @w{FILE * @var{stream}})
733 @var{stream} into the configuration object @var{config}. It returns
741 @deftypefun int config_read_file (@w{config_t * @var{config}}, @w{const char * @var{filename}})
744 @var{filename} into the configuration object @var{config}. It returns
751 @deftypefun int config_read_string (@w{config_t * @var{config}}, @w{const char * @var{str}})
754 @var{str} into the configuration object @var{config}. It returns
761 @deftypefun void config_write (@w{const config_t * @var{config}}, @w{FILE * @var{stream}})
763 This function writes the configuration @var{config} to the given
764 @var{stream}.
768 @deftypefun int config_write_file (@w{config_t * @var{config}}, @w{const char * @var{filename}})
770 This function writes the configuration @var{config} to the file named
771 @var{filename}. It returns @code{CONFIG_TRUE} on success, or
776 @deftypefun {const char *} config_error_text (@w{const config_t * @var{config}})
777 @deftypefunx {const char *} config_error_file (@w{const config_t * @var{config}})
778 @deftypefunx int config_error_line (@w{const config_t * @var{config}})
792 @deftypefun config_error_t config_error_type (@w{const config_t * @var{config}})
796 functions. The @var{config_error_t} type is an enumeration with the
803 @deftypefun void config_set_include_dir (@w{config_t *@var{config}}, @w{const char *@var{include_di…
804 @deftypefunx {const char *} config_get_include_dir (@w{const config_t *@var{config}})
807 @var{include_dir}, relative to which the files specified in
809 @var{config}. By default, there is no include directory, and all
811 directory. If @var{include_dir} is @code{NULL}, the default behavior
819 configuration @var{config}, or @code{NULL} if none is set.
823 @deftypefun void config_set_include_func (@w{config_include_fn_t @var{func}})
827 Specifies the include function @var{func} to use when processing
828 include directives. If @var{func} is @code{NULL}, the default include function,
835 …har **} func (@w{config_t *@var{config}}, @w{const char *@var{include_dir}}, @w{const char *@var{p…
837 The function receives the configuration @var{config}, the
838 configuration's current include directory @var{include_dir}, the
839 argument to the include directive @var{path}; and a pointer at which
840 to return an error message @var{error}.
850 On failure, the function should return @code{NULL} and set @var{*error} to a
856 of @var{path} if it's an absolute path, or a concatenation of
857 @var{include_dir} and @var{path} if it's a relative path.
882 @deftypefun {unsigned short} config_get_float_precision(@w{config_t *@var{config}})
883 @deftypefunx void config_set_float_precision(@w{config_t *@var{config}}, @w{unsigned short @var{dig…
890 Valid values for @var{digits} range from 0 (no decimals) to about 15
897 @deftypefun int config_get_options (@w{config_t *@var{config}})
898 @deftypefunx void config_set_options (@w{config_t *@var{config}}, @w{int @var{options}})
901 @var{config}. The options affect how configurations are read and
964 @deftypefun int config_get_option (@w{config_t *@var{config}}, @w{int @var{option}})
965 @deftypefunx void config_set_option (@w{config_t *@var{config}}, @w{int @var{option}}, @w{int @var{…
969 These functions get and set the given @var{option} of the configuration
970 @var{config}. The option is enabled if @var{flag} is @code{CONFIG_TRUE} and
978 @deftypefun int config_get_auto_convert (@w{const config_t *@var{config}})
979 @deftypefunx void config_set_auto_convert (@w{config_t *@var{config}}, @w{int @var{flag}})
987 @deftypefun short config_get_default_format (@w{config_t * @var{config}})
988 @deftypefunx void config_set_default_format (@w{config_t * @var{config}}, @w{short @var{format}})
992 @var{config}. If a non-default format has not been set for a setting
999 @deftypefun {unsigned short} config_get_tab_width (@w{const config_t * @var{config}})
1000 @deftypefunx void config_set_tab_width (@w{config_t * @var{config}}, @w{unsigned short @var{width}})
1003 width for the configuration @var{config}. The tab width affects the
1005 stream: each level of nesting is indented by @var{width} spaces, or
1006 by a single tab character if @var{width} is 0. The tab width has no
1013 …fun int config_lookup_int (@w{const config_t * @var{config}}, @w{const char * @var{path}}, @w{int …
1014 …nt config_lookup_int64 (@w{const config_t * @var{config}}, @w{const char * @var{path}}, @w{long lo…
1015 … int config_lookup_float (@w{const config_t * @var{config}}, @w{const char * @var{path}}, @w{doubl…
1016 …nx int config_lookup_bool (@w{const config_t * @var{config}}, @w{const char * @var{path}}, @w{int …
1017 … config_lookup_string (@w{const config_t * @var{config}}, @w{const char * @var{path}}, @w{const ch…
1020 @var{config} specified by the path @var{path}. They store the value of
1021 the setting at @var{value} and return @code{CONFIG_TRUE} on
1024 @var{value} unmodified and return @code{CONFIG_FALSE}.
1033 …n {config_setting_t *} config_lookup (@w{const config_t * @var{config}}, @w{const char * @var{path…
1035 This function locates the setting in the configuration @var{config}
1036 specified by the path @var{path}. It returns a pointer to the
1042 …g_t *} config_setting_lookup (@w{const config_setting_t * @var{setting}}, @w{const char * @var{pat…
1044 This function locates a setting by a path @var{path} relative to
1045 the setting @var{setting}. It returns a pointer to the
1051 @deftypefun int config_setting_get_int (@w{const config_setting_t * @var{setting}})
1052 @deftypefunx {long long} config_setting_get_int64 (@w{const config_setting_t * @var{setting}})
1053 @deftypefunx double config_setting_get_float (@w{const config_setting_t * @var{setting}})
1054 @deftypefunx int config_setting_get_bool (@w{const config_setting_t * @var{setting}})
1055 @deftypefunx {const char *} config_setting_get_string (@w{const config_setting_t * @var{setting}})
1057 These functions return the value of the given @var{setting}. If the
1066 @deftypefun int config_setting_set_int (@w{config_setting_t * @var{setting}}, @w{int @var{value}})
1067 @deftypefunx int config_setting_set_int64 (@w{config_setting_t * @var{setting}}, @w{long long @var{…
1068 @deftypefunx int config_setting_set_float (@w{config_setting_t * @var{setting}}, @w{double @var{val…
1069 @deftypefunx int config_setting_set_bool (@w{config_setting_t * @var{setting}}, @w{int @var{value}})
1070 …funx int config_setting_set_string (@w{config_setting_t * @var{setting}}, @w{const char * @var{val…
1072 These functions set the value of the given @var{setting} to
1073 @var{value}. On success, they return @code{CONFIG_TRUE}. If
1076 of the passed string @var{value}, so it may be subsequently freed or
1081 …etting_lookup_int (@w{const config_setting_t * @var{setting}}, @w{const char * @var{name}}, @w{int…
1082 …g_lookup_int64 (@w{const config_setting_t * @var{setting}}, @w{const char * @var{name}}, @w{long l…
1083 …ng_lookup_float (@w{const config_setting_t * @var{setting}}, @w{const char * @var{name}}, @w{doubl…
1084 …tting_lookup_bool (@w{const config_setting_t * @var{setting}}, @w{const char * @var{name}}, @w{int…
1085 …lookup_string (@w{const config_setting_t * @var{setting}}, @w{const char * @var{name}}, @w{const c…
1088 @var{name} of the setting @var{setting}. They store the value at
1089 @var{value} and return @code{CONFIG_TRUE} on success. If the setting
1091 requested, they leave the data pointed to by @var{value} unmodified
1101 @deftypefun short config_setting_get_format (@w{config_setting_t * @var{setting}})
1102 @deftypefunx int config_setting_set_format (@w{config_setting_t * @var{setting}}, @w{short @var{for…
1104 These functions get and set the external format for the setting @var{setting}.
1109 The @var{format} must be one of the constants
1114 @code{CONFIG_TYPE_INT} and @code{CONFIG_TYPE_INT64}.  If @var{format}
1125 …ing_t *} config_setting_get_member (@w{config_setting_t * @var{setting}}, @w{const char * @var{nam…
1127 This function fetches the child setting named @var{name} from the group
1128 @var{setting}. It returns the requested setting on success, or
1129 @code{NULL} if the setting was not found or if @var{setting} is not a
1134 …t *} config_setting_get_elem (@w{const config_setting_t * @var{setting}}, @w{unsigned int @var{ind…
1136 This function fetches the element at the given index @var{index} in the
1137 setting @var{setting}, which must be an array, list, or group. It returns the
1138 requested setting on success, or @code{NULL} if @var{index} is out of
1139 range or if @var{setting} is not an array, list, or group.
1143 …n int config_setting_get_int_elem (@w{const config_setting_t * @var{setting}}, @w{int @var{index}})
1144 …ng} config_setting_get_int64_elem (@w{const config_setting_t * @var{setting}}, @w{int @var{index}})
1145 …ble config_setting_get_float_elem (@w{const config_setting_t * @var{setting}}, @w{int @var{index}})
1146 … int config_setting_get_bool_elem (@w{const config_setting_t * @var{setting}}, @w{int @var{index}})
1147 …*} config_setting_get_string_elem (@w{const config_setting_t * @var{setting}}, @w{int @var{index}})
1149 These functions return the value at the specified index @var{index} in the
1150 setting @var{setting}. If the setting is not an array or list, or if
1152 @var{index} is out of range, they return 0 or @code{NULL}. Storage for
1159 … config_setting_set_int_elem (@w{config_setting_t * @var{setting}}, @w{int @var{index}}, @w{int @v…
1160 …ig_setting_set_int64_elem (@w{config_setting_t * @var{setting}}, @w{int @var{index}}, @w{long long…
1161 …fig_setting_set_float_elem (@w{config_setting_t * @var{setting}}, @w{int @var{index}}, @w{double @…
1162 …config_setting_set_bool_elem (@w{config_setting_t * @var{setting}}, @w{int @var{index}}, @w{int @v…
1163 …setting_set_string_elem (@w{config_setting_t * @var{setting}}, @w{int @var{index}}, @w{const char …
1165 These functions set the value at the specified index @var{index} in the
1166 setting @var{setting} to @var{value}. If @var{index} is negative, a
1171 value, or if @var{index} is out of range, they return
1173 the passed string @var{value}, so it may be subsequently freed or
1177 …_t *} config_setting_add (@w{config_setting_t * @var{parent}}, @w{const char * @var{name}}, @w{int…
1180 @var{parent}, which must be a group, array, or list. If @var{parent}
1181 is an array or list, the @var{name} parameter is ignored and may be
1185 @var{parent} is not a group, array, or list; or if there is already a
1186 child setting of @var{parent} named @var{name}; or if @var{type} is
1187 invalid. If @var{type} is a scalar type, the new setting will have a
1191 @deftypefun int config_setting_remove (@w{config_setting_t * @var{parent}}, @w{const char * @var{na…
1193 This function removes and destroys the setting named @var{name} from
1194 the parent setting @var{parent}, which must be a group. Any child
1197 The @var{name} parameter can also specify a setting @i{path} relative to 
1198 the provided @var{parent}.
1201 The function returns @code{CONFIG_TRUE} on success. If @var{parent} is
1207 …fun int config_setting_remove_elem (@w{config_setting_t * @var{parent}}, @w{unsigned int @var{inde…
1209 This function removes the child setting at the given index @var{index} from
1210 the setting @var{parent}, which must be a group, list, or array. Any
1214 The function returns @code{CONFIG_TRUE} on success. If @var{parent} is
1215 not a group, list, or array, or if @var{index} is out of range, it returns
1220 @deftypefun {config_setting_t *} config_root_setting (@w{const config_t * @var{config}})
1222 This function, which is implemented as a macro, returns the root setting for the configuration @var…
1226 @deftypefun {const char *} config_setting_name (@w{const config_setting_t * @var{setting}})
1228 This function returns the name of the given @var{setting}, or
1235 @deftypefun {config_setting_t *} config_setting_parent (@w{const config_setting_t * @var{setting}})
1237 This function returns the parent setting of the given @var{setting},
1238 or @code{NULL} if @var{setting} is the root setting.
1242 @deftypefun int config_setting_is_root (@w{const config_setting_t * @var{setting}})
1244 This function returns @code{CONFIG_TRUE} if the given @var{setting} is
1249 @deftypefun int config_setting_index (@w{const config_setting_t * @var{setting}})
1251 This function returns the index of the given @var{setting} within its
1252 parent setting. If @var{setting} is the root setting, this function
1257 @deftypefun int config_setting_length (@w{const config_setting_t * @var{setting}})
1265 @deftypefun int config_setting_type (@w{const config_setting_t * @var{setting}})
1267 This function returns the type of the given @var{setting}. The return
1275 @deftypefun int config_setting_is_group (@w{const config_setting_t * @var{setting}})
1276 @deftypefunx int config_setting_is_array (@w{const config_setting_t * @var{setting}})
1277 @deftypefunx int config_setting_is_list (@w{const config_setting_t * @var{setting}})
1280 the setting @var{setting} is of a given type. They return
1285 @deftypefun int config_setting_is_aggregate (@w{const config_setting_t * @var{setting}})
1286 @deftypefunx int config_setting_is_scalar (@w{const config_setting_t * @var{setting}})
1287 @deftypefunx int config_setting_is_number (@w{const config_setting_t * @var{setting}})
1291 the setting @var{setting} is of an aggregate type (a group, array, or
1299 @deftypefun {const char *} config_setting_source_file (@w{const config_setting_t * @var{setting}})
1302 @var{setting} was read, or NULL if the setting was not read from a
1310 @deftypefun {unsigned int} config_setting_source_line (@w{const config_setting_t * @var{setting}})
1313 stream at which the setting @var{setting} was read, or 0 if no line
1319 @deftypefun void config_set_hook (@w{config_t * @var{config}}, @w{void * @var{hook}})
1320 @deftypefunx {void *} config_get_hook (@w{const config_t * @var{config}})
1331 @deftypefun void config_setting_set_hook (@w{config_setting_t * @var{setting}}, @w{void * @var{hook…
1332 @deftypefunx {void *} config_setting_get_hook (@w{const config_setting_t * @var{setting}})
1344 @deftypefun void config_set_destructor (@w{config_t * @var{config}}, @w{void (* @var{destructor})(v…
1347 This function assigns the destructor function @var{destructor} for the
1348 configuration @var{config}. This function accepts a single @code{void
1375 @deftypemethod SettingTypeException {} SettingTypeException (@w{const Setting &@var{setting}})
1376 …ettingTypeException {} SettingTypeException (@w{const Setting &@var{setting}}, @w{int @var{index}})
1377 …gTypeException {} SettingTypeException (@w{const Setting &@var{setting}}, @w{const char *@var{name…
1379 …t @code{SettingTypeException} objects for the given @var{setting} and/or member @var{index} or @va…
1386 …tFoundException {} SettingNotFoundException (@w{const Setting &@var{setting}}, @w{int @var{index}})
1387 …dException {} SettingNotFoundException (@w{const Setting &@var{setting}}, @w{const char *@var{name…
1388 @deftypemethodx SettingNotFoundException {} SettingNotFoundException (@w{const char *@var{path}})
1390 …SettingTypeException} objects for the given @var{setting} and member @var{index} or @var{name}, or…
1398 …gNameException {} SettingNameException (@w{const Setting &@var{setting}}, @w{const char *@var{name…
1400 …structs a @code{SettingNameExcpetion} object for the given @var{setting} and member name @var{name…
1408 … ParseException {} ParseException (@w{const char *@var{file}}, @w{int @var{line}}, @w{const char *…
1410 …ParseException} object with the given filename @var{file}, line number @var{line}, and error messa…
1450 @deftypemethod Config void read (@w{FILE * @var{stream}})
1451 @deftypemethodx Config void write (@w{FILE * @var{stream}}) const
1454 @var{stream}. A @code{ParseException} is thrown if a parse error occurs.
1456 The @code{write()} method writes the configuration to the given @var{stream}.
1460 @deftypemethod Config void readFile (@w{const char * @var{filename}})
1461 @deftypemethodx Config void readFile (@w{const std::string &@var{filename}})
1464 file named @var{filename}. A @code{ParseException} is thrown if a
1470 @deftypemethod Config void writeFile (@w{const char * @var{filename}})
1471 @deftypemethodx Config void writeFile (@w{const std::string &@var{filename}})
1474 named @var{filename}. A @code{FileIOException} is thrown if the file cannot
1479 @deftypemethod Config void readString (@w{const char * @var{str}})
1480 @deftypemethodx Config void readString (@w{const std::string &@var{str}})
1483 @var{str}. A @code{ParseException} is thrown if a parse error occurs.
1500 @deftypemethod Config void setIncludeDir (@w{const char *@var{includeDir}})
1504 @var{includeDir}, relative to which the files specified in
1508 @var{includeDir} is @code{NULL}, the default behavior is reinstated.
1519 …irtual const char **} evaluateIncludePath (@w{const char * @var{path}}, @w{const char ** @var{erro…
1524 The @var{path} is the literal path argument of the directive. The method may
1535 On failure, the function should return @code{NULL} and set @var{*error} to a
1540 containing either a copy of @var{path} if it's an absolute path, or a
1541 concatenation of the include directory and @var{path} if it's a relative path.
1548 @deftypemethodx Config void setOptions (int @var{options})
1553 @var{options} should be a bitwise-OR of the following @var{Config::Option}
1616 @deftypemethod Config bool getOption (@w{Config::Option @var{option}}) const
1617 @deftypemethodx Config void setOption (@w{Config::Option @var{option}}, @w{bool @var{flag}})
1621 These methods get and set the option @var{option} for the configuration. The
1622 option is enabled if @var{flag} is @code{true} and disabled if it is
1630 @deftypemethodx Config void setAutoConvert (bool @var{flag})
1639 @deftypemethodx Config void setDefaultFormat (@w{Setting::Format @var{format}})
1650 @deftypemethodx Config void setTabWidth (@w{unsigned short @var{width}})
1654 to a file or stream: each level of nesting is indented by @var{width}
1655 spaces, or by a single tab character if @var{width} is 0. The tab
1663 @deftypemethodx Config void setFloatPrecision (@w{unsigned short @var{width}})
1681 @deftypemethod Config {Setting &} lookup (@w{const std::string &@var{path}}) const
1682 @deftypemethodx Config {Setting &} lookup (@w{const char * @var{path}}) const
1684 These methods locate the setting specified by the path @var{path}. If
1689 @deftypemethod Config bool exists (@w{const std::string &@var{path}}) const
1690 @deftypemethodx Config bool exists (@w{const char *@var{path}}) const
1692 These methods test if a setting with the given @var{path} exists in
1698 @deftypemethod Config bool lookupValue (@w{const char *@var{path}}, @w{bool &@var{value}}) const
1699 @deftypemethodx Config bool lookupValue (@w{const std::string &@var{path}}, @w{bool &@var{value}}) …
1701 @deftypemethodx Config bool lookupValue (@w{const char *@var{path}}, @w{int &@var{value}}) const
1702 @deftypemethodx Config bool lookupValue (@w{const std::string &@var{path}}, @w{int &@var{value}}) c…
1704 @deftypemethodx Config bool lookupValue (@w{const char *@var{path}}, @w{unsigned int &@var{value}})…
1705 @deftypemethodx Config bool lookupValue (@w{const std::string &@var{path}}, @w{unsigned int &@var{v…
1707 @deftypemethodx Config bool lookupValue (@w{const char *@var{path}}, @w{long long &@var{value}}) co…
1708 @deftypemethodx Config bool lookupValue (@w{const std::string &@var{path}}, @w{long long &@var{valu…
1710 @deftypemethodx Config bool lookupValue (@w{const char *@var{path}}, @w{float &@var{value}}) const
1711 @deftypemethodx Config bool lookupValue (@w{const std::string &@var{path}}, @w{float &@var{value}})…
1713 @deftypemethodx Config bool lookupValue (@w{const char *@var{path}}, @w{double &@var{value}}) const
1714 @deftypemethodx Config bool lookupValue (@w{const std::string &@var{path}}, @w{double &@var{value}}…
1716 @deftypemethodx Config bool lookupValue (@w{const char *@var{path}}, @w{const char *&@var{value}}) …
1717 @deftypemethodx Config bool lookupValue (@w{const std::string &@var{path}}, @w{const char *&@var{va…
1719 @deftypemethodx Config bool lookupValue (@w{const char *@var{path}}, @w{std::string &@var{value}}) …
1720 @deftypemethodx Config bool lookupValue (@w{const std::string &@var{path}}, @w{std::string &@var{va…
1723 with the given @var{path}. If the setting is found and is of an
1724 appropriate type, the value is stored in @var{value} and the method
1725 returns @code{true}. Otherwise, @var{value} is left unmodified and the
1869 @deftypemethod Setting {Setting &} operator= (@w{bool @var{value}})
1870 @deftypemethodx Setting {Setting &} operator= (@w{int @var{value}})
1871 @deftypemethodx Setting {Setting &} operator= (@w{long @var{value}})
1872 @deftypemethodx Setting {Setting &} operator= (@w{const long long &@var{value}})
1873 @deftypemethodx Setting {Setting &} operator= (@w{float @var{value}})
1874 @deftypemethodx Setting {Setting &} operator= (@w{const double &@var{value}})
1875 @deftypemethodx Setting {Setting &} operator= (@w{const char *@var{value}})
1876 @deftypemethodx Setting {Setting &} operator= (@w{const std::string &@var{value}})
1881 the library makes a copy of the passed string @var{value}, so it may
1900 @deftypemethod Setting {Setting &} {operator[]} (@w{int @var{index}}) const
1901 @deftypemethodx Setting {Setting &} {operator[]} (@w{const std::string &@var{name}}) const
1902 @deftypemethodx Setting {Setting &} {operator[]} (@w{const char *@var{name}}) const
1905 @var{index} if it is an array or list, or with either a string
1906 @var{name} or an integer index @var{index} if it is a group. For example,
1918 @code{SettingTypeException} is thrown. If the subscript (@var{index}
1919 or @var{name}) does not refer to a valid element, a
1928 @deftypemethod Setting {Setting &} lookup (@w{const char * @var{path}}) const
1929 @deftypemethodx Setting {Setting &} lookup (@w{const std::string &@var{path}}) const
1931 These methods locate a setting by a path @var{path} relative to
1937 @deftypemethod Setting bool lookupValue (@w{const char *@var{name}}, @w{bool &@var{value}}) const
1938 @deftypemethodx Setting bool lookupValue (@w{const std::string &@var{name}}, @w{bool &@var{value}})…
1940 @deftypemethodx Setting bool lookupValue (@w{const char *@var{name}}, @w{int &@var{value}}) const
1941 @deftypemethodx Setting bool lookupValue (@w{const std::string &@var{name}}, @w{int &@var{value}}) …
1943 @deftypemethodx Setting bool lookupValue (@w{const char *@var{name}}, @w{unsigned int &@var{value}}…
1944 @deftypemethodx Setting bool lookupValue (@w{const std::string &@var{name}}, @w{unsigned int &@var{…
1946 @deftypemethodx Setting bool lookupValue (@w{const char *@var{name}}, @w{long long &@var{value}}) c…
1947 @deftypemethodx Setting bool lookupValue (@w{const std::string &@var{name}}, @w{long long &@var{val…
1949 @deftypemethodx Setting bool lookupValue (@w{const char *@var{name}}, @w{unsigned long long &@var{v…
1950 …methodx Setting bool lookupValue (@w{const std::string &@var{name}}, @w{unsigned long long &@var{v…
1952 @deftypemethodx Setting bool lookupValue (@w{const char *@var{name}}, @w{float &@var{value}}) const
1953 @deftypemethodx Setting bool lookupValue (@w{const std::string &@var{name}}, @w{float &@var{value}}…
1955 @deftypemethodx Setting bool lookupValue (@w{const char *@var{name}}, @w{double &@var{value}}) const
1956 @deftypemethodx Setting bool lookupValue (@w{const std::string &@var{name}}, @w{double &@var{value}…
1958 @deftypemethodx Setting bool lookupValue (@w{const char *@var{name}}, @w{const char *&@var{value}})…
1959 @deftypemethodx Setting bool lookupValue (@w{const std::string &@var{name}}, @w{const char *&@var{v…
1961 @deftypemethodx Setting bool lookupValue (@w{const char *@var{name}}, @w{std::string &@var{value}})…
1962 @deftypemethodx Setting bool lookupValue (@w{const std::string &@var{name}}, @w{std::string &@var{v…
1965 with the given @var{name}. If the setting is found and is of an
1966 appropriate type, the value is stored in @var{value} and the method
1967 returns @code{true}. Otherwise, @var{value} is left unmodified and the
2008 @deftypemethod Setting {Setting &} add (@w{const std::string &@var{name}}, @w{Setting::Type @var{ty…
2009 @deftypemethodx Setting {Setting &} add (@w{const char *@var{name}}, @w{Setting::Type @var{type}})
2011 These methods add a new child setting with the given @var{name} and
2012 @var{type} to the setting, which must be a group. They return a
2023 @deftypemethod Setting {Setting &} add (@w{Setting::Type @var{type}})
2027 currently has zero elements, the @var{type} parameter (which must be
2032 The method returns the new setting on success. If @var{type} is a
2037 an array or list, or if @var{type} is invalid.
2041 @deftypemethod Setting void remove (@w{const std::string &@var{name}})
2042 @deftypemethodx Setting void remove (@w{const char *@var{name}})
2044 These methods remove the child setting with the given @var{name} from
2054 @deftypemethod Setting void remove (@w{unsigned int @var{index}})
2056 This method removes the child setting at the given index @var{index} from
2061 @code{SettingTypeException} is thrown.  If @var{index} is out of range,
2117 @deftypemethodx Setting void setFormat (@w{Setting::Format @var{format}})
2122 The @var{Setting::Format} enumeration consists of the following
2127 @var{format} is invalid for the given setting, it is ignored.
2131 @deftypemethod Setting bool exists (@w{const std::string &@var{name}}) const
2132 @deftypemethodx Setting bool exists (@w{const char *@var{name}}) const
2135 @var{name}. They return @code{true} if the setting exists, and
2193 stream at which the setting @var{setting} was read, or 0 if no line