class_dictionary.rst 3.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. .. _class_Dictionary:
  2. Dictionary
  3. ==========
  4. **Category:** Built-In Types
  5. Dictionary type.
  6. Member Functions
  7. ----------------
  8. +------------------------------+-----------------------------------------------------------------------------------------------+
  9. | void | :ref:`clear<class_Dictionary_clear>` **(** **)** |
  10. +------------------------------+-----------------------------------------------------------------------------------------------+
  11. | :ref:`bool<class_bool>` | :ref:`empty<class_Dictionary_empty>` **(** **)** |
  12. +------------------------------+-----------------------------------------------------------------------------------------------+
  13. | void | :ref:`erase<class_Dictionary_erase>` **(** var value **)** |
  14. +------------------------------+-----------------------------------------------------------------------------------------------+
  15. | :ref:`bool<class_bool>` | :ref:`has<class_Dictionary_has>` **(** var value **)** |
  16. +------------------------------+-----------------------------------------------------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`hash<class_Dictionary_hash>` **(** **)** |
  18. +------------------------------+-----------------------------------------------------------------------------------------------+
  19. | :ref:`Array<class_array>` | :ref:`keys<class_Dictionary_keys>` **(** **)** |
  20. +------------------------------+-----------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`parse_json<class_Dictionary_parse_json>` **(** :ref:`String<class_string>` json **)** |
  22. +------------------------------+-----------------------------------------------------------------------------------------------+
  23. | :ref:`int<class_int>` | :ref:`size<class_Dictionary_size>` **(** **)** |
  24. +------------------------------+-----------------------------------------------------------------------------------------------+
  25. | :ref:`String<class_string>` | :ref:`to_json<class_Dictionary_to_json>` **(** **)** |
  26. +------------------------------+-----------------------------------------------------------------------------------------------+
  27. Description
  28. -----------
  29. Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are always passed by reference.
  30. Member Function Description
  31. ---------------------------
  32. .. _class_Dictionary_clear:
  33. - void **clear** **(** **)**
  34. Clear the dictionary, removing all key/value pairs.
  35. .. _class_Dictionary_empty:
  36. - :ref:`bool<class_bool>` **empty** **(** **)**
  37. Return true if the dictionary is empty.
  38. .. _class_Dictionary_erase:
  39. - void **erase** **(** var value **)**
  40. Erase a dictionary key/value pair by key.
  41. .. _class_Dictionary_has:
  42. - :ref:`bool<class_bool>` **has** **(** var value **)**
  43. Return true if the dictionary has a given key.
  44. .. _class_Dictionary_hash:
  45. - :ref:`int<class_int>` **hash** **(** **)**
  46. Return a hashed integer value representing the dictionary contents.
  47. .. _class_Dictionary_keys:
  48. - :ref:`Array<class_array>` **keys** **(** **)**
  49. Return the list of keys in the dictionary.
  50. .. _class_Dictionary_parse_json:
  51. - :ref:`int<class_int>` **parse_json** **(** :ref:`String<class_string>` json **)**
  52. .. _class_Dictionary_size:
  53. - :ref:`int<class_int>` **size** **(** **)**
  54. Return the size of the dictionary (in pairs).
  55. .. _class_Dictionary_to_json:
  56. - :ref:`String<class_string>` **to_json** **(** **)**