1/* 2 * Copyright 2019 Haiku, Inc. All rights reserved. 3 * Distributed under the terms of the MIT License. 4 * 5 * Authors: 6 * Name, email@email.com 7 * 8 * Corresponds to: 9 * headers/os/support/StringList.h hrev47422 10 * src/kits/support/StringList.cpp hrev46113 11 */ 12 13 14/*! 15 \file StringList.h 16 \ingroup support 17 \brief Undocumented file. 18 19 \since Haiku R1 20*/ 21 22 23/*! 24 \class BStringList 25 \ingroup support 26 \ingroup libbe 27 \brief Undocumented class. 28 29 \since Haiku R1 30*/ 31 32 33/*! 34 \fn BStringList::BStringList(int32 count=20) 35 \brief Undocumented public method 36 37 \param count Undocumented 38 39 \return Undocumented 40 \retval <value> Undocumented 41 42 \since Haiku R1 43*/ 44 45 46/*! 47 \fn BStringList::BStringList(const BStringList &other) 48 \brief Undocumented public method 49 50 \param other Undocumented 51 52 \return Undocumented 53 \retval <value> Undocumented 54 55 \since Haiku R1 56*/ 57 58 59/*! 60 \fn virtual virtual BStringList::~BStringList() 61 \brief Undocumented public method 62 63 \return Undocumented 64 \retval <value> Undocumented 65 66 \since Haiku R1 67*/ 68 69 70/*! 71 \fn bool BStringList::Add(const BString &string, int32 index) 72 \brief Undocumented public method 73 74 \param string Undocumented 75 \param index Undocumented 76 77 \return Undocumented 78 \retval <value> Undocumented 79 80 \since Haiku R1 81*/ 82 83 84/*! 85 \fn bool BStringList::Add(const BString &string) 86 \brief Undocumented public method 87 88 \param string Undocumented 89 90 \return Undocumented 91 \retval <value> Undocumented 92 93 \since Haiku R1 94*/ 95 96 97/*! 98 \fn bool BStringList::Add(const BStringList &list, int32 index) 99 \brief Undocumented public method 100 101 \param list Undocumented 102 \param index Undocumented 103 104 \return Undocumented 105 \retval <value> Undocumented 106 107 \since Haiku R1 108*/ 109 110 111/*! 112 \fn bool BStringList::Add(const BStringList &list) 113 \brief Undocumented public method 114 115 \param list Undocumented 116 117 \return Undocumented 118 \retval <value> Undocumented 119 120 \since Haiku R1 121*/ 122 123 124/*! 125 \fn bool BStringList::Remove(const BString &string, bool ignoreCase=false) 126 \brief Undocumented public method 127 128 \param string Undocumented 129 \param ignoreCase Undocumented 130 131 \return Undocumented 132 \retval <value> Undocumented 133 134 \since Haiku R1 135*/ 136 137 138/*! 139 \fn bool BStringList::Remove(const BStringList &list, bool ignoreCase=false) 140 \brief Undocumented public method 141 142 \param list Undocumented 143 \param ignoreCase Undocumented 144 145 \return Undocumented 146 \retval <value> Undocumented 147 148 \since Haiku R1 149*/ 150 151 152/*! 153 \fn BString BStringList::Remove(int32 index) 154 \brief Undocumented public method 155 156 \param index Undocumented 157 158 \return Undocumented 159 \retval <value> Undocumented 160 161 \since Haiku R1 162*/ 163 164 165/*! 166 \fn bool BStringList::Remove(int32 index, int32 count) 167 \brief Undocumented public method 168 169 \param index Undocumented 170 \param count Undocumented 171 172 \return Undocumented 173 \retval <value> Undocumented 174 175 \since Haiku R1 176*/ 177 178 179/*! 180 \fn bool BStringList::Replace(int32 index, const BString &string) 181 \brief Undocumented public method 182 183 \param index Undocumented 184 \param string Undocumented 185 186 \return Undocumented 187 \retval <value> Undocumented 188 189 \since Haiku R1 190*/ 191 192 193/*! 194 \fn void BStringList::MakeEmpty() 195 \brief Undocumented public method 196 197 \since Haiku R1 198*/ 199 200 201/*! 202 \fn void BStringList::Sort(bool ignoreCase=false) 203 \brief Undocumented public method 204 205 \param ignoreCase Undocumented 206 207 \since Haiku R1 208*/ 209 210 211/*! 212 \fn bool BStringList::Swap(int32 indexA, int32 indexB) 213 \brief Undocumented public method 214 215 \param indexA Undocumented 216 \param indexB Undocumented 217 218 \return Undocumented 219 \retval <value> Undocumented 220 221 \since Haiku R1 222*/ 223 224 225/*! 226 \fn bool BStringList::Move(int32 fromIndex, int32 toIndex) 227 \brief Undocumented public method 228 229 \param fromIndex Undocumented 230 \param toIndex Undocumented 231 232 \return Undocumented 233 \retval <value> Undocumented 234 235 \since Haiku R1 236*/ 237 238 239/*! 240 \fn BString BStringList::StringAt(int32 index) const 241 \brief Undocumented public method 242 243 \param index Undocumented 244 245 \return Undocumented 246 \retval <value> Undocumented 247 248 \since Haiku R1 249*/ 250 251 252/*! 253 \fn BString BStringList::First() const 254 \brief Undocumented public method 255 256 \return Undocumented 257 \retval <value> Undocumented 258 259 \since Haiku R1 260*/ 261 262 263/*! 264 \fn BString BStringList::Last() const 265 \brief Undocumented public method 266 267 \return Undocumented 268 \retval <value> Undocumented 269 270 \since Haiku R1 271*/ 272 273 274/*! 275 \fn bool BStringList::HasString(const BString &string, bool ignoreCase=false) const 276 \brief Undocumented public method 277 278 \param string Undocumented 279 \param ignoreCase Undocumented 280 281 \return Undocumented 282 \retval <value> Undocumented 283 284 \since Haiku R1 285*/ 286 287 288/*! 289 \fn int32 BStringList::IndexOf(const BString &string, bool ignoreCase=false) const 290 \brief Undocumented public method 291 292 \param string Undocumented 293 \param ignoreCase Undocumented 294 295 \return Undocumented 296 \retval <value> Undocumented 297 298 \since Haiku R1 299*/ 300 301 302/*! 303 \fn int32 BStringList::CountStrings() const 304 \brief Undocumented public method 305 306 \return Undocumented 307 \retval <value> Undocumented 308 309 \since Haiku R1 310*/ 311 312 313/*! 314 \fn bool BStringList::IsEmpty() const 315 \brief Undocumented public method 316 317 \return Undocumented 318 \retval <value> Undocumented 319 320 \since Haiku R1 321*/ 322 323 324/*! 325 \fn BString BStringList::Join(const char *separator, int32 length=-1) const 326 \brief Undocumented public method 327 328 \param separator Undocumented 329 \param length Undocumented 330 331 \return Undocumented 332 \retval <value> Undocumented 333 334 \since Haiku R1 335*/ 336 337 338/*! 339 \fn void BStringList::DoForEach(bool(*func)(const BString &string)) 340 \brief Undocumented public method 341 342 \param func Undocumented 343 344 \since Haiku R1 345*/ 346 347 348/*! 349 \fn void BStringList::DoForEach(bool(*func)(const BString &string, void *arg2), void *arg2) 350 \brief Undocumented public method 351 352 \param func Undocumented 353 \param arg2 Undocumented 354 355 \since Haiku R1 356*/ 357 358 359/*! 360 \fn BStringList& BStringList::operator=(const BStringList &other) 361 \brief Undocumented public method 362 363 \param other Undocumented 364 365 \return Undocumented 366 \retval <value> Undocumented 367 368 \since Haiku R1 369*/ 370 371 372/*! 373 \fn bool BStringList::operator==(const BStringList &other) const 374 \brief Undocumented public method 375 376 \param other Undocumented 377 378 \return Undocumented 379 \retval <value> Undocumented 380 381 \since Haiku R1 382*/ 383 384 385/*! 386 \fn bool BStringList::operator!=(const BStringList &other) const 387 \brief Undocumented public method 388 389 \param other Undocumented 390 391 \return Undocumented 392 \retval <value> Undocumented 393 394 \since Haiku R1 395*/ 396 397 398/*! 399 \fn virtual virtual bool BStringList::IsFixedSize() const 400 \brief Undocumented public method 401 402 \return Undocumented 403 \retval <value> Undocumented 404 405 \since Haiku R1 406*/ 407 408 409/*! 410 \fn virtual virtual type_code BStringList::TypeCode() const 411 \brief Undocumented public method 412 413 \return Undocumented 414 \retval <value> Undocumented 415 416 \since Haiku R1 417*/ 418 419 420/*! 421 \fn virtual virtual bool BStringList::AllowsTypeCode(type_code code) const 422 \brief Undocumented public method 423 424 \param code Undocumented 425 426 \return Undocumented 427 \retval <value> Undocumented 428 429 \since Haiku R1 430*/ 431 432 433/*! 434 \fn virtual virtual ssize_t BStringList::FlattenedSize() const 435 \brief Undocumented public method 436 437 \return Undocumented 438 \retval <value> Undocumented 439 440 \since Haiku R1 441*/ 442 443 444/*! 445 \fn virtual virtual status_t BStringList::Flatten(void *buffer, ssize_t size) const 446 \brief Undocumented public method 447 448 \param buffer Undocumented 449 \param size Undocumented 450 451 \return Undocumented 452 \retval <value> Undocumented 453 454 \since Haiku R1 455*/ 456 457 458/*! 459 \fn virtual virtual status_t BStringList::Unflatten(type_code code, const void *buffer, ssize_t size) 460 \brief Undocumented public method 461 462 \param code Undocumented 463 \param buffer Undocumented 464 \param size Undocumented 465 466 \return Undocumented 467 \retval <value> Undocumented 468 469 \since Haiku R1 470*/ 471