<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> <html lang="en" dir="LTR"> <head> <!-- $Id: header.html,v 1.3 2002/03/09 18:30:37 sbooth Exp $ --> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <title>cgicc::HTMLElementList class Reference</title> <link rev="made" href="mailto:bug-cgicc@gnu.org" /> <link href="cgicc-doc.css" rel="stylesheet" type="text/css" /> </head> <body> <!-- Generated by Doxygen 1.2.13.1 --> <center> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center> <hr><h1>cgicc::HTMLElementList Class Reference</h1>An expandable list of <a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> objects. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="HTMLElementList_8h-source.html">cgicc/HTMLElementList.h</a>></code> <p> <a href="classcgicc_1_1HTMLElementList-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> <tr><td colspan="2"><div class="groupHeader">Constructors and Destructor</div></td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classcgicc_1_1HTMLElementList.html#z40_0">HTMLElementList</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Create an empty <a class="el" href="classcgicc_1_1HTMLElementList.html">HTMLElementList</a>.</em> <a href="#z40_0">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classcgicc_1_1HTMLElementList.html#z40_1">HTMLElementList</a> (const <a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> &head)</td></tr> <tr><td> </td><td><font size=-1><em>Create a new <a class="el" href="classcgicc_1_1HTMLElementList.html">HTMLElementList</a>, specifying the first element.</em> <a href="#z40_1">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classcgicc_1_1HTMLElementList.html#z40_2">HTMLElementList</a> (const HTMLElementList &list)</td></tr> <tr><td> </td><td><font size=-1><em>Copy constructor.</em> <a href="#z40_2">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classcgicc_1_1HTMLElementList.html#z40_3">~HTMLElementList</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Destructor.</em> <a href="#z40_3">More...</a><em></em></font><br><br></td></tr> <tr><td colspan="2"><div class="groupHeader">Overloaded Operators</div></td></tr> <tr><td nowrap align=right valign=top>HTMLElementList & </td><td valign=bottom><a class="el" href="classcgicc_1_1HTMLElementList.html#z41_0">operator=</a> (const HTMLElementList &list)</td></tr> <tr><td> </td><td><font size=-1><em>Assignment operator.</em> <a href="#z41_0">More...</a><em></em></font><br><br></td></tr> <tr><td colspan="2"><div class="groupHeader">List Management</div></td></tr> <tr><td colspan="2"><div class="groupText">Manage the elements in the list<br><br></div></td></tr> <tr><td nowrap align=right valign=top>HTMLElementList & </td><td valign=bottom><a class="el" href="classcgicc_1_1HTMLElementList.html#z42_0">add</a> (const <a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> &element)</td></tr> <tr><td> </td><td><font size=-1><em>Add an <a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> to the list.</em> <a href="#z42_0">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>HTMLElementList & </td><td valign=bottom><a class="el" href="classcgicc_1_1HTMLElementList.html#z42_1">add</a> (<a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> *element)</td></tr> <tr><td> </td><td><font size=-1><em>Add an <a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> to the list.</em> <a href="#z42_1">More...</a><em></em></font><br><br></td></tr> <tr><td colspan="2"><div class="groupHeader"></div></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classcgicc_1_1HTMLElementList.html#z43_0">render</a> (std::ostream &out) const</td></tr> <tr><td> </td><td><font size=-1><em>Render this <a class="el" href="classcgicc_1_1HTMLElementList.html">HTMLElementList</a>.</em> <a href="#z43_0">More...</a><em></em></font><br><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> An expandable list of <a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> objects. <p> <p> An <a class="el" href="classcgicc_1_1HTMLElementList.html">HTMLElementList</a> represents any number of <a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> objects. To add <a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> objects to the list, use the <a class="el" href="classcgicc_1_1HTMLElementList.html#z42_0">add</a>() methods: <div class="fragment"><pre> <a class="code" href="classcgicc_1_1HTMLElementList.html">cgicc::HTMLElementList</a> list; list.<a class="code" href="classcgicc_1_1HTMLElementList.html#z42_0">add</a>(br()); </pre></div> <dl compact><dt><b> See also: </b><dd> <a class="el" href="classcgicc_1_1HTMLAttribute.html">HTMLAttribute</a> , <a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> </dl> <p> <p> Definition at line <a class="el" href="HTMLElementList_8h-source.html#l00065">65</a> of file <a class="el" href="HTMLElementList_8h-source.html">HTMLElementList.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> <a name="z40_0" doxytag="cgicc::HTMLElementList::HTMLElementList"></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"> cgicc::HTMLElementList::HTMLElementList </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </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> Create an empty <a class="el" href="classcgicc_1_1HTMLElementList.html">HTMLElementList</a>. <p> <p> HTMLElementLists are most often created with the <a class="el" href="classcgicc_1_1HTMLElementList.html#z42_0">add</a>() functions </td> </tr> </table> <a name="z40_1" doxytag="cgicc::HTMLElementList::HTMLElementList"></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"> cgicc::HTMLElementList::HTMLElementList </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> & </td> <td class="mdname1" valign="top" nowrap> <em>head</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> Create a new <a class="el" href="classcgicc_1_1HTMLElementList.html">HTMLElementList</a>, specifying the first element. <p> <p> The first element in the list is set to <code>head</code> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>head</em> </td><td> The first element of the list </td></tr> </table> </dl> </td> </tr> </table> <a name="z40_2" doxytag="cgicc::HTMLElementList::HTMLElementList"></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"> cgicc::HTMLElementList::HTMLElementList </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const HTMLElementList & </td> <td class="mdname1" valign="top" nowrap> <em>list</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> Copy constructor. <p> <p> Sets the elements in this list to those of <code>list</code> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>list</em> </td><td> The <a class="el" href="classcgicc_1_1HTMLElementList.html">HTMLElementList</a> to copy. </td></tr> </table> </dl> </td> </tr> </table> <a name="z40_3" doxytag="cgicc::HTMLElementList::~HTMLElementList"></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"> cgicc::HTMLElementList::~HTMLElementList </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </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> Destructor. <p> <p> Deletes this <a class="el" href="classcgicc_1_1HTMLElementList.html">HTMLElementList</a> object </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a name="z42_1" doxytag="cgicc::HTMLElementList::add"></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"> HTMLElementList& cgicc::HTMLElementList::add </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> * </td> <td class="mdname1" valign="top" nowrap> <em>element</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> Add an <a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> to the list. <p> <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>element</em> </td><td> The <a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> to add. </td></tr> </table> </dl><dl compact><dt><b> Returns: </b><dd> A reference to the <code>this</code> </dl> </td> </tr> </table> <a name="z42_0" doxytag="cgicc::HTMLElementList::add"></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"> HTMLElementList& cgicc::HTMLElementList::add </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> & </td> <td class="mdname1" valign="top" nowrap> <em>element</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> Add an <a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> to the list. <p> <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>element</em> </td><td> The <a class="el" href="classcgicc_1_1HTMLElement.html">HTMLElement</a> to add. </td></tr> </table> </dl><dl compact><dt><b> Returns: </b><dd> A reference to <code>this</code> </dl> </td> </tr> </table> <a name="z41_0" doxytag="cgicc::HTMLElementList::operator="></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"> HTMLElementList& cgicc::HTMLElementList::operator= </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const HTMLElementList & </td> <td class="mdname1" valign="top" nowrap> <em>list</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> Assignment operator. <p> <p> Sets the elements in this list to those of <code>list</code> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>list</em> </td><td> The <a class="el" href="classcgicc_1_1HTMLElementList.html">HTMLElementList</a> to copy </td></tr> </table> </dl><dl compact><dt><b> Returns: </b><dd> A reference to <code>this</code> </dl> </td> </tr> </table> <a name="z43_0" doxytag="cgicc::HTMLElementList::render"></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"> void cgicc::HTMLElementList::render </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">std::ostream & </td> <td class="mdname1" valign="top" nowrap> <em>out</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Render this <a class="el" href="classcgicc_1_1HTMLElementList.html">HTMLElementList</a>. <p> <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>out</em> </td><td> The ostream to which to write </td></tr> </table> </dl> </td> </tr> </table> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="HTMLElementList_8h-source.html">HTMLElementList.h</a></ul> <!-- $Id: footer.html,v 1.3 2002/03/09 18:30:37 sbooth Exp $ --> <hr> <address><small> GNU cgicc - A C++ class library for writing CGI applications<br /> Copyright © 1996 - 2002 <a href="mailto:sbooth@gnu.org">Stephen F. Booth</a><br /> Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front Cover Texts, and with no Back-Cover Texts.<br /> Documentation generated Sun Mar 17 16:40:58 2002 for cgicc by <a HREF="http://www.doxygen.org/index.html">doxygen</a> 1.2.13.1 </small></address> </body> </html>