The main class of the GNU cgicc library. More...
#include <cgicc/Cgicc.h>
Public Member Functions | |
Constructors and Destructor | |
Cgicc (CgiInput *input=0) | |
Constructor. | |
Cgicc (const Cgicc &cgi) | |
Copy constructor. | |
~Cgicc () | |
Destructor. | |
Overloaded Operators | |
bool | operator== (const Cgicc &cgi) const |
Compare two Cgiccs for equality. | |
bool | operator!= (const Cgicc &cgi) const |
Compare two Cgiccs for inequality. | |
Cgicc & | operator= (const Cgicc &cgi) |
Assign one Cgicc to another. | |
Library Information | |
Information on this installation of cgicc | |
const char * | getCompileDate () const |
Get the date on which this library was compiled. | |
const char * | getCompileTime () const |
Get the time at which this library was compiled. | |
const char * | getVersion () const |
Get the version number of cgicc. | |
const char * | getHost () const |
Get the platform for which Cgicc was configured. | |
Form Element Access | |
Information on submitted form elements | |
bool | queryCheckbox (const std::string &elementName) const |
Query whether a checkbox is checked. | |
form_iterator | operator[] (const std::string &name) |
Find a radio button in a radio group, or a selected list item. | |
std::string | operator() (const std::string &name) const |
Find a radio button in a radio group, or a selected list item. | |
const_form_iterator | operator[] (const std::string &name) const |
Find a radio button in a radio group, or a selected list item. | |
form_iterator | getElement (const std::string &name) |
Find a radio button in a radio group, or a selected list item. | |
const_form_iterator | getElement (const std::string &name) const |
Find a radio button in a radio group, or a selected list item. | |
bool | getElement (const std::string &name, std::vector< FormEntry > &result) const |
Find multiple checkboxes in a group or selected items in a list. | |
form_iterator | getElementByValue (const std::string &value) |
Find a radio button in a radio group, or a selected list item. | |
const_form_iterator | getElementByValue (const std::string &value) const |
Find a radio button in a radio group, or a selected list item. | |
bool | getElementByValue (const std::string &value, std::vector< FormEntry > &result) const |
Find multiple checkboxes in a group or selected items in a list. | |
const std::vector< FormEntry > & | operator* () const |
Get all the submitted form entries, excluding files. | |
const std::vector< FormEntry > & | getElements () const |
Get all the submitted form elements, excluding files. | |
Uploaded File Access | |
file_iterator | getFile (const std::string &name) |
Find an uploaded file. | |
const_file_iterator | getFile (const std::string &name) const |
Find an uploaded file. | |
const std::vector< FormFile > & | getFiles () const |
Environment Access | |
const CgiEnvironment & | getEnvironment () const |
Save and Restore | |
void | save (const std::string &filename) const |
Save the current CGI environment to a file. | |
void | restore (const std::string &filename) |
Restore from a previously-saved CGI environment. | |
The main class of the GNU cgicc library.
Cgicc 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.
Normally, you will instantiate an object of this type in main()
:
cgicc::Cgicc::Cgicc | ( | CgiInput * | input = 0 | ) |
|
inline |
cgicc::Cgicc::~Cgicc | ( | ) |
Destructor.
Delete this Cgicc object
const char * cgicc::Cgicc::getCompileDate | ( | ) | const |
Get the date on which this library was compiled.
This is a string of the form mmm dd yyyy
.
const char * cgicc::Cgicc::getCompileTime | ( | ) | const |
Get the time at which this library was compiled.
This is a string of the form hh:mm:ss
in 24-hour time.
form_iterator cgicc::Cgicc::getElement | ( | const std::string & | name | ) |
Find a radio button in a radio group, or a selected list item.
name | The name of the radio button or list item to find. |
Referenced by main().
const_form_iterator cgicc::Cgicc::getElement | ( | const std::string & | name | ) | const |
Find a radio button in a radio group, or a selected list item.
name | The name of the radio button or list item to find. |
bool cgicc::Cgicc::getElement | ( | const std::string & | name, |
std::vector< FormEntry > & | result | ||
) | const |
Find multiple checkboxes in a group or selected items in a list.
name | The name of the checkboxes or list to find. |
result | A vector to hold the result. |
true
if any elements were found, false
if not. form_iterator cgicc::Cgicc::getElementByValue | ( | const std::string & | value | ) |
Find a radio button in a radio group, or a selected list item.
value | The value of the radio button or list item to find. |
const_form_iterator cgicc::Cgicc::getElementByValue | ( | const std::string & | value | ) | const |
Find a radio button in a radio group, or a selected list item.
value | The value of the radio button or list item to find. |
bool cgicc::Cgicc::getElementByValue | ( | const std::string & | value, |
std::vector< FormEntry > & | result | ||
) | const |
Find multiple checkboxes in a group or selected items in a list.
value | The value of the checkboxes or list to find. |
result | A vector to hold the result. |
|
inline |
|
inline |
file_iterator cgicc::Cgicc::getFile | ( | const std::string & | name | ) |
Find an uploaded file.
name | The name of the file. |
const_file_iterator cgicc::Cgicc::getFile | ( | const std::string & | name | ) | const |
Find an uploaded file.
name | The name of the file. |
|
inline |
const char * cgicc::Cgicc::getHost | ( | ) | const |
Get the platform for which Cgicc was configured.
The host is a string of the form processor-manufacturer-os
return The host triplet.
const char * cgicc::Cgicc::getVersion | ( | ) | const |
Get the version number of cgicc.
The version number is a string of the form #
.#.
|
inline |
std::string cgicc::Cgicc::operator() | ( | const std::string & | name | ) | const |
Find a radio button in a radio group, or a selected list item.
name | The name of the radio button or list item to find. |
|
inline |
|
inline |
|
inline |
|
inline |
bool cgicc::Cgicc::queryCheckbox | ( | const std::string & | elementName | ) | const |
Query whether a checkbox is checked.
elementName | The name of the element to query |
true
if the desired checkbox was checked, false
if not void cgicc::Cgicc::restore | ( | const std::string & | filename | ) |
Restore from a previously-saved CGI environment.
This is useful for debugging CGI applications.
filename | The name of the file from which to restore. |
void cgicc::Cgicc::save | ( | const std::string & | filename | ) | const |
Save the current CGI environment to a file.
This is useful for debugging CGI applications.
filename | The name of the file to which to save. |