]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/xmlproperty.tex
another patch bring the docs more up to date (patch 1717776)
[wxWidgets.git] / docs / latex / wx / xmlproperty.tex
CommitLineData
434cf5a4
RR
1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%% Name: xmlnode.tex
3%% Purpose: wxXmlProperty 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
4c43dd90
JS
11\section{\class{wxXmlProperty}}\label{wxxmlproperty}
12
13Represents a node property.
14
434cf5a4
RR
15Example: in {\tt <img src="hello.gif" id="3"/>}, {\tt ``src"} is property with value
16{\tt ``hello.gif"} and {\tt ``id"} is a property with value {\tt ``3"}.
4c43dd90
JS
17
18\wxheading{Derived from}
19
20No base class
21
22\wxheading{Include files}
23
24<wx/xml/xml.h>
25
26\wxheading{See also}
27
28\helpref{wxXmlDocument}{wxxmldocument}, \helpref{wxXmlNode}{wxxmlnode}
29
30\latexignore{\rtfignore{\wxheading{Members}}}
31
32
33\membersection{wxXmlProperty::wxXmlProperty}\label{wxxmlpropertywxxmlproperty}
34
35\func{}{wxXmlProperty}{\void}
36
37
38\func{}{wxXmlProperty}{\param{const wxString\& }{name}, \param{const wxString\& }{value}, \param{wxXmlProperty* }{next = NULL}}
39
40Creates the property with given {\it name} and {\it value}.
41If {\it next} is not NULL, then sets it as sibling of this property.
42
43\membersection{wxXmlProperty::\destruct{wxXmlProperty}}\label{wxxmlpropertydtor}
44
45\func{}{\destruct{wxXmlProperty}}{\void}
46
47The virtual destructor.
48
49\membersection{wxXmlProperty::GetName}\label{wxxmlpropertygetname}
50
51\constfunc{wxString}{GetName}{\void}
52
53Returns the name of this property.
54
55\membersection{wxXmlProperty::GetNext}\label{wxxmlpropertygetnext}
56
57\constfunc{wxXmlProperty*}{GetNext}{\void}
58
59Returns the sibling of this property or NULL if there are no siblings.
60
61\membersection{wxXmlProperty::GetValue}\label{wxxmlpropertygetvalue}
62
63\constfunc{wxString}{GetValue}{\void}
64
65Returns the value of this property.
66
67\membersection{wxXmlProperty::SetName}\label{wxxmlpropertysetname}
68
69\func{void}{SetName}{\param{const wxString\& }{name}}
70
71Sets the name of this property.
72
73\membersection{wxXmlProperty::SetNext}\label{wxxmlpropertysetnext}
74
75\func{void}{SetNext}{\param{wxXmlProperty* }{next}}
76
77Sets the sibling of this property.
78
79\membersection{wxXmlProperty::SetValue}\label{wxxmlpropertysetvalue}
80
81\func{void}{SetValue}{\param{const wxString\& }{value}}
82
83Sets the value of this property.
84