Sync classref with current source

This commit is contained in:
Rémi Verschelde
2020-01-21 09:28:25 +01:00
parent e11844538c
commit 3e8e67ac95
419 changed files with 12807 additions and 99 deletions

View File

@@ -106,96 +106,128 @@ Method Descriptions
Get the amount of attributes in the current element.
----
.. _class_XMLParser_method_get_attribute_name:
- :ref:`String<class_String>` **get_attribute_name** **(** :ref:`int<class_int>` idx **)** const
Get the name of the attribute specified by the index in ``idx`` argument.
----
.. _class_XMLParser_method_get_attribute_value:
- :ref:`String<class_String>` **get_attribute_value** **(** :ref:`int<class_int>` idx **)** const
Get the value of the attribute specified by the index in ``idx`` argument.
----
.. _class_XMLParser_method_get_current_line:
- :ref:`int<class_int>` **get_current_line** **(** **)** const
Get the current line in the parsed file (currently not implemented).
----
.. _class_XMLParser_method_get_named_attribute_value:
- :ref:`String<class_String>` **get_named_attribute_value** **(** :ref:`String<class_String>` name **)** const
Get the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute.
----
.. _class_XMLParser_method_get_named_attribute_value_safe:
- :ref:`String<class_String>` **get_named_attribute_value_safe** **(** :ref:`String<class_String>` name **)** const
Get the value of a certain attribute of the current element by name. This will return an empty :ref:`String<class_String>` if the attribute is not found.
----
.. _class_XMLParser_method_get_node_data:
- :ref:`String<class_String>` **get_node_data** **(** **)** const
Get the contents of a text node. This will raise an error in any other type of node.
----
.. _class_XMLParser_method_get_node_name:
- :ref:`String<class_String>` **get_node_name** **(** **)** const
Get the name of the current element node. This will raise an error if the current node type is not :ref:`NODE_ELEMENT<class_XMLParser_constant_NODE_ELEMENT>` nor :ref:`NODE_ELEMENT_END<class_XMLParser_constant_NODE_ELEMENT_END>`
----
.. _class_XMLParser_method_get_node_offset:
- :ref:`int<class_int>` **get_node_offset** **(** **)** const
Get the byte offset of the current node since the beginning of the file or buffer.
----
.. _class_XMLParser_method_get_node_type:
- :ref:`NodeType<enum_XMLParser_NodeType>` **get_node_type** **(** **)**
Get the type of the current node. Compare with ``NODE_*`` constants.
----
.. _class_XMLParser_method_has_attribute:
- :ref:`bool<class_bool>` **has_attribute** **(** :ref:`String<class_String>` name **)** const
Check whether or not the current element has a certain attribute.
----
.. _class_XMLParser_method_is_empty:
- :ref:`bool<class_bool>` **is_empty** **(** **)** const
Check whether the current element is empty (this only works for completely empty tags, e.g. <element \\>).
----
.. _class_XMLParser_method_open:
- :ref:`Error<enum_@GlobalScope_Error>` **open** **(** :ref:`String<class_String>` file **)**
Open a XML file for parsing. This returns an error code.
----
.. _class_XMLParser_method_open_buffer:
- :ref:`Error<enum_@GlobalScope_Error>` **open_buffer** **(** :ref:`PoolByteArray<class_PoolByteArray>` buffer **)**
Open a XML raw buffer for parsing. This returns an error code.
----
.. _class_XMLParser_method_read:
- :ref:`Error<enum_@GlobalScope_Error>` **read** **(** **)**
Read the next node of the file. This returns an error code.
----
.. _class_XMLParser_method_seek:
- :ref:`Error<enum_@GlobalScope_Error>` **seek** **(** :ref:`int<class_int>` position **)**
Move the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code.
----
.. _class_XMLParser_method_skip_section:
- void **skip_section** **(** **)**