Fawkes API Fawkes Development Version

page_header_generator.cpp

00001 
00002 /***************************************************************************
00003  *  header_generator.cpp - Generator of page header
00004  *
00005  *  Created: Sun Aug 30 14:40:26 2009
00006  *  Copyright  2006-2009  Tim Niemueller [www.niemueller.de]
00007  *
00008  ****************************************************************************/
00009 
00010 /*  This program is free software; you can redistribute it and/or modify
00011  *  it under the terms of the GNU General Public License as published by
00012  *  the Free Software Foundation; either version 2 of the License, or
00013  *  (at your option) any later version.
00014  *
00015  *  This program is distributed in the hope that it will be useful,
00016  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00017  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00018  *  GNU Library General Public License for more details.
00019  *
00020  *  Read the full text in the LICENSE.GPL file in the doc directory.
00021  */
00022 
00023 #include <webview/page_header_generator.h>
00024 
00025 namespace fawkes {
00026 #if 0 /* just to make Emacs auto-indent happy */
00027 }
00028 #endif
00029 
00030 /** @class WebPageHeaderGenerator <webview/page_header_generator.h>
00031  * Interface for HTML header generator.
00032  * A page header generator has the task to generate the HTML code that is
00033  * prepended to each standard page. This is a possible header or navigational
00034  * additions. A header generator must also generate the opening "&lt;html&gt;"
00035  * tags, the &lt;head&gt; section, and the opening &lt;body&gt; tag.
00036  * @author Tim Niemueller
00037  *
00038  * @fn std::string WebPageHeaderGenerator::html_header(std::string &title, std::string &active_baseurl) = 0
00039  * Generate HTML header.
00040  * @param title HTML title, must be put in &lt;title&gt; tag in &lt;head&gt;
00041  * section
00042  * @param active_baseurl the baseurl currently active processor (this is the
00043  * baseurl a processor is registered for). This can be used for example to
00044  * highlight the current section in the navigation.
00045  * @return header HTML code
00046  */
00047 
00048 WebPageHeaderGenerator::~WebPageHeaderGenerator()
00049 {
00050 }
00051 
00052 } // end namespace fawkes
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends