document LoadObject() (patch 1873045)

[wxWidgets.git] / docs / latex / wx / xmlattr.tex

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Name:        xmlattr.tex
%% Purpose:     wxXmlAttribute documentation
%% Author:      Francesco Montorsi
%% Created:     2006-04-18
%% RCS-ID:      $Id$
%% Copyright:   (c) 2006 Francesco Montorsi
%% License:     wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section{\class{wxXmlAttribute}}\label{wxxmlattribute}

Represents a node attribute.

Example: in {\tt <img src="hello.gif" id="3"/>}, {\tt ``src"} is attribute with value
{\tt ``hello.gif"} and {\tt ``id"} is a attribute with value {\tt ``3"}.

\wxheading{Derived from}

No base class

\wxheading{Include files}

<wx/xml/xml.h>

\wxheading{Library}

\helpref{wxXml}{librarieslist}

\wxheading{See also}

\helpref{wxXmlDocument}{wxxmldocument}, \helpref{wxXmlNode}{wxxmlnode}

\latexignore{\rtfignore{\wxheading{Members}}}


\membersection{wxXmlAttribute::wxXmlAttribute}\label{wxxmlattributewxxmlattribute}

\func{}{wxXmlAttribute}{\void}


\func{}{wxXmlAttribute}{\param{const wxString\& }{name}, \param{const wxString\& }{value}, \param{wxXmlAttribute* }{next = NULL}}

Creates the attribute with given {\it name} and {\it value}.
If {\it next} is not NULL, then sets it as sibling of this attribute.

\membersection{wxXmlAttribute::\destruct{wxXmlAttribute}}\label{wxxmlattributedtor}

\func{}{\destruct{wxXmlAttribute}}{\void}

The virtual destructor.

\membersection{wxXmlAttribute::GetName}\label{wxxmlattributegetname}

\constfunc{wxString}{GetName}{\void}

Returns the name of this attribute.

\membersection{wxXmlAttribute::GetNext}\label{wxxmlattributegetnext}

\constfunc{wxXmlAttribute*}{GetNext}{\void}

Returns the sibling of this attribute or NULL if there are no siblings.

\membersection{wxXmlAttribute::GetValue}\label{wxxmlattributegetvalue}

\constfunc{wxString}{GetValue}{\void}

Returns the value of this attribute.

\membersection{wxXmlAttribute::SetName}\label{wxxmlattributesetname}

\func{void}{SetName}{\param{const wxString\& }{name}}

Sets the name of this attribute.

\membersection{wxXmlAttribute::SetNext}\label{wxxmlattributesetnext}

\func{void}{SetNext}{\param{wxXmlAttribute* }{next}}

Sets the sibling of this attribute.

\membersection{wxXmlAttribute::SetValue}\label{wxxmlattributesetvalue}

\func{void}{SetValue}{\param{const wxString\& }{value}}

Sets the value of this attribute.