Fawkes API  Fawkes Development Version
page_header_generator.cpp
1 
2 /***************************************************************************
3  * header_generator.cpp - Generator of page header
4  *
5  * Created: Sun Aug 30 14:40:26 2009
6  * Copyright 2006-2009 Tim Niemueller [www.niemueller.de]
7  *
8  ****************************************************************************/
9 
10 /* This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Library General Public License for more details.
19  *
20  * Read the full text in the LICENSE.GPL file in the doc directory.
21  */
22 
23 #include <webview/page_header_generator.h>
24 
25 namespace fawkes {
26 
27 /** @class WebPageHeaderGenerator <webview/page_header_generator.h>
28  * Interface for HTML header generator.
29  * A page header generator has the task to generate the HTML code that is
30  * prepended to each standard page. This is a possible header or navigational
31  * additions. A header generator must also generate the opening "&lt;html&gt;"
32  * tags, the &lt;head&gt; section, and the opening &lt;body&gt; tag.
33  * @author Tim Niemueller
34  *
35  * @fn std::string WebPageHeaderGenerator::html_header(std::string &title, std::string &active_baseurl, std::string &html_header) = 0
36  * Generate HTML header.
37  * @param title HTML title, must be put in &lt;title&gt; tag in &lt;head&gt;
38  * section
39  * @param active_baseurl the baseurl currently active processor (this is the
40  * baseurl a processor is registered for). This can be used for example to
41  * highlight the current section in the navigation.
42  * @param html_header custom HTML code to place in the head element of the page.
43  * @return header HTML code
44  */
45 
46 WebPageHeaderGenerator::~WebPageHeaderGenerator()
47 {
48 }
49 
50 } // end namespace fawkes
fawkes
Fawkes library namespace.