📄 a00014.html
字号:
<HTML><HEAD> <link rel="stylesheet" href="doxygen.css"><TITLE>Symbian XML Libarary</TITLE></HEAD><h2>SYXML - XML Parser and Generator Library for Symbian</h2><HR><!-- Generated by Doxygen 1.3.9.1 --><div class="qindex"><a class="qindex" href="../../index.html">Main Page</a> | <a class="qindex" href="../../hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="../../annotated.html">Class List</a> | <a class="qindex" href="../../files.html">File List</a> | <a class="qindex" href="../../functions.html">Class Members</a> | <a class="qindex" href="../../globals.html">File Members</a></div><h1>CSyGenerator Class Reference</h1><code>#include <<a class="el" href="../../d3/dfe/a00025.html">SyGen.h</a>></code><p><p>Inheritance diagram for CSyGenerator:<p><center><img src="../../d2/de7/a00014.png" usemap="#CSyGenerator_map" border="0" alt=""></center><map name="CSyGenerator_map"><area href="../../dd/d1b/a00015.html" alt="CSyGeneratorBase" shape="rect" coords="0,0,121,24"></map><a href="../../da/d45/a00011.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>Simple C++ class for generating XML data, rather than using hard coded strings. <p>In general as this class is dealing with memory, all the functions will leave if an error is encountered allocating memory. <p><table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual IMPORT_C </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/de7/a00014.html#CSyGeneratora0">~CSyGenerator</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage : Standard destructor. <a href="#CSyGeneratora0"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea1">StartDocumentL</a> (const TDesC &aEncoding, const TBool aStandalone, const TDesC &aPublicId, const TDesC &aSystemId)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Generates the XML header and sends it to the output handler. <a href="#CSyGeneratorBasea1"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea2">StartDocumentL</a> (const TBool aStandalone=ETrue)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Generates the default document handler. <a href="#CSyGeneratorBasea2"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea3">EndDocumentL</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Closes the XML document. <a href="#CSyGeneratorBasea3"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea4">StartFragmentL</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Starts the xml fragment. <a href="#CSyGeneratorBasea4"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea5">EndFragmentL</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Closes the XML fragment. <a href="#CSyGeneratorBasea5"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea6">StartElementL</a> (const TDesC &aName)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Starts an element that does not have a prefix. <a href="#CSyGeneratorBasea6"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea7">StartElementL</a> (const TDesC &aPrefix, const TDesC &aName)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Starts an element that has a prefix. <a href="#CSyGeneratorBasea7"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea8">EmptyElementL</a> (const TDesC &aName)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Starts an element that is an empty element. <a href="#CSyGeneratorBasea8"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea9">EmptyElementL</a> (const TDesC &aPrefix, const TDesC &aName)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Creates and empty element. <a href="#CSyGeneratorBasea9"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea10">SetNamespaceL</a> (const TDesC &aURI)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Declares a namespace within an element definition. <a href="#CSyGeneratorBasea10"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea11">SetNamespaceL</a> (const TDesC &aPrefix, const TDesC &aURI)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Assigns a prefix to a a namespace within an element definition. <a href="#CSyGeneratorBasea11"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea12">SetAttributeL</a> (const TDesC &aName, const TDesC &aValue)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Assigns an attribute to an element. <a href="#CSyGeneratorBasea12"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea13">SetAttributeL</a> (const TDesC &aPrefix, const TDesC &aName, const TDesC &aValue)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Assigns an attribute to an element. <a href="#CSyGeneratorBasea13"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea14">EndElementL</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Writes out the end element text for the current element. <a href="#CSyGeneratorBasea14"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea15">CharactersL</a> (const TDesC &aCharacters)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Writes out string to the output buffer. <a href="#CSyGeneratorBasea15"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea16">IgnorableWhitespaceL</a> (const TDesC &aCharacters)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Writes out string to the output buffer. <a href="#CSyGeneratorBasea16"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea17">ProcessingInstructionL</a> (const TDesC &aTarget, const TDesC &aData)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Writes out string a processing instruction to the xml writer. <a href="#CSyGeneratorBasea17"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea18">CommentL</a> (const TDesC &aComment)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Writes out string a comment to the xml writer. <a href="#CSyGeneratorBasea18"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea19">StartCDATAL</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Starts a CDATA Section. <a href="#CSyGeneratorBasea19"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea20">EndCDATAL</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Ends a CDATA Section. <a href="#CSyGeneratorBasea20"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C const TVersion </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasea21">VersionInfo</a> () const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: This should be used to get the version number of the XMLWriter. <a href="#CSyGeneratorBasea21"></a><br></td></tr><tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C <a class="el" href="../../d2/de7/a00014.html">CSyGenerator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/de7/a00014.html#CSyGeneratore0">NewLC</a> (<a class="el" href="../../dd/da2/a00019.html">MSyOutputHandler</a> &aOutput, const TInt aBufferSize=1024)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Standardized safe construction which leaves the instance of the generator on the cleanup stack. <a href="#CSyGeneratore0"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C <a class="el" href="../../d2/de7/a00014.html">CSyGenerator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/de7/a00014.html#CSyGeneratore1">NewL</a> (<a class="el" href="../../dd/da2/a00019.html">MSyOutputHandler</a> &aOutput, const TInt aBufferSize=1024)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Standardized safe construction which leaves nothing on the cleanup stack. <a href="#CSyGeneratore1"></a><br></td></tr><tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/de7/a00014.html#CSyGeneratorb0">CSyGenerator</a> (<a class="el" href="../../dd/da2/a00019.html">MSyOutputHandler</a> &aOutput)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage: Standardized constructor for a generator object. <a href="#CSyGeneratorb0"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/de7/a00014.html#CSyGeneratorb1">ConstructL</a> (const TInt aBufferSize)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage : Second phase of safe construction method. <a href="#CSyGeneratorb1"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBaseb1">BaseConstructL</a> (const TInt aBufferSize)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage : Second phase of safe construction method. <a href="#CSyGeneratorBaseb1"></a><br></td></tr><tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d1b/a00015.html#CSyGeneratorBasef0">Panic</a> (const TInt aPanic)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Intended Usage : Helper function to generate a panic. <a href="#CSyGeneratorBasef0"></a><br></td></tr></table><hr><h2>Constructor & Destructor Documentation</h2><a class="anchor" name="CSyGeneratora0" doxytag="CSyGenerator::~CSyGenerator"></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">CSyGenerator::~<a class="el" href="../../d2/de7/a00014.html">CSyGenerator</a> </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Intended Usage : Standard destructor. <p> </td> </tr></table><a class="anchor" name="CSyGeneratorb0" doxytag="CSyGenerator::CSyGenerator"></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">CSyGenerator::CSyGenerator </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="../../dd/da2/a00019.html">MSyOutputHandler</a> & </td> <td class="mdname1" valign="top" nowrap> <em>aOutput</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [protected]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Intended Usage: Standardized constructor for a generator object. <p><dl compact><dt><b>Exceptions:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>none</em> </td><td></td></tr> </table></dl><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>aOutput</em> </td><td>the output mixin interface </td></tr> </table></dl><dl compact><dt><b>Returns:</b></dt><dd>None. </dd></dl><dl compact><dt><b>Precondition:</b></dt><dd>None. </dd></dl><dl compact><dt><b>Postcondition:</b></dt><dd>Nothing is left on the CleanupStack </dd></dl> </td> </tr></table><hr><h2>Member Function Documentation</h2><a class="anchor" name="CSyGeneratorBaseb1" doxytag="CSyGenerator::BaseConstructL"></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void CSyGeneratorBase::BaseConstructL </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const TInt </td> <td class="mdname1" valign="top" nowrap> <em>aBufferSize</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [protected, inherited]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Intended Usage : Second phase of safe construction method. <p>It is intended that this function be called from the ConstructL of dervied classes <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>aBufferSize</em> </td><td>the intial size of the buffer. </td></tr> </table></dl><dl compact><dt><b>Precondition:</b></dt><dd>First phase of construction is complete. </dd></dl><dl compact><dt><b>Postcondition:</b></dt><dd>Object if fully constructed. </dd></dl> </td> </tr></table><a class="anchor" name="CSyGeneratorBasea15" doxytag="CSyGenerator::CharactersL"></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void CSyGeneratorBase::CharactersL </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const TDesC & </td> <td class="mdname1" valign="top" nowrap> <em>aCharacters</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inherited]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Intended Usage: Writes out string to the output buffer. <p>This is used to write out element contents and the data within a CDATA section. This can be called multiple times <dl compact><dt><b>Exceptions:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>KErrNoMemory</em> </td><td>if no memory for buffer. </td></tr> </table></dl><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>aCharacters</em> </td><td>the character data to be written out </td></tr> </table></dl><dl compact><dt><b>Returns:</b></dt><dd>none </dd></dl><dl compact><dt><b>Precondition:</b></dt><dd>StartElement must have been called </dd></dl><dl compact><dt><b>Postcondition:</b></dt><dd>none </dd></dl> </td> </tr></table><a class="anchor" name="CSyGeneratorBasea18" doxytag="CSyGenerator::CommentL"></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void CSyGeneratorBase::CommentL </td>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -