<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Simple XML Subset Parser</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../index.html">Main Page</a>
<a href="group__Widgets.html">Widgets</a>
<a class="qindex" href="namespaces.html"> Namespaces</a>
<a href="../../tutorial/html/index.html"> Book</a>
</center>
<hr width="100%"/>
<!-- Generated by Doxygen 1.3-rc1 -->
<h1>Simple XML Subset Parser</h1>The <a class="el" href="namespaceGlib_1_1Markup.html">Glib::Markup</a> parser is intended to parse a simple markup format that's a subset of XML.
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classGlib_1_1Markup_1_1AttributeKeyLess.html">AttributeKeyLess</a></td></tr>
<tr><td> </td><td><font size=-1><em>Binary predicate used by <a class="el" href="classGlib_1_1Markup_1_1Parser.html#s0">Markup::Parser::AttributeMap</a>.</em> <a href="classGlib_1_1Markup_1_1AttributeKeyLess.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classGlib_1_1MarkupError.html">MarkupError</a></td></tr>
<tr><td> </td><td><font size=-1><em>Exception class for markup parsing errors.</em> <a href="classGlib_1_1MarkupError.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classGlib_1_1Markup_1_1ParseContext.html">ParseContext</a></td></tr>
<tr><td> </td><td><font size=-1><em>A parse context is used to parse marked-up documents.</em> <a href="classGlib_1_1Markup_1_1ParseContext.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classGlib_1_1Markup_1_1Parser.html">Parser</a></td></tr>
<tr><td> </td><td><font size=-1><em>The abstract markup parser base class.</em> <a href="classGlib_1_1Markup_1_1Parser.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef <a class="el" href="classGlib_1_1MarkupError.html">Glib::MarkupError</a> </td><td valign=bottom><a class="el" href="group__Markup.html#a0">Error</a></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a> </td><td valign=bottom><a class="el" href="group__Markup.html#a1">escape_text</a> (const <a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a>& text)</td></tr>
<tr><td> </td><td><font size=-1><em>Escapes text so that the markup parser will parse it verbatim.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="namespaceGlib_1_1Markup.html">Glib::Markup</a> parser is intended to parse a simple markup format that's a subset of XML.
<p>
This is a small, efficient, easy-to-use parser. It should not be used if you expect to interoperate with other applications generating full-scale XML. However, it's very useful for application data files, config files, etc. where you know your application will be the only one writing the file. Full-scale XML parsers should be able to parse the subset used by <a class="el" href="namespaceGlib_1_1Markup.html">Glib::Markup</a> parser, so you can easily migrate to full-scale XML at a later time if the need arises.
<p>
<a class="el" href="namespaceGlib_1_1Markup.html">Glib::Markup</a> is not guaranteed to signal an error on all invalid XML; the parser may accept documents that an XML parser would not. However, invalid XML documents are not considered valid <a class="el" href="namespaceGlib_1_1Markup.html">Glib::Markup</a> documents.
<p>
<dl compact><dt><b>Simplifications to XML include:</b></dt><dd></dd></dl>
<ul>
<li>Only UTF-8 encoding is allowed.</li><li>No user-defined entities.</li><li>Processing instructions, comments and the doctype declaration are "passed through" but are not interpreted in any way.</li><li>No DTD or validation.</li></ul>
<p>
<dl compact><dt><b>The markup format does support:</b></dt><dd></dd></dl>
<ul>
<li>Elements</li><li>Attributes</li><li>5 standard entities: <code>&amp; &lt; &gt; &quot; &apos;</code></li><li>Character references</li><li>Sections marked as <code>CDATA</code> </li></ul>
<hr><h2>Typedef Documentation</h2>
<a name="a0" doxytag="Glib::Markup::Error"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef <a class="el" href="classGlib_1_1MarkupError.html">Glib::MarkupError</a> Glib::Markup::Error
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a1" doxytag="Glib::Markup::escape_text"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a> escape_text </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">const <a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a>& </td>
<td class="mdname1" valign="top" nowrap> <em>text</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Escapes text so that the markup parser will parse it verbatim.
<p>
Less than, greater than, ampersand, etc. are replaced with the corresponding entities. This function would typically be used when writing out a file to be parsed with the markup parser. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>text</em> </td><td>Some valid UTF-8 text. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Escaped text. </dd></dl>
</td>
</tr>
</table>
<hr><address><small>
Generated for gtkmm by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.3-rc1 © 1997-2001</small></address>
</body>
</html>
