rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Data Access Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IliHTMLReporter Class Reference

Gadget class. More...

#include <ilviews/dataccess/gadgets/htmlrep.h>

Inheritance diagram for IliHTMLReporter:
IliDataGem IlvGadget IlvSimpleGraphic IlvGraphic

List of all members.

Public Member Functions

 IliHTMLReporter (IlvDisplay *display, const IlvPoint &at, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 This constructor creates an HTML reporter with a classic table model type.
virtual IlvBitmapgetBitmap () const
 Returns the bitmap that is displayed during the design phase in Rogue Wave Views Data Access.
const char * getColumnName (IlInt colno) const
 Returns a column title.
const char * getColumnValue (IliTableBuffer *buff, IlInt colno) const
 Returns a column value of one buffer.
const char * getColumnValue (IlInt colno) const
 Returns the column value of the current row.
IliDataSourcegetDataSource () const
 Returns the data source that will be used to create the document.
const char * getDataSourceName () const
 Return the data source name that will be used to create the document.
const char * getDocumentBackground () const
 Returns the document background color.
const char * getDocumentCopyright () const
 Returns the document copyright.
const char * getDocumentTitle () const
 Returns the document title.
const char * getFilename () const
 Returns the document file name.
const char * getFirstPagePictureName () const
 Returns the file name for the first page picture.
const char * getFirstPageTitle () const
 Returns the title for the first page.
const char * getModelName () const
 Returns the document model name.
IliHTMLModelName getPredefinedModel () const
 Returns the document model type.
IlInt getRowCount () const
 Returns the row count of the table.
const char * getRowLocationName () const
 Returns the row location name.
IlInt getRowNumber () const
 Returns the number of the current row.
IL_STDPREF ostream & getStream () const
 Returns the stream associated with the file.
const IliTablegetTable () const
 Returns the table used to create the document.
const IliTableBuffergetTableBuffer () const
 Returns the data of the current row.
const char * getTableOfContentsColumnName () const
 Returns the column name of the data source.
const char * getTableOfContentsEntry () const
 Returns the text for an entry of the table of contents.
const char * getTableOfContentsLocation () const
 Returns the table of contents entry location.
const char * getTableOfContentsTitle () const
 Returns the table of contents title.
IlBoolean hasTableOfContents () const
 Returns IlTrue if a table of contents will be created.
IlBoolean isColumnVisible (IlInt colno) const
 Returns IlTrue if a column is visible.
IlBoolean isTableOfContentsAtBeginning () const
 Returns IlTrue if the table of contents begins just after the first page.
void report ()
 Creates the document.
virtual void reportBeginDocument ()
 Called at the beginning of the document.
virtual void reportBeginRows ()
 Called just before the first row is created if the model is a table style. Otherwise, it is called just after each row is created.
virtual void reportEndDocument ()
 Called at the end of the document.
virtual void reportEndRows ()
 Called just after the last row is created if the model is a table style. Otherwise, it is called just after each row is created.
virtual void reportFirstPageContents ()
 Called to create the first page contents.
virtual void reportFirstPageFooting ()
 Called to create the first page footing.
virtual void reportFirstPageHeading ()
 Called to create the first page heading.
virtual void reportFooting ()
 Called to create the page footing.
virtual void reportHeading ()
 Called to create the page heading.
virtual void reportLastPageContents ()
 Called to create the contents of the last page.
virtual void reportLastPageFooting ()
 Called to create the last page footing.
virtual void reportLastPageHeading ()
 Called to create the last page heading.
virtual void reportRowContent ()
 Called to create the row contents.
virtual void reportTableBeginEntries ()
 Called just before the first entry is created.
virtual void reportTableEndEntries ()
 Called just after the last entry is created.
virtual void reportTableEntry ()
 Called to create an entry of the table of contents.
virtual void reportTableFooting ()
 Called to create the table of contents footing.
virtual void reportTableHeading ()
 Called to create the table of contents heading.
virtual void reportTableTitle ()
 Called to create the table of contents title.
void setDataSource (IliDataSource *ds)
 Sets the data source that will be used to create the document.
void setDataSourceName (const char *name)
 Sets the data source name that will be used to create the document.
void setDocumentBackground (const char *color)
 Sets the document background color.
void setDocumentCopyright (const char *cop)
 Sets the document copyright.
void setDocumentTitle (const char *title)
 Sets the document title.
void setFilename (const char *name)
 Sets the document file name.
void setFirstPagePictureName (const char *name)
 Sets the file name for the first page picture.
void setFirstPageTitle (const char *title)
 Sets the title for the first page.
void setModelName (const char *mod)
 Sets the document model name.
void setPredefinedModel (IliHTMLModelName mod)
 Sets the document model type.
void setTableOfContents (IlBoolean has)
 Indicates if the table of contents must be created.
void setTableOfContentsAtBeginning (IlBoolean)
 Specifies the location of the table of contents.
void setTableOfContentsColumnName (const char *name)
 Sets the column name of the data source.
void setTableOfContentsTitle (const char *title)
 Sets the table of contents title.
void tagBar (IlInt size=2)
 Writes the HTML tag horizontal bar.
void tagBeginBody (const char *color=0, const char *opt=0)
 Writes the HTML tag to define the beginning of the visible document.
void tagBeginBold ()
 Writes the HTML tag for begin bold.
void tagBeginCenter ()
 Writes the HTML tag for begin center.
void tagBeginCodeListing ()
 Writes the HTML tag for begin code listing.
void tagBeginFont (const char *opt=0)
 Writes the HTML tag for begin font.
void tagBeginForm (const char *opt=0)
 Writes the HTML tag for begin form.
void tagBeginHead ()
 Writes the HTML tag for begin head.
void tagBeginHeader (IlInt size=2, IlvAlignment align=IlvLeft)
 Writes the HTML tag to begin the headers.
void tagBeginHtml ()
 Writes the HTML tag for begin HTML document.
void tagBeginItalic ()
 Writes the HTML tag for begin italic.
void tagBeginList ()
 Writes the HTML tag for begin list.
void tagBeginListItem ()
 Writes the HTML tag for begin list item.
void tagBeginListOrdered ()
 Writes the HTML tag for begin ordered list.
void tagBeginScript (const char *opt=0)
 Writes the HTML tag for begin script.
void tagBeginStrong ()
 Writes the HTML tag for begin strong.
void tagBeginTable (const char *opt=0)
 Writes the HTML tag for begin table.
void tagBeginTableColumn (const char *opt=0)
 Writes the HTML tag for begin table column.
void tagBeginTableHeader (const char *opt=0)
 Writes the HTML tag for begin table header.
void tagBeginTableRow (const char *opt=0)
 Writes the HTML tag for begin table row.
void tagBeginUnderline ()
 Writes the HTML tag for begin underline.
void tagDefineLocation (const char *loc, const char *text)
 Writes the HTML tag to define a location.
void tagEndBody ()
 Writes the HTML tag for end body.
void tagEndBold ()
 Writes the HTML tag for end bold.
void tagEndCenter ()
 Writes the HTML tag for end center.
void tagEndCodeListing ()
 Writes the HTML tag for end code listing.
void tagEndFont ()
 Writes the HTML tag for end font.
void tagEndHead ()
 Writes the HTML tag for end head.
void tagEndHeader (IlInt=2)
 Writes the HTML tag to end headers.
void tagEndHtml ()
 Writes the HTML tag for end HTML document.
void tagEndItalic ()
 Writes the HTML tag for end italic.
void tagEndList ()
 Writes the HTML tag for end list.
void tagEndListItem ()
 Writes the HTML tag for end list item.
void tagEndListOrdered ()
 Writes the HTML tag for end ordered list.
void tagEndStrong ()
 Writes the HTML tag for end strong.
void tagEndTable ()
 Writes the HTML tag for end table.
void tagEndTableColumn ()
 Writes the HTML tag for end table column.
void tagEndTableHeader ()
 Writes the HTML tag for end table header.
void tagEndTableRow ()
 Writes the HTML tag for end table row.
void tagEndUnderline ()
 Writes the HTML tag for end underline.
void tagHeadTitle (const char *title)
 Writes the HTML tag to define the document title.
void tagLinkToFile (const char *file, const char *text)
 Writes the HTML tag to define a link to a file.
void tagLinkToFileLocation (const char *file, const char *loc, const char *txt)
 Writes the HTML tag to define a link to a location in a file.
void tagLinkToLocation (const char *link, const char *text)
 Writes the HTML tag to define a link to a location.
void tagNewLine (IlInt count=1)
 Writes several times the HTML tag new line.
void tagParagraph ()
 Writes the HTML tag new paragraph.
void tagPicture (const char *filename, const char *opt=0)
 Writes the HTML tag to insert a picture.
void tagSpace ()
 Writes the HTML tag for a space.
void tagText (const char *text)
 Writes text or HTML tags or both.
void tagTradeMark ()
 Writes the HTML tag for Trade Mark.

Static Public Member Functions

static IlvSymbol * ReportBeginDocumentSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportBeginRowsSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportEndDocumentSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportEndRowsSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportFirstPageContentsSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportFirstPageFootingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportFirstPageHeadingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportFootingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportHeadingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportLastPageContentsSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportLastPageFootingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportLastPageHeadingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportRowContentSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportTableBeginEntriesSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportTableEndEntriesSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportTableEntrySymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportTableFootingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportTableHeadingSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.
static IlvSymbol * ReportTableTitleSymbol ()
 Returns the name of the callback that will be called by the corresponding virtual member function.

Detailed Description

Gadget class.

Library: dbgadget

The IliHTMLReporter class defines a gadget that can be used to generate an HTML document containing the data of a data source. You can specify if you want a table of contents and if the table of contents is positioned after the first page of the document or before the last page of the document. There are four models of document:

Each part of the document is associated with a virtual function and a callback. The calling order depends on the type of document model:

Warning:
[note] A column is not written if it is not visible.
[note] If you define the callback rowContent, you must call tagDefineLocation function within your row description to insert the row location (used by table of contents). The row location is provided by the rowLocationName property.

About table of contents To create the table of contents, the HTML reporter uses the data of a data source column. For each row, there is a table of contents entry. The entry text is the content of the column for the row.

See also:
IliDataGem, IliXML.

Constructor & Destructor Documentation

IliHTMLReporter::IliHTMLReporter ( IlvDisplay display,
const IlvPoint at,
IlUShort  thickness = IlvDefaultGadgetThickness,
IlvPalette palette = 0 
)

This constructor creates an HTML reporter with a classic table model type.

Parameters:
display The display.
at The position.
thickness The border thickness.
palette The palette.

Member Function Documentation

virtual IlvBitmap* IliHTMLReporter::getBitmap (  )  const [virtual]

Returns the bitmap that is displayed during the design phase in Rogue Wave Views Data Access.

Returns:
The bitmap.

Reimplemented from IliDataGem.

const char* IliHTMLReporter::getColumnName ( IlInt  colno  )  const

Returns a column title.

Parameters:
colno The column position.
Returns:
The column title if the title is defined. Otherwise, it returns the column name.
const char* IliHTMLReporter::getColumnValue ( IliTableBuffer buff,
IlInt  colno 
) const

Returns a column value of one buffer.

Returns:
The column value of the buffer. If the column has a mapping, it returns the mapped value.
const char* IliHTMLReporter::getColumnValue ( IlInt  colno  )  const

Returns the column value of the current row.

Parameters:
colno The column position.
Returns:
The column value of the current row. If the column has a mapping, it returns the mapped value.
IliDataSource* IliHTMLReporter::getDataSource (  )  const

Returns the data source that will be used to create the document.

Returns:
The data source.
const char* IliHTMLReporter::getDataSourceName (  )  const

Return the data source name that will be used to create the document.

Returns:
The data source name.
const char * IliHTMLReporter::getDocumentBackground (  )  const

Returns the document background color.

Returns:
The color.
const char * IliHTMLReporter::getDocumentCopyright (  )  const

Returns the document copyright.

Returns:
The copyright.
const char * IliHTMLReporter::getDocumentTitle (  )  const

Returns the document title.

Returns:
The title.
const char* IliHTMLReporter::getFilename (  )  const

Returns the document file name.

Returns:
The file name.
const char * IliHTMLReporter::getFirstPagePictureName (  )  const

Returns the file name for the first page picture.

Returns:
The file name.
const char * IliHTMLReporter::getFirstPageTitle (  )  const

Returns the title for the first page.

Returns:
The title.
const char* IliHTMLReporter::getModelName (  )  const

Returns the document model name.

Returns:
The model name.
IliHTMLModelName IliHTMLReporter::getPredefinedModel (  )  const

Returns the document model type.

Obsolete Function

Returns:
The model name.
IlInt IliHTMLReporter::getRowCount (  )  const

Returns the row count of the table.

Returns:
The count.
const char* IliHTMLReporter::getRowLocationName (  )  const

Returns the row location name.

The location name is used by the table of contents.

Returns:
The row location name.
IlInt IliHTMLReporter::getRowNumber (  )  const

Returns the number of the current row.

Returns:
The row position.
IL_STDPREF ostream& IliHTMLReporter::getStream (  )  const

Returns the stream associated with the file.

The stream is valid only during the document creation.

Returns:
The stream.
const IliTable* IliHTMLReporter::getTable (  )  const

Returns the table used to create the document.

The table is valid only during the document creation.

Returns:
The table.
const IliTableBuffer* IliHTMLReporter::getTableBuffer (  )  const

Returns the data of the current row.

This buffer is valid only during the document creation.

Warning:
You must not release this buffer and must not call the rowToBuffer function on this buffer.
Returns:
The table buffer.
const char * IliHTMLReporter::getTableOfContentsColumnName (  )  const

Returns the column name of the data source.

Returns:
The column name.
const char* IliHTMLReporter::getTableOfContentsEntry (  )  const

Returns the text for an entry of the table of contents.

Returns:
The text.
const char* IliHTMLReporter::getTableOfContentsLocation (  )  const

Returns the table of contents entry location.

The location name is used to create the HTML link between the table of contents and the information in the document.

Returns:
The table of contents entry location.
const char * IliHTMLReporter::getTableOfContentsTitle (  )  const

Returns the table of contents title.

Returns:
The title.
IlBoolean IliHTMLReporter::hasTableOfContents (  )  const

Returns IlTrue if a table of contents will be created.

Returns:
IlTrue if a table of contents will be created.
IlBoolean IliHTMLReporter::isColumnVisible ( IlInt  colno  )  const

Returns IlTrue if a column is visible.

Parameters:
colno The column position.
IlBoolean IliHTMLReporter::isTableOfContentsAtBeginning (  )  const

Returns IlTrue if the table of contents begins just after the first page.

Returns:
IlTrue if the table of contents begins just after the first page.
static IlvSymbol* IliHTMLReporter::ReportBeginDocumentSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportBeginRowsSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportEndDocumentSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportEndRowsSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportFirstPageContentsSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportFirstPageFootingSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportFirstPageHeadingSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportFootingSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportHeadingSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportLastPageContentsSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportLastPageFootingSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportLastPageHeadingSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportRowContentSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportTableBeginEntriesSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportTableEndEntriesSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportTableEntrySymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportTableFootingSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportTableHeadingSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
static IlvSymbol* IliHTMLReporter::ReportTableTitleSymbol (  )  [static]

Returns the name of the callback that will be called by the corresponding virtual member function.

Returns:
The callback name.
void IliHTMLReporter::setDataSource ( IliDataSource ds  ) 

Sets the data source that will be used to create the document.

Parameters:
ds The data source.
void IliHTMLReporter::setDataSourceName ( const char *  name  ) 

Sets the data source name that will be used to create the document.

Parameters:
name The data source name.
void IliHTMLReporter::setDocumentBackground ( const char *  color  ) 

Sets the document background color.

The format of the color is rrggbb. (For more information, see your HTML documentation.)

Parameters:
color The color.
void IliHTMLReporter::setDocumentCopyright ( const char *  cop  ) 

Sets the document copyright.

Parameters:
cop The copyright.
void IliHTMLReporter::setDocumentTitle ( const char *  title  ) 

Sets the document title.

Parameters:
title The title.
void IliHTMLReporter::setFilename ( const char *  name  ) 

Sets the document file name.

Parameters:
name The file name.
void IliHTMLReporter::setFirstPagePictureName ( const char *  name  ) 

Sets the file name for the first page picture.

Parameters:
name The picture file name.
void IliHTMLReporter::setFirstPageTitle ( const char *  title  ) 

Sets the title for the first page.

Parameters:
title The title.
void IliHTMLReporter::setModelName ( const char *  mod  ) 

Sets the document model name.

Parameters:
mod The model name. The predefined models are:

  • IliHTMLModelTableClassic
  • IliHTMLModelFormClassic
  • IliHTMLModelTable
  • IliHTMLModelForm
  • IliHTMLModelFormDynamic
void IliHTMLReporter::setPredefinedModel ( IliHTMLModelName  mod  ) 

Sets the document model type.

Obsolete Function

Parameters:
mod The model name.
void IliHTMLReporter::setTableOfContents ( IlBoolean  has  ) 

Indicates if the table of contents must be created.

The default value is IlFalse.

Parameters:
has If IlTrue, the table of contents is created. In this case, a call to the setTableOfContentsColumnName method is required.
void IliHTMLReporter::setTableOfContentsAtBeginning ( IlBoolean  val  ) 

Specifies the location of the table of contents.

The default value is IlTrue.

Parameters:
beginning If IlTrue, the table of contents should begin just after the first page. Otherwise, the table of contents begins just before the last page.
void IliHTMLReporter::setTableOfContentsColumnName ( const char *  name  ) 

Sets the column name of the data source.

Parameters:
name The column name.
void IliHTMLReporter::setTableOfContentsTitle ( const char *  title  ) 

Sets the table of contents title.

The default value is "<code>Table of contents</code>".

Parameters:
title The title.
void IliHTMLReporter::tagBar ( IlInt  size = 2  ) 

Writes the HTML tag horizontal bar.

 HTML: <hr size=<size>>
Parameters:
size The bar size.
void IliHTMLReporter::tagBeginBody ( const char *  color = 0,
const char *  opt = 0 
)

Writes the HTML tag to define the beginning of the visible document.

 HTML: <body bgcolor="color" opt>
Parameters:
color The color.
opt The options (see HTML documentation).
void IliHTMLReporter::tagBeginBold (  ) 

Writes the HTML tag for begin bold.

 HTML: <b>
void IliHTMLReporter::tagBeginCenter (  ) 

Writes the HTML tag for begin center.

 HTML: <center>
void IliHTMLReporter::tagBeginCodeListing (  ) 

Writes the HTML tag for begin code listing.

 HTML: <pre>
void IliHTMLReporter::tagBeginFont ( const char *  opt = 0  ) 

Writes the HTML tag for begin font.

 HTML: <font opt>
Parameters:
opt The options (see HTML documentation).
void IliHTMLReporter::tagBeginForm ( const char *  opt = 0  ) 

Writes the HTML tag for begin form.

 HTML: <form opt>
Parameters:
opt The options (see HTML documentation).
void IliHTMLReporter::tagBeginHead (  ) 

Writes the HTML tag for begin head.

 HTML: <head>
void IliHTMLReporter::tagBeginHeader ( IlInt  size = 2,
IlvAlignment  align = IlvLeft 
)

Writes the HTML tag to begin the headers.

The most prominent header has the size set to 1 and the least prominent header has the size set to 6.

 HTML: <h<size> align=<align>>
Parameters:
size The size (from 1 to 6).
align The alignment.
void IliHTMLReporter::tagBeginHtml (  ) 

Writes the HTML tag for begin HTML document.

 HTML: <html>
void IliHTMLReporter::tagBeginItalic (  ) 

Writes the HTML tag for begin italic.

 HTML: <i>
void IliHTMLReporter::tagBeginList (  ) 

Writes the HTML tag for begin list.

 HTML: <ul>
void IliHTMLReporter::tagBeginListItem (  ) 

Writes the HTML tag for begin list item.

 HTML: <li>
void IliHTMLReporter::tagBeginListOrdered (  ) 

Writes the HTML tag for begin ordered list.

 HTML: <ol>
void IliHTMLReporter::tagBeginScript ( const char *  opt = 0  ) 

Writes the HTML tag for begin script.

 HTML: <script opt>
Parameters:
opt The options (see HTML documentation).
void IliHTMLReporter::tagBeginStrong (  ) 

Writes the HTML tag for begin strong.

 HTML: <strong>
void IliHTMLReporter::tagBeginTable ( const char *  opt = 0  ) 

Writes the HTML tag for begin table.

 HTML: <table opt>
Parameters:
opt The options (see HTML documentation).
void IliHTMLReporter::tagBeginTableColumn ( const char *  opt = 0  ) 

Writes the HTML tag for begin table column.

 HTML: <td opt>
Parameters:
opt The options (see HTML documentation).
void IliHTMLReporter::tagBeginTableHeader ( const char *  opt = 0  ) 

Writes the HTML tag for begin table header.

 HTML: <th opt>
Parameters:
opt The options (see HTML documentation).
void IliHTMLReporter::tagBeginTableRow ( const char *  opt = 0  ) 

Writes the HTML tag for begin table row.

 HTML: <tr opt>
Parameters:
opt The options (see HTML documentation).
void IliHTMLReporter::tagBeginUnderline (  ) 

Writes the HTML tag for begin underline.

 HTML: <u>
void IliHTMLReporter::tagDefineLocation ( const char *  loc,
const char *  text 
)

Writes the HTML tag to define a location.

 HTML: <a name="location">text</a>
Parameters:
loc The location.
text The text.
void IliHTMLReporter::tagEndBody (  ) 

Writes the HTML tag for end body.

 HTML: </body>
void IliHTMLReporter::tagEndBold (  ) 

Writes the HTML tag for end bold.

 HTML: </b>
void IliHTMLReporter::tagEndCenter (  ) 

Writes the HTML tag for end center.

 HTML: </center>
void IliHTMLReporter::tagEndCodeListing (  ) 

Writes the HTML tag for end code listing.

 HTML: &lt;/pre&gt;
void IliHTMLReporter::tagEndFont (  ) 

Writes the HTML tag for end font.

 HTML: </font>
void IliHTMLReporter::tagEndHead (  ) 

Writes the HTML tag for end head.

 HTML: </head>
void IliHTMLReporter::tagEndHeader ( IlInt  = 2  ) 

Writes the HTML tag to end headers.

The most prominent header has the size set to 1 and the least prominent header has the size set to 6.

 HTML: </h<size>>
Parameters:
size The size (from 1 to 6).
void IliHTMLReporter::tagEndHtml (  ) 

Writes the HTML tag for end HTML document.

 HTML: </html>
void IliHTMLReporter::tagEndItalic (  ) 

Writes the HTML tag for end italic.

 HTML: </i>
void IliHTMLReporter::tagEndList (  ) 

Writes the HTML tag for end list.

 HTML: </ul>
void IliHTMLReporter::tagEndListItem (  ) 

Writes the HTML tag for end list item.

 HTML: </li>
void IliHTMLReporter::tagEndListOrdered (  ) 

Writes the HTML tag for end ordered list.

 HTML: </ol>
void IliHTMLReporter::tagEndStrong (  ) 

Writes the HTML tag for end strong.

 HTML: </strong>
void IliHTMLReporter::tagEndTable (  ) 

Writes the HTML tag for end table.

 HTML: </table>
void IliHTMLReporter::tagEndTableColumn (  ) 

Writes the HTML tag for end table column.

 HTML: </td>
void IliHTMLReporter::tagEndTableHeader (  ) 

Writes the HTML tag for end table header.

 HTML: </th>
void IliHTMLReporter::tagEndTableRow (  ) 

Writes the HTML tag for end table row.

 HTML: </tr>
void IliHTMLReporter::tagEndUnderline (  ) 

Writes the HTML tag for end underline.

 HTML: </u>
void IliHTMLReporter::tagHeadTitle ( const char *  title  ) 

Writes the HTML tag to define the document title.

 HTML: <title>title</title>
Parameters:
title The title.
void IliHTMLReporter::tagLinkToFile ( const char *  file,
const char *  text 
)

Writes the HTML tag to define a link to a file.

 HTML: <a href="file">text</a>
Parameters:
file The file name.
text The text.
void IliHTMLReporter::tagLinkToFileLocation ( const char *  file,
const char *  loc,
const char *  txt 
)

Writes the HTML tag to define a link to a location in a file.

 HTML: <a href="file#location">text</a>
Parameters:
file The file name.
loc The location.
txt The text.
void IliHTMLReporter::tagLinkToLocation ( const char *  link,
const char *  text 
)

Writes the HTML tag to define a link to a location.

 HTML: <a href="#location">text</a>
Parameters:
link The link.
text The text.
void IliHTMLReporter::tagNewLine ( IlInt  count = 1  ) 

Writes several times the HTML tag new line.

 HTML: <br>
Parameters:
count The number of times.
void IliHTMLReporter::tagParagraph (  ) 

Writes the HTML tag new paragraph.

 HTML: <p>
void IliHTMLReporter::tagPicture ( const char *  filename,
const char *  opt = 0 
)

Writes the HTML tag to insert a picture.

 HTML: <img src="filename">
Parameters:
filename The file name.
opt The options (see HTML documentation).
void IliHTMLReporter::tagSpace (  ) 

Writes the HTML tag for a space.

 HTML:&nbsp;
void IliHTMLReporter::tagText ( const char *  text  ) 

Writes text or HTML tags or both.

Parameters:
text The text.
void IliHTMLReporter::tagTradeMark (  ) 

Writes the HTML tag for Trade Mark.

 HTML:&#174;

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.