class_configfile.rst 4.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. .. _class_ConfigFile:
  2. ConfigFile
  3. ==========
  4. **Inherits:** :ref:`Reference<class_reference>`
  5. **Category:** Core
  6. Member Functions
  7. ----------------
  8. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  9. | void | :ref:`set_value<class_ConfigFile_set_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var value **)** |
  10. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  11. | void | :ref:`get_value<class_ConfigFile_get_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var default=NULL **)** const |
  12. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  13. | :ref:`bool<class_bool>` | :ref:`has_section<class_ConfigFile_has_section>` **(** :ref:`String<class_string>` section **)** const |
  14. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`bool<class_bool>` | :ref:`has_section_key<class_ConfigFile_has_section_key>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** const |
  16. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`StringArray<class_stringarray>` | :ref:`get_sections<class_ConfigFile_get_sections>` **(** **)** const |
  18. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`StringArray<class_stringarray>` | :ref:`get_section_keys<class_ConfigFile_get_section_keys>` **(** :ref:`String<class_string>` section **)** const |
  20. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | Error | :ref:`load<class_ConfigFile_load>` **(** :ref:`String<class_string>` path **)** |
  22. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | Error | :ref:`save<class_ConfigFile_save>` **(** :ref:`String<class_string>` path **)** |
  24. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. Member Function Description
  26. ---------------------------
  27. .. _class_ConfigFile_set_value:
  28. - void **set_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var value **)**
  29. .. _class_ConfigFile_get_value:
  30. - void **get_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var default=NULL **)** const
  31. .. _class_ConfigFile_has_section:
  32. - :ref:`bool<class_bool>` **has_section** **(** :ref:`String<class_string>` section **)** const
  33. .. _class_ConfigFile_has_section_key:
  34. - :ref:`bool<class_bool>` **has_section_key** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** const
  35. .. _class_ConfigFile_get_sections:
  36. - :ref:`StringArray<class_stringarray>` **get_sections** **(** **)** const
  37. .. _class_ConfigFile_get_section_keys:
  38. - :ref:`StringArray<class_stringarray>` **get_section_keys** **(** :ref:`String<class_string>` section **)** const
  39. .. _class_ConfigFile_load:
  40. - Error **load** **(** :ref:`String<class_string>` path **)**
  41. .. _class_ConfigFile_save:
  42. - Error **save** **(** :ref:`String<class_string>` path **)**