Fawkes API  Fawkes Development Version
fawkes::WebPageHeaderGenerator Class Referenceabstract

Interface for HTML header generator. More...

#include <>>

Inheritance diagram for fawkes::WebPageHeaderGenerator:

Public Member Functions

virtual std::string html_header (std::string &title, std::string &active_baseurl, std::string &html_header)=0
 Generate HTML header. More...
 

Detailed Description

Interface for HTML header generator.

A page header generator has the task to generate the HTML code that is prepended to each standard page. This is a possible header or navigational additions. A header generator must also generate the opening "&lt;html&gt;" tags, the <head> section, and the opening <body> tag.

Author
Tim Niemueller

Definition at line 33 of file page_header_generator.h.

Member Function Documentation

◆ html_header()

std::string fawkes::WebPageHeaderGenerator::html_header ( std::string &  title,
std::string &  active_baseurl,
std::string &  html_header 
)
pure virtual

Generate HTML header.

Parameters
titleHTML title, must be put in <title> tag in <head> section
active_baseurlthe baseurl currently active processor (this is the baseurl a processor is registered for). This can be used for example to highlight the current section in the navigation.
html_headercustom HTML code to place in the head element of the page.
Returns
header HTML code

Implemented in WebviewHeaderGenerator.

Referenced by fawkes::WebPageReply::pack().


The documentation for this class was generated from the following files: