<!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.5 2004/06/12 01:58:25 sbooth Exp $ -->
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>cgicc: Library Overview</title>
<link rev="made" href="mailto:bug-cgicc@gnu.org" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="cgicc-doc.css" rel="stylesheet" type="text/css" />
</head>
<body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1><a class="anchor" name="lib_overview">Library Overview </a></h1>The GNU cgicc library contains classes divided into two broad groups, CGI classes and response generation classes.<p>
<div class="header">CGI classes</div>
<div class="subsection">
<p>
CGI classes are used to query and manipulate CGI data, including information on the HTTP server, the current request, and the submitted form data.<p>
<a class="el" href="classcgicc_1_1Cgicc.html" title="The main class of the GNU cgicc library.">cgicc::Cgicc</a> is the main class of the cgicc library. It is used to retrieve information on specific HTML form elements (such as checkboxes, radio buttons, and text fields), on uploaded files, and to save, restore, and retrieve information on the CGI environment.<p>
<a class="el" href="classcgicc_1_1CgiEnvironment.html" title="Class encapsulating the CGI runtime environment.">cgicc::CgiEnvironment</a> encapsulates the data passed from the HTTP server to the CGI application. This includes all environment variables set by the HTTP server specified in the CGI standard.<p>
<a class="el" href="classcgicc_1_1FormEntry.html" title="Class representing a single HTML form entry.">cgicc::FormEntry</a> is an immutable class representing a single user entry in an HTML form element such as a text field, a radio button, or a checkbox. A FormEntry is essentially a name/value pair, where the name is the name of the form element as specified in the HTML form itself, and the value is user-entered or user-selected value. FormEntry provides methods allowing access to the value as a string, integer, or double.<p>
<a class="el" href="classcgicc_1_1FormFile.html" title="Class representing a file submitted via an HTML form.">cgicc::FormFile</a> is an immutable class representing a file uploaded via the HTTP file upload mechanism. A FormFile is very similar to a FormEntry, but does not provide the numerous methods for accessing the value as different types.<p>
</div>
<p>
<div class="header">Response generation classes</div>
<div class="subsection">
<p>
Response generation classes are used to generate responses to a CGI query. Generally, the response will consist of one or more HTTP headers followed by HTML text, but the CGI application may return data of any type. The response generation classes are subdivided into two groups:<p>
<ol>
<li>
<em>HTTP header classes</em><br>
HTTP header classes are used to indicate to the client information on the data being returned as a result of the CGI request. For example, standard HTTP headers indicate the type, size, and modification date of the transmitted data.<br>
<p>
An <a class="el" href="classcgicc_1_1HTTPCookie.html" title="An HTTP cookie.">cgicc::HTTPCookie</a> is a name/value pair used to store a piece of information about the caller using the caller's own machine. Cookies are often used as a means to identify users. Any of cgicc's header classes may contain an arbitrary number of cookies.<p>
<a class="el" href="classcgicc_1_1HTTPHeader.html" title="Abstract base class for all simple HTTP response headers.">cgicc::HTTPHeader</a> is the base class for all simple HTTP headers. It is rarely used directly; instead, use one of the provided subclasses.<p>
<a class="el" href="classcgicc_1_1HTTPContentHeader.html" title="HTTP header for data of a specified MIME type.">cgicc::HTTPContentHeader</a> is a subclass of <a class="el" href="classcgicc_1_1HTTPHeader.html" title="Abstract base class for all simple HTTP response headers.">cgicc::HTTPHeader</a> used to indicate the type of data returned to the client by the CGI application.<p>
<a class="el" href="classcgicc_1_1HTTPRedirectHeader.html" title="Class for redirecting the client to a different URI.">cgicc::HTTPRedirectHeader</a> is a subclass of <a class="el" href="classcgicc_1_1HTTPHeader.html" title="Abstract base class for all simple HTTP response headers.">cgicc::HTTPHeader</a> used to redirect the client to a different URL.<p>
<a class="el" href="classcgicc_1_1HTTPStatusHeader.html" title="HTTP header to set a specific request status.">cgicc::HTTPStatusHeader</a> is a subclass of <a class="el" href="classcgicc_1_1HTTPHeader.html" title="Abstract base class for all simple HTTP response headers.">cgicc::HTTPHeader</a> used to return a 3-digit HTTP status code and the associated message.<p>
<a class="el" href="classcgicc_1_1HTTPHTMLHeader.html" title="Shortcut to HTTPContentHeader for text/html.">cgicc::HTTPHTMLHeader</a> is a subclass of <a class="el" href="classcgicc_1_1HTTPContentHeader.html" title="HTTP header for data of a specified MIME type.">cgicc::HTTPContentHeader</a> used for data of MIME type <code>text/html</code>.<p>
<a class="el" href="classcgicc_1_1HTTPPlainHeader.html" title="Shortcut to HTTPContentHeader for text/html.">cgicc::HTTPPlainHeader</a> is a subclass of <a class="el" href="classcgicc_1_1HTTPContentHeader.html" title="HTTP header for data of a specified MIME type.">cgicc::HTTPContentHeader</a> used for data of MIME type <code>text/plain</code>.<p>
<a class="el" href="classcgicc_1_1HTTPResponseHeader.html" title="Generic HTTP response header.">cgicc::HTTPResponseHeader</a> is a more powerful, generic HTTP header class used to construct a full HTTP response. <p>
</li>
<li>
<em>HTML generation classes</em><br>
HTML generation classes are used to generate an HTML response following any HTTP headers. To be compliant with the HTML 4.0 standard, the response must consist of three parts (For a complete description see the HTML 4.0 specification at <a href="http://www.w3.org/TR/REC-html40/">http://www.w3.org/TR/REC-html40/</a>):<p>
<ul>
<li>
A line containing the HTML version information </li>
<li>
A declarative header section (delimited by the <code>head</code> element) </li>
<li>
A body, which contains the document's actual content<p>
The cgicc library provides one class for each HTML element defined in the HTML 4.0 specification. In all cases, the name of the class corresponds to the name of the HTML element. cgicc tries to produce SGML (and therefore XML) compliant output- thus, atomic elements such as <code>br</code> as rendered as <code><br</code> />.<p>
There are two special HTML classes defined by cgicc:<p>
<a class="el" href="classcgicc_1_1HTMLDoctype.html" title="Specifies the DTD of the HTML 4 document.">cgicc::HTMLDoctype</a> is used to specify the HTML version information as required by the HTML 4.0 standard<p>
<a class="el" href="classcgicc_1_1comment.html" title="An HTML comment.">cgicc::comment</a> is used to indicate an HTML comment </li>
</ul>
</li>
</ol>
</div>
<p>
<div class="nav">
Previous: <a class="el" href="cgi_overview.html">Overview of the Common Gateway Interface</a> | Current: <a class="el" href="lib_overview.html">Library Overview</a> | Next: <a class="el" href="cgicc_tutorial.html">A Tutorial Example</a>
</div>
</div>
<!-- $Id: footer.html,v 1.7 2004/06/12 01:58:25 sbooth Exp $ -->
<hr>
<address><small>
<a href="http://www.cgicc.org">GNU cgicc</a> - A C++ class library for
writing CGI applications<br />
Copyright © 1996 - 2004
<a href="mailto:sboothATgnuDOTorg">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 Tue Jun 9 15:03:49 2009 for cgicc by
<a HREF="http://www.doxygen.org/index.html">doxygen</a> 1.5.9
</small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
82bf76c75b44c3e54c5dc9d8c4b11ab5
>
files
>
250
