2013-03-13 08:00:12 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
2012-09-19 15:15:01 +00:00
< title > TinyXml: TiXmlAttribute Class Reference< / title >
2013-03-13 08:00:12 +00:00
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
<!-- Generated by Doxygen 1.6.2 -->
< div class = "navigation" id = "top" >
< div class = "tabs" >
< ul >
< li > < a href = "index.html" > < span > Main Page< / span > < / a > < / li >
< li > < a href = "pages.html" > < span > Related Pages< / span > < / a > < / li >
< li class = "current" > < a href = "annotated.html" > < span > Classes< / span > < / a > < / li >
< li > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< / ul >
< / div >
< div class = "tabs" >
< ul >
< li > < a href = "annotated.html" > < span > Class List< / span > < / a > < / li >
< li > < a href = "hierarchy.html" > < span > Class Hierarchy< / span > < / a > < / li >
< li > < a href = "functions.html" > < span > Class Members< / span > < / a > < / li >
< / ul >
< / div >
< / div >
< div class = "contents" >
< h1 > TiXmlAttribute Class Reference< / h1 > <!-- doxytag: class="TiXmlAttribute" --> <!-- doxytag: inherits="TiXmlBase" -->
< p > An attribute is a name-value pair.
< a href = "#_details" > More...< / a > < / p >
< p > < code > #include < < a class = "el" href = "tinyxml_8h_source.html" > tinyxml.h< / a > > < / code > < / p >
< div class = "dynheader" >
Inheritance diagram for TiXmlAttribute:< / div >
< div class = "dynsection" >
< div class = "center" >
< img src = "classTiXmlAttribute.png" usemap = "#TiXmlAttribute_map" alt = "" / >
< map id = "TiXmlAttribute_map" name = "TiXmlAttribute_map" >
< area href = "classTiXmlBase.html" alt = "TiXmlBase" shape = "rect" coords = "0,0,90,24" / >
2012-09-19 15:15:01 +00:00
< / map >
2013-03-13 08:00:12 +00:00
< / div >
< / div >
2012-09-19 15:15:01 +00:00
2013-03-13 08:00:12 +00:00
< p > < a href = "classTiXmlAttribute-members.html" > List of all members.< / a > < / p >
< table border = "0" cellpadding = "0" cellspacing = "0" >
< tr > < td colspan = "2" > < h2 > Public Member Functions< / h2 > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a9cfa3c8179873fd485d83003b114f8e1" > < / a > <!-- doxytag: member="TiXmlAttribute::TiXmlAttribute" ref="a9cfa3c8179873fd485d83003b114f8e1" args="()" -->
< / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#a9cfa3c8179873fd485d83003b114f8e1" > TiXmlAttribute< / a > ()< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Construct an empty attribute. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a052213522caac3979960e0714063861d" > < / a > <!-- doxytag: member="TiXmlAttribute::TiXmlAttribute" ref="a052213522caac3979960e0714063861d" args="(const std::string &_name, const std::string &_value)" -->
< / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#a052213522caac3979960e0714063861d" > TiXmlAttribute< / a > (const std::string & _name, const std::string & _value)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > std::string constructor. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a759d0b76fb8fcf765ecab243bc14f05e" > < / a > <!-- doxytag: member="TiXmlAttribute::TiXmlAttribute" ref="a759d0b76fb8fcf765ecab243bc14f05e" args="(const char *_name, const char *_value)" -->
< / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#a759d0b76fb8fcf765ecab243bc14f05e" > TiXmlAttribute< / a > (const char *_name, const char *_value)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Construct an attribute with a name and value. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a298a57287d305904ba6bd96ae6f78d3d" > < / a > <!-- doxytag: member="TiXmlAttribute::Name" ref="a298a57287d305904ba6bd96ae6f78d3d" args="() const " -->
const char * < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#a298a57287d305904ba6bd96ae6f78d3d" > Name< / a > () const < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Return the name of this attribute. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a0f874490eac8ca00ee0070765d0e97e3" > < / a > <!-- doxytag: member="TiXmlAttribute::Value" ref="a0f874490eac8ca00ee0070765d0e97e3" args="() const " -->
const char * < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#a0f874490eac8ca00ee0070765d0e97e3" > Value< / a > () const < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Return the value of this attribute. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a87705c3ccf9ee9417beb4f7cbacd4d33" > < / a > <!-- doxytag: member="TiXmlAttribute::ValueStr" ref="a87705c3ccf9ee9417beb4f7cbacd4d33" args="() const " -->
const std::string & < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#a87705c3ccf9ee9417beb4f7cbacd4d33" > ValueStr< / a > () const < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Return the value of this attribute. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "aa1a20ad59dc7e89a0ab265396360d50f" > < / a > <!-- doxytag: member="TiXmlAttribute::IntValue" ref="aa1a20ad59dc7e89a0ab265396360d50f" args="() const " -->
int < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#aa1a20ad59dc7e89a0ab265396360d50f" > IntValue< / a > () const < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Return the value of this attribute, converted to an integer. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a2880ddef53fc7522c99535273954d230" > < / a > <!-- doxytag: member="TiXmlAttribute::DoubleValue" ref="a2880ddef53fc7522c99535273954d230" args="() const " -->
double < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#a2880ddef53fc7522c99535273954d230" > DoubleValue< / a > () const < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Return the value of this attribute, converted to a double. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > int < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#ad6c93088ee21af41a107931223339344" > QueryIntValue< / a > (int *_value) const < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > QueryIntValue examines the value string. < a href = "#ad6c93088ee21af41a107931223339344" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ac87b2a8489906a5d7aa2875f20be3513" > < / a > <!-- doxytag: member="TiXmlAttribute::QueryDoubleValue" ref="ac87b2a8489906a5d7aa2875f20be3513" args="(double *_value) const " -->
int < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#ac87b2a8489906a5d7aa2875f20be3513" > QueryDoubleValue< / a > (double *_value) const < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > QueryDoubleValue examines the value string. See < a class = "el" href = "classTiXmlAttribute.html#ad6c93088ee21af41a107931223339344" title = "QueryIntValue examines the value string." > QueryIntValue()< / a > . < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ab7fa3d21ff8d7c5764cf9af15b667a99" > < / a > <!-- doxytag: member="TiXmlAttribute::SetName" ref="ab7fa3d21ff8d7c5764cf9af15b667a99" args="(const char *_name)" -->
void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#ab7fa3d21ff8d7c5764cf9af15b667a99" > SetName< / a > (const char *_name)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Set the name of this attribute. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a2dae44178f668b3cb48101be4f2236a0" > < / a > <!-- doxytag: member="TiXmlAttribute::SetValue" ref="a2dae44178f668b3cb48101be4f2236a0" args="(const char *_value)" -->
void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#a2dae44178f668b3cb48101be4f2236a0" > SetValue< / a > (const char *_value)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Set the value. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a7e065df640116a62ea4f4b7da5449cc8" > < / a > <!-- doxytag: member="TiXmlAttribute::SetIntValue" ref="a7e065df640116a62ea4f4b7da5449cc8" args="(int _value)" -->
void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#a7e065df640116a62ea4f4b7da5449cc8" > SetIntValue< / a > (int _value)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Set the value from an integer. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a0316da31373496c4368ad549bf711394" > < / a > <!-- doxytag: member="TiXmlAttribute::SetDoubleValue" ref="a0316da31373496c4368ad549bf711394" args="(double _value)" -->
void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#a0316da31373496c4368ad549bf711394" > SetDoubleValue< / a > (double _value)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Set the value from a double. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ab296ff0c9a8c701055cd257a8a976e57" > < / a > <!-- doxytag: member="TiXmlAttribute::SetName" ref="ab296ff0c9a8c701055cd257a8a976e57" args="(const std::string &_name)" -->
void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#ab296ff0c9a8c701055cd257a8a976e57" > SetName< / a > (const std::string & _name)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > STL std::string form. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ab43f67a0cc3ec1d80e62606500f0925f" > < / a > <!-- doxytag: member="TiXmlAttribute::SetValue" ref="ab43f67a0cc3ec1d80e62606500f0925f" args="(const std::string &_value)" -->
void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#ab43f67a0cc3ec1d80e62606500f0925f" > SetValue< / a > (const std::string & _value)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > STL std::string form. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a1c78e92e223a40843f644ba48ef69f67" > < / a > <!-- doxytag: member="TiXmlAttribute::Next" ref="a1c78e92e223a40843f644ba48ef69f67" args="() const " -->
const < a class = "el" href = "classTiXmlAttribute.html" > TiXmlAttribute< / a > * < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#a1c78e92e223a40843f644ba48ef69f67" > Next< / a > () const < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Get the next sibling attribute in the DOM. Returns null at end. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a6ebbfe333fe76cd834bd6cbcca3130cf" > < / a > <!-- doxytag: member="TiXmlAttribute::Previous" ref="a6ebbfe333fe76cd834bd6cbcca3130cf" args="() const " -->
const < a class = "el" href = "classTiXmlAttribute.html" > TiXmlAttribute< / a > * < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#a6ebbfe333fe76cd834bd6cbcca3130cf" > Previous< / a > () const < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Get the previous sibling attribute in the DOM. Returns null at beginning. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > virtual void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlAttribute.html#acc04956c1d5c4c31fe74f7a7528d109a" > Print< / a > (FILE *cfile, int depth) const < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode. < a href = "#acc04956c1d5c4c31fe74f7a7528d109a" > < / a > < br / > < / td > < / tr >
2012-09-19 15:15:01 +00:00
< / table >
2013-03-13 08:00:12 +00:00
< hr / > < a name = "_details" > < / a > < h2 > Detailed Description< / h2 >
< p > An attribute is a name-value pair. < / p >
< p > Elements have an arbitrary number of attributes, each with a unique name.< / p >
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > The attributes are not TiXmlNodes, since they are not part of the tinyXML document object model. There are other suggested ways to look at this problem. < / dd > < / dl >
< hr / > < h2 > Member Function Documentation< / h2 >
< a class = "anchor" id = "acc04956c1d5c4c31fe74f7a7528d109a" > < / a > <!-- doxytag: member="TiXmlAttribute::Print" ref="acc04956c1d5c4c31fe74f7a7528d109a" args="(FILE *cfile, int depth) const " -->
2012-09-19 15:15:01 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2013-03-13 08:00:12 +00:00
< td class = "memname" > virtual void TiXmlAttribute::Print < / td >
2012-09-19 15:15:01 +00:00
< td > (< / td >
< td class = "paramtype" > FILE * < / td >
< td class = "paramname" > < em > cfile< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int < / td >
< td class = "paramname" > < em > depth< / em > < / td > < td > < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
2013-03-13 08:00:12 +00:00
< td > < / td > < td > < / td > < td > const< code > [inline, virtual]< / code > < / td >
2012-09-19 15:15:01 +00:00
< / tr >
< / table >
< / div >
< div class = "memdoc" >
2013-03-13 08:00:12 +00:00
< p > All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode. < / p >
< p > ) Either or both cfile and str can be null.< / p >
< p > This is a formatted print, and will insert tabs and newlines.< / p >
< p > (For an unformatted stream, use the < < operator.) < / p >
< p > Implements < a class = "el" href = "classTiXmlBase.html#a0de56b3f2ef14c65091a3b916437b512" > TiXmlBase< / a > .< / p >
< / div >
2012-09-19 15:15:01 +00:00
< / div >
2013-03-13 08:00:12 +00:00
< a class = "anchor" id = "ad6c93088ee21af41a107931223339344" > < / a > <!-- doxytag: member="TiXmlAttribute::QueryIntValue" ref="ad6c93088ee21af41a107931223339344" args="(int *_value) const " -->
2012-09-19 15:15:01 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2013-03-13 08:00:12 +00:00
< td class = "memname" > int TiXmlAttribute::QueryIntValue < / td >
2012-09-19 15:15:01 +00:00
< td > (< / td >
< td class = "paramtype" > int * < / td >
2013-03-13 08:00:12 +00:00
< td class = "paramname" > < em > _value< / em > < / td >
2012-09-19 15:15:01 +00:00
< td > ) < / td >
2013-03-13 08:00:12 +00:00
< td > const< / td >
2012-09-19 15:15:01 +00:00
< / tr >
< / table >
< / div >
< div class = "memdoc" >
2013-03-13 08:00:12 +00:00
< p > QueryIntValue examines the value string. < / p >
< p > It is an alternative to the < a class = "el" href = "classTiXmlAttribute.html#aa1a20ad59dc7e89a0ab265396360d50f" title = "Return the value of this attribute, converted to an integer." > IntValue()< / a > method with richer error checking. If the value is an integer, it is stored in 'value' and the call returns TIXML_SUCCESS. If it is not an integer, it returns TIXML_WRONG_TYPE.< / p >
< p > A specialized but useful call. Note that for success it returns 0, which is the opposite of almost all other TinyXml calls. < / p >
< / div >
< / div >
< hr / > The documentation for this class was generated from the following file:< ul >
< li > < a class = "el" href = "tinyxml_8h_source.html" > tinyxml.h< / a > < / li >
< / ul >
2012-09-19 15:15:01 +00:00
< / div >
2013-03-13 08:00:12 +00:00
< hr size = "1" / > < address style = "text-align: right;" > < small > Generated by
2012-09-19 15:15:01 +00:00
< a href = "http://www.doxygen.org/index.html" >
2013-03-13 08:00:12 +00:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / > < / a > 1.6.2 < / small > < / address >
2012-09-19 15:15:01 +00:00
< / body >
< / html >
