Bpp/Text_format
Html
C++
 
 
DESCRIPTION
 

This module provides facilities to generate text documents in the HTML format.

 
SOURCE FILES
 

This section allows you to access the C++ source files of the module.

 
PARENT MODULE
 

This module is part of Bpp/Text_format.

 
INCLUDED FILES
 

The files listed below are included in the interface part of the module. So any module dependent of this module is also dependent of the files listed here.

  • <bpp/standard.hpp>

 
NEEDED FILES
 

The files listed below are needed by the implementation part of the module. But a module dependent of this module is not necessary dependent of the files listed here.

  • <bpp/modules.hpp>

 
INTEGRATED NAMESPACES
 

The namespaces listed below are integrated in this module. That means any element declared in one of those namespaces can now be directly used by or from this module.

  • standard

 
ERRORS
 

Here are listed the errors that are supported or generated by the module. To use one of them, you do not have to specify the namespace of the module.

  • erDefaultHtmlTemplateParameterMissing
    The default_html_template parameter is missing in the initialization file.

  • erHtmlFileClosed
    The file is closed.

  • erHtmlFormat
    The format is not correct.

  • erNoMoreHole
    There is no more hole in the HTML format.

 
CONSTANTS
 

Here are listed the constants provided by the module. To use one of them, you have to specify the namespace of the module.

  • tyCharacter holeSymbol()
    Symbol that represents a hole in an HTML format string.

 
VARIABLES
 

Here are listed the variables managed by the module. To use one of them, you have to specify the namespace of the module.

  • clHtmlTemplate defaultHtmlTemplate()
    Default template of HTML document.

 
FUNCTIONS
 

Here are listed the functions provided by the module. To use one of them, you have to specify the namespace of the module.

 
CLASSES
 

Here are listed the classes provided by the module. To use one of them, you have to specify the namespace of the module.

 
clHtmlFile
 
 
Declaration

class clHtmlFile

 
Description

Represents an input file in which HTML code will be written.

 
Methods
 
clHtmlTemplate
 
 
Declaration

class clHtmlTemplate

 
Description

Represents a template of HTML document.

 
Attributes
  • clString normalPage()
    Format of a normal page. Reading and writing access.

  • clString menuPage()
    Format of a menu page. Reading and writing access.

  • clString framePage()
    Format of a framed page. Reading and writing access.

  • clString codePage()
    Format of a page for the display of source code. Reading and writing access.

  • clString frame()
    Format of a frame. Reading and writing access.

  • clString homeFrameName()
    Name of the home frame (frame that contains the framed page). Reading and writing access.

  • clString mainFrameName()
    Name of the main frame (main frame of the framed page). Reading and writing access.

  • clString title1()
    Format 1 of a title (the biggest). Reading and writing access.

  • clString title2()
    Format 2 of a title. Reading and writing access.

  • clString title3()
    Format 3 of a title. Reading and writing access.

  • clString title4()
    Format 4 of a title (the smallest). Reading and writing access.

  • clString paragraph()
    Format of a paragraph. Reading access only.

  • clString indentation()
    Format of an indentation. Reading access only.

  • clString copyright()
    Format and content of the copyright. Reading and writing access.

  • clString bullet()
    Format of a bullet. Reading and writing access.

  • clString image()
    Format of an image. Reading and writing access.

  • clString table()
    Format of a table. Reading and writing access.

  • clString row()
    Format of a row of a table. Reading access only.

  • clString cell()
    Format of a cell of a row. Reading access only.

  • clString greaterSymbol()
    HTML code for the symbol >. Reading access only.

  • clString lesserSymbol()
    HTML code for the symbol <. Reading access only.

  • clString quotesSymbol()
    HTML code for the symbol ". Reading access only.

  • clString breakLine()
    HTML code for a break line. Reading access only.

  • clString emptySymbol()
    HTML code for the empty symbol. Reading access only.

  • clString orderedList()
    Format of an ordered list. Reading and writing access.

  • clString unorderedList()
    Format of an unordered list. Reading and writing access.

  • clString listItem()
    Format of a list item. Reading and writing access.

  • clString link()
    Format of a link. Reading and writing access.

  • clString bookmark()
    Format of a bookmark. Reading and writing access.

  • clString fontSize()
    Format for font size. Reading and writing access.

  • clString big()
    Format for big text. Reading and writing access.

  • clString bold()
    Format for bold text. Reading and writing access.

  • clString center()
    Format of a center alignment. Reading and writing access.

  • clString code()
    Format for code text. Reading and writing access.

  • clString italic()
    Format for italic text. Reading and writing access.

  • clString sansSerif()
    Format for sans-serif text. Reading and writing access.

  • clString serif()
    Format for serif text. Reading and writing access.

  • clString cite()
    Format for cite text. Reading and writing access.

  • clString little()
    Format for small text. Reading and writing access.

  • clString remark()
    Format of a remark. Reading and writing access.

  • clString horizontalSpace()
    Format of an horizontal space. Reading and writing access.

  • tyCardinal characterWidth()
    Width of a code character. Reading and writing access.

  • clString separatorTableTable()
    HTML code to separate a table from another one. Reading and writing access.

  • clString separatorTableText()
    HTML code to separate a table from text. Reading and writing access.

  • clString separatorTableTitle()
    HTML code to separate a table from a title 2 to 4. Reading and writing access.

  • clString separatorTableTitle1()
    HTML code to separate a table from a title 1. Reading and writing access.

  • clString separatorTextTable()
    HTML code to separate text from a table. Reading and writing access.

  • clString separatorTextText()
    HTML code to separate text from text. Reading and writing access.

  • clString separatorTextTitle()
    HTML code to separate text from a title 2 to 4. Reading and writing access.

  • clString separatorTextTitle1()
    HTML code to separate text from a title 1. Reading and writing access.

  • clString separatorTitleTable()
    HTML code to separate a title 2 to 4 from a table. Reading and writing access.

  • clString separatorTitleText()
    HTML code to separate a title 2 to 4 from a table. Reading and writing access.

  • clString separatorTitleTitle()
    HTML code to separate a title 2 to 4 from another one. Reading and writing access.

  • clString separatorTitleTitle1()
    HTML code to separate a title 2 to 4 from a title 1. Reading and writing access.

  • clString separatorTitle1Table()
    HTML code to separate a title 1 from a table. Reading and writing access.

  • clString separatorTitle1Text()
    HTML code to separate a title 1 from text. Reading and writing access.

  • clString separatorTitle1Title()
    HTML code to separate a title 1 from a title 2 to 4. Reading and writing access.

  • clString separatorTitle1Title1()
    HTML code to separate a title 1 from another one. Reading and writing access.

 
Methods
 
 
Copyright (c) 1999-2016 - Bruno Bachelet - bruno@nawouak.net - http://www.nawouak.net
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. See this license for more details (http://www.gnu.org).