| 1 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2 | %% Name: xmlattr.tex |
| 3 | %% Purpose: wxXmlAttribute documentation |
| 4 | %% Author: Francesco Montorsi |
| 5 | %% Created: 2006-04-18 |
| 6 | %% RCS-ID: $Id$ |
| 7 | %% Copyright: (c) 2006 Francesco Montorsi |
| 8 | %% License: wxWindows license |
| 9 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 10 | |
| 11 | \section{\class{wxXmlAttribute}}\label{wxxmlattribute} |
| 12 | |
| 13 | Represents a node attribute. |
| 14 | |
| 15 | Example: in {\tt <img src="hello.gif" id="3"/>}, {\tt ``src"} is attribute with value |
| 16 | {\tt ``hello.gif"} and {\tt ``id"} is a attribute with value {\tt ``3"}. |
| 17 | |
| 18 | \wxheading{Derived from} |
| 19 | |
| 20 | No base class |
| 21 | |
| 22 | \wxheading{Include files} |
| 23 | |
| 24 | <wx/xml/xml.h> |
| 25 | |
| 26 | \wxheading{Library} |
| 27 | |
| 28 | \helpref{wxXml}{librarieslist} |
| 29 | |
| 30 | \wxheading{See also} |
| 31 | |
| 32 | \helpref{wxXmlDocument}{wxxmldocument}, \helpref{wxXmlNode}{wxxmlnode} |
| 33 | |
| 34 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 35 | |
| 36 | |
| 37 | \membersection{wxXmlAttribute::wxXmlAttribute}\label{wxxmlattributewxxmlattribute} |
| 38 | |
| 39 | \func{}{wxXmlAttribute}{\void} |
| 40 | |
| 41 | |
| 42 | \func{}{wxXmlAttribute}{\param{const wxString\& }{name}, \param{const wxString\& }{value}, \param{wxXmlAttribute* }{next = NULL}} |
| 43 | |
| 44 | Creates the attribute with given {\it name} and {\it value}. |
| 45 | If {\it next} is not NULL, then sets it as sibling of this attribute. |
| 46 | |
| 47 | \membersection{wxXmlAttribute::\destruct{wxXmlAttribute}}\label{wxxmlattributedtor} |
| 48 | |
| 49 | \func{}{\destruct{wxXmlAttribute}}{\void} |
| 50 | |
| 51 | The virtual destructor. |
| 52 | |
| 53 | \membersection{wxXmlAttribute::GetName}\label{wxxmlattributegetname} |
| 54 | |
| 55 | \constfunc{wxString}{GetName}{\void} |
| 56 | |
| 57 | Returns the name of this attribute. |
| 58 | |
| 59 | \membersection{wxXmlAttribute::GetNext}\label{wxxmlattributegetnext} |
| 60 | |
| 61 | \constfunc{wxXmlAttribute*}{GetNext}{\void} |
| 62 | |
| 63 | Returns the sibling of this attribute or NULL if there are no siblings. |
| 64 | |
| 65 | \membersection{wxXmlAttribute::GetValue}\label{wxxmlattributegetvalue} |
| 66 | |
| 67 | \constfunc{wxString}{GetValue}{\void} |
| 68 | |
| 69 | Returns the value of this attribute. |
| 70 | |
| 71 | \membersection{wxXmlAttribute::SetName}\label{wxxmlattributesetname} |
| 72 | |
| 73 | \func{void}{SetName}{\param{const wxString\& }{name}} |
| 74 | |
| 75 | Sets the name of this attribute. |
| 76 | |
| 77 | \membersection{wxXmlAttribute::SetNext}\label{wxxmlattributesetnext} |
| 78 | |
| 79 | \func{void}{SetNext}{\param{wxXmlAttribute* }{next}} |
| 80 | |
| 81 | Sets the sibling of this attribute. |
| 82 | |
| 83 | \membersection{wxXmlAttribute::SetValue}\label{wxxmlattributesetvalue} |
| 84 | |
| 85 | \func{void}{SetValue}{\param{const wxString\& }{value}} |
| 86 | |
| 87 | Sets the value of this attribute. |
| 88 | |