class_xmlparser.rst 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_XMLParser:
  4. XMLParser
  5. =========
  6. **Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Member Functions
  11. ----------------
  12. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  13. | :ref:`int<class_int>` | :ref:`read<class_XMLParser_read>` **(** **)** |
  14. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`int<class_int>` | :ref:`get_node_type<class_XMLParser_get_node_type>` **(** **)** |
  16. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`String<class_string>` | :ref:`get_node_name<class_XMLParser_get_node_name>` **(** **)** const |
  18. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`String<class_string>` | :ref:`get_node_data<class_XMLParser_get_node_data>` **(** **)** const |
  20. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`get_node_offset<class_XMLParser_get_node_offset>` **(** **)** const |
  22. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`int<class_int>` | :ref:`get_attribute_count<class_XMLParser_get_attribute_count>` **(** **)** const |
  24. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`String<class_string>` | :ref:`get_attribute_name<class_XMLParser_get_attribute_name>` **(** :ref:`int<class_int>` idx **)** const |
  26. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`String<class_string>` | :ref:`get_attribute_value<class_XMLParser_get_attribute_value>` **(** :ref:`int<class_int>` idx **)** const |
  28. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`bool<class_bool>` | :ref:`has_attribute<class_XMLParser_has_attribute>` **(** :ref:`String<class_string>` name **)** const |
  30. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`String<class_string>` | :ref:`get_named_attribute_value<class_XMLParser_get_named_attribute_value>` **(** :ref:`String<class_string>` name **)** const |
  32. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`String<class_string>` | :ref:`get_named_attribute_value_safe<class_XMLParser_get_named_attribute_value_safe>` **(** :ref:`String<class_string>` name **)** const |
  34. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`bool<class_bool>` | :ref:`is_empty<class_XMLParser_is_empty>` **(** **)** const |
  36. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`int<class_int>` | :ref:`get_current_line<class_XMLParser_get_current_line>` **(** **)** const |
  38. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  39. | void | :ref:`skip_section<class_XMLParser_skip_section>` **(** **)** |
  40. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`int<class_int>` | :ref:`seek<class_XMLParser_seek>` **(** :ref:`int<class_int>` pos **)** |
  42. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`int<class_int>` | :ref:`open<class_XMLParser_open>` **(** :ref:`String<class_string>` file **)** |
  44. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`int<class_int>` | :ref:`open_buffer<class_XMLParser_open_buffer>` **(** :ref:`RawArray<class_rawarray>` buffer **)** |
  46. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  47. Numeric Constants
  48. -----------------
  49. - **NODE_NONE** = **0**
  50. - **NODE_ELEMENT** = **1**
  51. - **NODE_ELEMENT_END** = **2**
  52. - **NODE_TEXT** = **3**
  53. - **NODE_COMMENT** = **4**
  54. - **NODE_CDATA** = **5**
  55. - **NODE_UNKNOWN** = **6**
  56. Member Function Description
  57. ---------------------------
  58. .. _class_XMLParser_read:
  59. - :ref:`int<class_int>` **read** **(** **)**
  60. .. _class_XMLParser_get_node_type:
  61. - :ref:`int<class_int>` **get_node_type** **(** **)**
  62. .. _class_XMLParser_get_node_name:
  63. - :ref:`String<class_string>` **get_node_name** **(** **)** const
  64. .. _class_XMLParser_get_node_data:
  65. - :ref:`String<class_string>` **get_node_data** **(** **)** const
  66. .. _class_XMLParser_get_node_offset:
  67. - :ref:`int<class_int>` **get_node_offset** **(** **)** const
  68. .. _class_XMLParser_get_attribute_count:
  69. - :ref:`int<class_int>` **get_attribute_count** **(** **)** const
  70. .. _class_XMLParser_get_attribute_name:
  71. - :ref:`String<class_string>` **get_attribute_name** **(** :ref:`int<class_int>` idx **)** const
  72. .. _class_XMLParser_get_attribute_value:
  73. - :ref:`String<class_string>` **get_attribute_value** **(** :ref:`int<class_int>` idx **)** const
  74. .. _class_XMLParser_has_attribute:
  75. - :ref:`bool<class_bool>` **has_attribute** **(** :ref:`String<class_string>` name **)** const
  76. .. _class_XMLParser_get_named_attribute_value:
  77. - :ref:`String<class_string>` **get_named_attribute_value** **(** :ref:`String<class_string>` name **)** const
  78. .. _class_XMLParser_get_named_attribute_value_safe:
  79. - :ref:`String<class_string>` **get_named_attribute_value_safe** **(** :ref:`String<class_string>` name **)** const
  80. .. _class_XMLParser_is_empty:
  81. - :ref:`bool<class_bool>` **is_empty** **(** **)** const
  82. .. _class_XMLParser_get_current_line:
  83. - :ref:`int<class_int>` **get_current_line** **(** **)** const
  84. .. _class_XMLParser_skip_section:
  85. - void **skip_section** **(** **)**
  86. .. _class_XMLParser_seek:
  87. - :ref:`int<class_int>` **seek** **(** :ref:`int<class_int>` pos **)**
  88. .. _class_XMLParser_open:
  89. - :ref:`int<class_int>` **open** **(** :ref:`String<class_string>` file **)**
  90. .. _class_XMLParser_open_buffer:
  91. - :ref:`int<class_int>` **open_buffer** **(** :ref:`RawArray<class_rawarray>` buffer **)**