.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.xml.XmlAttribute:
==========================================================================================================================================
|phoenix_title| **wx.xml.XmlAttribute**
==========================================================================================================================================
Represents a node attribute.
Example: in ``
`` , ``src`` is an attribute with value ``hello.gif`` and ``id`` is an attribute with value ``3`` .
.. seealso:: :ref:`wx.xml.XmlDocument`, :ref:`wx.xml.XmlNode`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
XmlAttribute:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.xml.XmlAttribute.__init__` Default constructor.
:meth:`~wx.xml.XmlAttribute.GetName` Returns the name of this attribute.
:meth:`~wx.xml.XmlAttribute.GetNext` Returns the sibling of this attribute or ``None`` if there are no siblings.
:meth:`~wx.xml.XmlAttribute.GetValue` Returns the value of this attribute.
:meth:`~wx.xml.XmlAttribute.SetName` Sets the name of this attribute.
:meth:`~wx.xml.XmlAttribute.SetNext` Sets the sibling of this attribute.
:meth:`~wx.xml.XmlAttribute.SetValue` Sets the value of this attribute.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.xml.XmlAttribute.Name` See :meth:`~wx.xml.XmlAttribute.GetName` and :meth:`~wx.xml.XmlAttribute.SetName`
:attr:`~wx.xml.XmlAttribute.Next` See :meth:`~wx.xml.XmlAttribute.GetNext` and :meth:`~wx.xml.XmlAttribute.SetNext`
:attr:`~wx.xml.XmlAttribute.Value` See :meth:`~wx.xml.XmlAttribute.GetValue` and :meth:`~wx.xml.XmlAttribute.SetValue`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.xml.XmlAttribute(object)
**Possible constructors**::
XmlAttribute() -> None
XmlAttribute(name : str, value : str, next: Optional[XmlAttribute]=None)
-> None
Represents a node attribute.
.. method:: __init__(self, *args, **kw)
|overload| **Overloaded Implementations:**
:html:`
`
**__init__** `(self)`
Default constructor.
:rtype: `None`
:html:`
`
**__init__** `(self, name : str, value : str, next: Optional[XmlAttribute]=None)`
Creates the attribute with given `name` and `value`.
If `next` is not ``None``, then sets it as sibling of this attribute.
:param `name`:
:type `name`: string
:param `value`:
:type `value`: string
:param `next`:
:type `next`: wx.xml.XmlAttribute
:rtype: `None`
:html:`
`
.. method:: GetName(self)
Returns the name of this attribute.
:rtype: `str`
.. method:: GetNext(self)
Returns the sibling of this attribute or ``None`` if there are no siblings.
:rtype: :ref:`wx.xml.XmlAttribute`
.. method:: GetValue(self)
Returns the value of this attribute.
:rtype: `str`
.. method:: SetName(self, name : str)
Sets the name of this attribute.
:param `name`:
:type `name`: string
:rtype: `None`
.. method:: SetNext(self, next : XmlAttribute)
Sets the sibling of this attribute.
:param `next`:
:type `next`: wx.xml.XmlAttribute
:rtype: `None`
.. method:: SetValue(self, value : str)
Sets the value of this attribute.
:param `value`:
:type `value`: string
:rtype: `None`
.. attribute:: Name
See :meth:`~wx.xml.XmlAttribute.GetName` and :meth:`~wx.xml.XmlAttribute.SetName`
.. attribute:: Next
See :meth:`~wx.xml.XmlAttribute.GetNext` and :meth:`~wx.xml.XmlAttribute.SetNext`
.. attribute:: Value
See :meth:`~wx.xml.XmlAttribute.GetValue` and :meth:`~wx.xml.XmlAttribute.SetValue`